OpenRTM-aist 2.1.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
RTC::ConnectorListenersBase Class Referenceabstract

#include <ConnectorListener.h>

Inheritance diagram for RTC::ConnectorListenersBase:
Inheritance graph
[legend]

Public Member Functions

virtual ~ConnectorListenersBase ()
 Destructor .
 
virtual ::RTC::ConnectorListenerStatus::Enum notifyIn (ConnectorDataListenerType type, ConnectorInfo &info, ByteData &data)=0
 Notify listeners. (Typed data version)
 
virtual ::RTC::ConnectorListenerStatus::Enum notifyOut (ConnectorDataListenerType type, ConnectorInfo &info, ByteData &data)=0
 Notify listeners. (Typed data version)
 
virtual ::RTC::ConnectorListenerStatus::Enum notify (ConnectorListenerType type, ConnectorInfo &info)=0
 Virtual Callback method.
 
virtual bool addListener (ConnectorDataListenerType type, ConnectorDataListener *listener, bool autoclean=true)=0
 Add the listener.
 
virtual bool addListener (ConnectorListenerType type, ConnectorListener *listener, bool autoclean=true)=0
 Add the listener.
 
virtual bool removeListener (ConnectorDataListenerType type, ConnectorDataListener *listener)=0
 Remove the listener.
 
virtual bool removeListener (ConnectorListenerType type, ConnectorListener *listener)=0
 Remove the listener.
 
virtual ConnectorDataListenerHoldergetDataListenerHolder (ConnectorDataListenerType type)=0
 Remove the listener.
 
template<class DataType >
::RTC::ConnectorListenerStatus::Enum notifyIn (ConnectorDataListenerType type, ConnectorInfo &info, DataType &data)
 Notify listeners. (Typed data version)
 
template<class DataType >
::RTC::ConnectorListenerStatus::Enum notifyOut (ConnectorDataListenerType type, ConnectorInfo &info, DataType &data)
 Notify listeners. (Typed data version)
 

Constructor & Destructor Documentation

◆ ~ConnectorListenersBase()

virtual RTC::ConnectorListenersBase::~ConnectorListenersBase ( )
virtual

Destructor .

Member Function Documentation

◆ addListener() [1/2]

virtual bool RTC::ConnectorListenersBase::addListener ( ConnectorDataListenerType  type,
ConnectorDataListener listener,
bool  autoclean = true 
)
pure virtual

Add the listener.

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

Implemented in RTC::ConnectorListeners, and RTC::ConnectorListenersT< DataType >.

◆ addListener() [2/2]

virtual bool RTC::ConnectorListenersBase::addListener ( ConnectorListenerType  type,
ConnectorListener listener,
bool  autoclean = true 
)
pure virtual

Add the listener.

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

Implemented in RTC::ConnectorListeners, and RTC::ConnectorListenersT< DataType >.

◆ getDataListenerHolder()

virtual ConnectorDataListenerHolder * RTC::ConnectorListenersBase::getDataListenerHolder ( ConnectorDataListenerType  type)
pure virtual

Remove the listener.

Parameters
type
listener
Returns

Implemented in RTC::ConnectorListeners, and RTC::ConnectorListenersT< DataType >.

Referenced by notifyIn(), and notifyOut().

◆ notify()

virtual ::RTC::ConnectorListenerStatus::Enum RTC::ConnectorListenersBase::notify ( ConnectorListenerType  type,
ConnectorInfo info 
)
pure virtual

◆ notifyIn() [1/2]

virtual ::RTC::ConnectorListenerStatus::Enum RTC::ConnectorListenersBase::notifyIn ( ConnectorDataListenerType  type,
ConnectorInfo info,
ByteData data 
)
pure virtual

Notify listeners. (Typed data version)

Parameters
type
infoConnectorInfo
dataData
Returns

Implemented in RTC::ConnectorListeners, and RTC::ConnectorListenersT< DataType >.

Referenced by RTC::InPortConnector::getDirectData(), RTC::InPortPushConnector::onBufferRead(), and RTC::OutPortConnector::write().

◆ notifyIn() [2/2]

template<class DataType >
::RTC::ConnectorListenerStatus::Enum RTC::ConnectorListenersBase::notifyIn ( ConnectorDataListenerType  type,
ConnectorInfo info,
DataType &  data 
)
inline

Notify listeners. (Typed data version)

Parameters
type
infoConnectorInfo
dataData
Returns

References getDataListenerHolder(), RTC::ConnectorListenerStatus::NO_CHANGE, and RTC::ConnectorDataListenerHolder::notifyIn().

◆ notifyOut() [1/2]

virtual ::RTC::ConnectorListenerStatus::Enum RTC::ConnectorListenersBase::notifyOut ( ConnectorDataListenerType  type,
ConnectorInfo info,
ByteData data 
)
pure virtual

◆ notifyOut() [2/2]

template<class DataType >
::RTC::ConnectorListenerStatus::Enum RTC::ConnectorListenersBase::notifyOut ( ConnectorDataListenerType  type,
ConnectorInfo info,
DataType &  data 
)
inline

Notify listeners. (Typed data version)

Parameters
type
infoConnectorInfo
dataData
Returns

References getDataListenerHolder(), RTC::ConnectorListenerStatus::NO_CHANGE, and RTC::ConnectorDataListenerHolder::notifyOut().

◆ removeListener() [1/2]

virtual bool RTC::ConnectorListenersBase::removeListener ( ConnectorDataListenerType  type,
ConnectorDataListener listener 
)
pure virtual

Remove the listener.

Parameters
type
listener
Returns

Implemented in RTC::ConnectorListeners, and RTC::ConnectorListenersT< DataType >.

◆ removeListener() [2/2]

virtual bool RTC::ConnectorListenersBase::removeListener ( ConnectorListenerType  type,
ConnectorListener listener 
)
pure virtual

Remove the listener.

Parameters
type
listener
Returns

Implemented in RTC::ConnectorListeners, and RTC::ConnectorListenersT< DataType >.


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