IoTivity C++ SDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OIC::Service::SceneList Class Reference

SceneList class is an interface class to manage SceneList resource. More...

Public Member Functions

SceneCollection::Ptr addNewSceneCollection ()
 Adds new SceneCollection instance. More...
 
std::vector< SceneCollection::PtrgetSceneCollections () const
 Gets all SceneCollection instances stored in SceneList resource. More...
 
void setName (const std::string &sceneListName)
 Sets a name attribute of SceneList resource. More...
 
std::string getName () const
 Gets a name attribute of SceneList resource. More...
 

Static Public Member Functions

static SceneListgetInstance ()
 Gets static instance of SceneList. More...
 

Detailed Description

SceneList class is an interface class to manage SceneList resource.

This class provides APIs for creating a new SceneCollection instance and retrieving the existing instances as well as for setting/getting a name attribute of SceneList resource.

Member Function Documentation

SceneCollection::Ptr OIC::Service::SceneList::addNewSceneCollection ( )

Adds new SceneCollection instance.

Returns
A shared pointer of SceneCollection instance
Note
SceneCollection instance is only produced by SceneList class
static SceneList* OIC::Service::SceneList::getInstance ( )
static

Gets static instance of SceneList.

Returns
SceneList instance
std::string OIC::Service::SceneList::getName ( ) const

Gets a name attribute of SceneList resource.

Returns
A SceneList resource's name
std::vector<SceneCollection::Ptr> OIC::Service::SceneList::getSceneCollections ( ) const

Gets all SceneCollection instances stored in SceneList resource.

Returns
A vector of shared pointers of SceneCollection instances
Note
SceneCollection instance that addNewSceneCollection returns is not same instance that getSceneCollections returns
void OIC::Service::SceneList::setName ( const std::string &  sceneListName)

Sets a name attribute of SceneList resource.

Parameters
sceneListNameA SceneList resource's name

The documentation for this class was generated from the following file: