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

This class describes a resource representation. More...

Public Member Functions

 RCSRepresentation ()
 
 RCSRepresentation (const std::string &uri)
 
 RCSRepresentation (const RCSResourceAttributes &attrs)
 
 RCSRepresentation (const std::string &uri, const std::vector< std::string > &interfaces, const std::vector< std::string > &resourceTypes)
 
 RCSRepresentation (const std::string &uri, const std::vector< std::string > &interfaces, const std::vector< std::string > &resourceTypes, const RCSResourceAttributes &attrs)
 
std::string getUri () const
 Returns the uri. More...
 
void setUri (std::string uri)
 Sets the uri of this representation. More...
 
const std::vector< std::string > & getInterfaces () const
 Returns all interfaces added. More...
 
void addInterface (std::string interface)
 Adds an interface. More...
 
void clearInterfaces ()
 Removes all interfaces added. More...
 
const std::vector< std::string > & getResourceTypes () const
 Returns all resource types added. More...
 
void addResourceType (std::string resourceType)
 Adds a resource type. More...
 
void clearResourceTypes ()
 Removes all resource types. More...
 
const RCSResourceAttributesgetAttributes () const
 Returns attributes set in this representation. More...
 
RCSResourceAttributesgetAttributes ()
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
void setAttributes (const RCSResourceAttributes &attrs)
 Overwrite attributes. More...
 
void setAttributes (RCSResourceAttributes &&attrs)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
const std::vector
< RCSRepresentation > & 
getChildren () const
 Returns children of this representation. More...
 
void addChild (RCSRepresentation child)
 Adds a child to this representation. More...
 
void setChildren (std::vector< RCSRepresentation > children)
 Sets children of this representation. More...
 
void clearChildren ()
 Removse all children. More...
 

Static Public Member Functions

static RCSRepresentation fromOCRepresentation (const OC::OCRepresentation &)
 Converts OCRepresentation into RCSRepresentation. More...
 
static OC::OCRepresentation toOCRepresentation (const RCSRepresentation &)
 Converts RCSRepresentation into OCRepresentation. More...
 
static OC::OCRepresentation toOCRepresentation (RCSRepresentation &&)
 

Detailed Description

This class describes a resource representation.

See Also
RCSResourceObject
RCRemoteResourceObject

Constructor & Destructor Documentation

OIC::Service::RCSRepresentation::RCSRepresentation ( )
OIC::Service::RCSRepresentation::RCSRepresentation ( const std::string &  uri)
explicit
OIC::Service::RCSRepresentation::RCSRepresentation ( const RCSResourceAttributes attrs)
explicit
OIC::Service::RCSRepresentation::RCSRepresentation ( const std::string &  uri,
const std::vector< std::string > &  interfaces,
const std::vector< std::string > &  resourceTypes 
)
OIC::Service::RCSRepresentation::RCSRepresentation ( const std::string &  uri,
const std::vector< std::string > &  interfaces,
const std::vector< std::string > &  resourceTypes,
const RCSResourceAttributes attrs 
)

Member Function Documentation

void OIC::Service::RCSRepresentation::addChild ( RCSRepresentation  child)

Adds a child to this representation.

Parameters
childa representation to be attached
void OIC::Service::RCSRepresentation::addInterface ( std::string  interface)

Adds an interface.

Parameters
interfacean interface to add
void OIC::Service::RCSRepresentation::addResourceType ( std::string  resourceType)

Adds a resource type.

void OIC::Service::RCSRepresentation::clearChildren ( )

Removse all children.

void OIC::Service::RCSRepresentation::clearInterfaces ( )

Removes all interfaces added.

void OIC::Service::RCSRepresentation::clearResourceTypes ( )

Removes all resource types.

static RCSRepresentation OIC::Service::RCSRepresentation::fromOCRepresentation ( const OC::OCRepresentation )
static

Converts OCRepresentation into RCSRepresentation.

See Also
toOCRepresentation
const RCSResourceAttributes& OIC::Service::RCSRepresentation::getAttributes ( ) const

Returns attributes set in this representation.

RCSResourceAttributes& OIC::Service::RCSRepresentation::getAttributes ( )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const std::vector< RCSRepresentation >& OIC::Service::RCSRepresentation::getChildren ( ) const

Returns children of this representation.

const std::vector< std::string >& OIC::Service::RCSRepresentation::getInterfaces ( ) const

Returns all interfaces added.

const std::vector< std::string >& OIC::Service::RCSRepresentation::getResourceTypes ( ) const

Returns all resource types added.

std::string OIC::Service::RCSRepresentation::getUri ( ) const

Returns the uri.

void OIC::Service::RCSRepresentation::setAttributes ( const RCSResourceAttributes attrs)

Overwrite attributes.

Parameters
attrsnew attributes.
void OIC::Service::RCSRepresentation::setAttributes ( RCSResourceAttributes &&  attrs)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void OIC::Service::RCSRepresentation::setChildren ( std::vector< RCSRepresentation children)

Sets children of this representation.

Parameters
childrennew children
void OIC::Service::RCSRepresentation::setUri ( std::string  uri)

Sets the uri of this representation.

static OC::OCRepresentation OIC::Service::RCSRepresentation::toOCRepresentation ( const RCSRepresentation )
static

Converts RCSRepresentation into OCRepresentation.

See Also
fromOCRepresentation
static OC::OCRepresentation OIC::Service::RCSRepresentation::toOCRepresentation ( RCSRepresentation &&  )
static

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