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

SceneAction class indicates a unit of actions when a scene is executed. More...

Public Types

typedef std::shared_ptr
< SceneAction
Ptr
 

Public Member Functions

void resetExecutionParameter (const std::string &key, RCSResourceAttributes::Value value)
 Sets the SceneAction parameters like a target attribute key and its value It replaces existing execution parameter. More...
 
void resetExecutionParameter (const RCSResourceAttributes &attr)
 Sets the SceneAction parameters like a target attribute key and its value It replaces existing execution parameter. More...
 
RCSResourceAttributes getExecutionParameter () const
 Gets execution parameter of the SceneAction instance. More...
 
RCSRemoteResourceObject::Ptr getRemoteResourceObject () const
 Gets remote resource object. More...
 

Friends

class Scene
 

Detailed Description

SceneAction class indicates a unit of actions when a scene is executed.

SceneAction instance is initialized with 3 essential parameters: a target resource, target attribute key, and its target value. And this class also provide APIs to update a target attribute information if one wants

Member Typedef Documentation

typedef std::shared_ptr< SceneAction > OIC::Service::SceneAction::Ptr

Member Function Documentation

RCSResourceAttributes OIC::Service::SceneAction::getExecutionParameter ( ) const

Gets execution parameter of the SceneAction instance.

Returns
attributes of SceneMember resource
See Also
RCSResourceAttributes
RCSRemoteResourceObject::Ptr OIC::Service::SceneAction::getRemoteResourceObject ( ) const

Gets remote resource object.

Returns
RCSRemoteResourceObject
void OIC::Service::SceneAction::resetExecutionParameter ( const std::string &  key,
RCSResourceAttributes::Value  value 
)

Sets the SceneAction parameters like a target attribute key and its value It replaces existing execution parameter.

Parameters
keyA key of attributes
valueA value to be mapped against the key
See Also
RCSResourceAttributes
void OIC::Service::SceneAction::resetExecutionParameter ( const RCSResourceAttributes attr)

Sets the SceneAction parameters like a target attribute key and its value It replaces existing execution parameter.

Parameters
attrAttributes to set
See Also
RCSResourceAttributes

Friends And Related Function Documentation

friend class Scene
friend

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