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

This class provides a set of APIs for Notification service Topics Linked list. More...

Public Member Functions

 NSTopicsList ()
 Constructor of NSTopicsList. More...
 
 NSTopicsList (::NSTopicLL *topics, bool modify)
 Constructor of NSTopicsList. More...
 
 NSTopicsList (const NSTopicsList &topicsList)
 Copy Constructor of NSTopicsList. More...
 
NSTopicsListoperator= (const NSTopicsList &topicsList)
 Copy assignment operator of NSTopicsList. More...
 
 ~NSTopicsList ()
 Destructor of NSTopicsList. More...
 
void addTopic (const std::string &topicName, NSTopic::NSTopicState state)
 This method is for adding topic for the Notification service Topics Linked list. More...
 
void removeTopic (const std::string &topicName)
 This method is for removing topic from the Notification service Topics Linked list. More...
 
std::list< NSTopicgetTopicsList () const
 This method is for getting topic LL from the Notification service Topics Linked list. More...
 
void unsetModifiability ()
 This method is for preventing for add/remove Topic from Topicslist. More...
 

Detailed Description

This class provides a set of APIs for Notification service Topics Linked list.

Constructor & Destructor Documentation

OIC::Service::NSTopicsList::NSTopicsList ( )
inline

Constructor of NSTopicsList.

OIC::Service::NSTopicsList::NSTopicsList ( ::NSTopicLL topics,
bool  modify 
)

Constructor of NSTopicsList.

Parameters
topicspointer to NSTopicLL struct to initialize.
modifyindicate if the list is modifiable
OIC::Service::NSTopicsList::NSTopicsList ( const NSTopicsList topicsList)

Copy Constructor of NSTopicsList.

Parameters
topicsList- NSTopicsList to initialize.
OIC::Service::NSTopicsList::~NSTopicsList ( )

Destructor of NSTopicsList.

Member Function Documentation

void OIC::Service::NSTopicsList::addTopic ( const std::string &  topicName,
NSTopic::NSTopicState  state 
)

This method is for adding topic for the Notification service Topics Linked list.

Parameters
topicNameas string.
state- as NSTopicState.
std::list<NSTopic> OIC::Service::NSTopicsList::getTopicsList ( ) const

This method is for getting topic LL from the Notification service Topics Linked list.

Returns
topic as NSTopics Linked list.
NSTopicsList& OIC::Service::NSTopicsList::operator= ( const NSTopicsList topicsList)

Copy assignment operator of NSTopicsList.

Parameters
topicsList- NSTopicsList to initialize.
Returns
NSTopicsList object reference
void OIC::Service::NSTopicsList::removeTopic ( const std::string &  topicName)

This method is for removing topic from the Notification service Topics Linked list.

Parameters
topicNameas string.
void OIC::Service::NSTopicsList::unsetModifiability ( )

This method is for preventing for add/remove Topic from Topicslist.

Below method restricts the application from illegally modifying Topics when Provider is in Invalid state. By calling the API, the service prevents and protects the integrity of TopicsList updation when the associated object is Invalid.


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