OpenRTM-aist  1.2.0
Public Member Functions | Public Attributes | List of all members
RTC::ConnectorDataListenerHolder Class Reference

ConnectorDataListener holder class. More...

#include <ConnectorListener.h>

Inheritance diagram for RTC::ConnectorDataListenerHolder:
Inheritance graph
[legend]
Collaboration diagram for RTC::ConnectorDataListenerHolder:
Collaboration graph
[legend]

Public Member Functions

 ConnectorDataListenerHolder ()
 Constructor. More...
 
virtual ~ConnectorDataListenerHolder ()
 Destructor. More...
 
void addListener (ConnectorDataListener *listener, bool autoclean)
 Add the listener. More...
 
void removeListener (ConnectorDataListener *listener)
 Remove the listener. More...
 
size_t size ()
 Getting number of listeners. More...
 
ReturnCode notify (ConnectorInfo &info, cdrMemoryStream &cdrdata)
 Notify listeners. More...
 
template<class DataType >
ReturnCode notify (ConnectorInfo &info, DataType &typeddata)
 Notify listeners. (Typed data version) More...
 

Public Attributes

 USE_CONNLISTENER_STATUS
 

Additional Inherited Members

- Public Types inherited from RTC::ConnectorListenerStatus
enum  Enum { NO_CHANGE = 0, INFO_CHANGED = 1 << 0, DATA_CHANGED = 1 << 1, BOTH_CHANGED = INFO_CHANGED | DATA_CHANGED }
 

Detailed Description

ConnectorDataListener holder class.

This class manages one ore more instances of ConnectorDataListener class.

Constructor & Destructor Documentation

◆ ConnectorDataListenerHolder()

RTC::ConnectorDataListenerHolder::ConnectorDataListenerHolder ( )

Constructor.

◆ ~ConnectorDataListenerHolder()

virtual RTC::ConnectorDataListenerHolder::~ConnectorDataListenerHolder ( )
virtual

Destructor.

Member Function Documentation

◆ addListener()

void RTC::ConnectorDataListenerHolder::addListener ( ConnectorDataListener *  listener,
bool  autoclean 
)

Add the listener.

This method adds the listener.

Parameters
listenerAdded listener
autocleantrue:The listener is deleted at the destructor., false:The listener is not deleted at the destructor.

◆ notify() [1/2]

ReturnCode RTC::ConnectorDataListenerHolder::notify ( ConnectorInfo &  info,
cdrMemoryStream &  cdrdata 
)

Notify listeners.

This calls the Callback method of the registered listener.

Parameters
infoConnectorInfo
cdrdataData

Referenced by RTC::InPortConnector::getDirectData().

◆ notify() [2/2]

template<class DataType >
ReturnCode RTC::ConnectorDataListenerHolder::notify ( ConnectorInfo &  info,
DataType &  typeddata 
)
inline

Notify listeners. (Typed data version)

This calls the Callback method of the registered listener. This operation calls only ConnectorDataListenerT type callback.

Parameters
infoConnectorInfo
typeddataData

References RTC::ConnectorListenerStatus::NO_CHANGE.

◆ removeListener()

void RTC::ConnectorDataListenerHolder::removeListener ( ConnectorDataListener *  listener)

Remove the listener.

This method removes the listener.

Parameters
listenerRemoved listener

◆ size()

size_t RTC::ConnectorDataListenerHolder::size ( )

Getting number of listeners.

This method returns current number of listenrs.

Returns
number of listeners

Member Data Documentation

◆ USE_CONNLISTENER_STATUS

RTC::ConnectorDataListenerHolder::USE_CONNLISTENER_STATUS

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