#include <EventPort.h>

Inheritance diagram for RTC::EventInPort< FsmType >:

[legend]

Collaboration diagram for RTC::EventInPort< FsmType >:

[legend]

Public Member Functions
	EventInPort (const char *name, FsmType &fsm)
	A constructor.

	~EventInPort () override
	Destructor.

virtual const char *	name ()
	Get port name.

void	init (coil::Properties &prop) override
	Initializing properties.

template<class TOP , class R , class P0 >
void	bindEvent (const char name, R(TOP::handler)(P0))

template<typename TOP , class R >
void	bindEvent (const char name, R(TOP::handler)())

bool	read (std::string="") override
	It is a virtual method that is called from RTObject_impl::readAll(). This method reads out data from DataPort.

Public Member Functions inherited from RTC::InPortBase
	InPortBase (const char name, const char data_type)
	Constructor.

	~InPortBase () override
	Destructor.

coil::Properties &	properties ()
	Get properties.

const std::vector< InPortConnector * > &	connectors ()
	Connector list.

ConnectorInfoList	getConnectorProfiles ()
	ConnectorProfile list.

coil::vstring	getConnectorIds ()
	ConnectorId list.

coil::vstring	getConnectorNames ()
	Connector name list.

InPortConnector *	getConnectorById (const char *id)
	Getting ConnectorProfile by ID.

InPortConnector *	getConnectorByName (const char *name)
	Getting Connector by name.

bool	getConnectorProfileById (const char *id, ConnectorInfo &prof)
	Getting ConnectorProfile by name.

bool	getConnectorProfileByName (const char *name, ConnectorInfo &prof)
	Getting ConnectorProfile by name.

void	activateInterfaces () override
	Activate all Port interfaces.

void	deactivateInterfaces () override
	Deactivate all Port interfaces.

void	addConnectorDataListener (ConnectorDataListenerType type, ConnectorDataListener *listener, bool autoclean=true)
	Adding BufferDataListener type listener.

void	removeConnectorDataListener (ConnectorDataListenerType type, ConnectorDataListener *listener)
	Removing BufferDataListener type listener.

void	addConnectorListener (ConnectorListenerType type, ConnectorListener *listener, bool autoclean=true)
	Adding ConnectorListener type listener.

void	removeConnectorListener (ConnectorListenerType type, ConnectorListener *listener)
	Removing BufferDataListener type listener.

bool	isLittleEndian ()
	return it whether endian setting.

ReturnCode_t	connect (ConnectorProfile &connector_profile) override
	[CORBA interface] Connect the Port

virtual ConnectorListenersBase *	getListeners ()
	Getting listeners holder.

ReturnCode_t	notify_connect (ConnectorProfile &connector_profile) override

Public Member Functions inherited from RTC::PortBase
	PortBase (const char *name="")
	Constructor.

	~PortBase () override
	Destructor.

PortProfile *	get_port_profile () override
	[CORBA interface] Get the PortProfile of the Port

const PortProfile &	getPortProfile () const
	Get the PortProfile of the Port.

ConnectorProfileList *	get_connector_profiles () override
	[CORBA interface] Get the ConnectorProfileList of the Port

ConnectorProfile *	get_connector_profile (const char *connector_id) override
	[CORBA interface] Get the ConnectorProfile

ReturnCode_t	connect (ConnectorProfile &connector_profile) override
	[CORBA interface] Connect the Port

ReturnCode_t	notify_connect (ConnectorProfile &connector_profile) override
	[CORBA interface] Notify the Ports connection

ReturnCode_t	disconnect (const char *connector_id) override
	[CORBA interface] Disconnect the Port

ReturnCode_t	notify_disconnect (const char *connector_id) override
	[CORBA interface] Notify the Ports disconnection

ReturnCode_t	disconnect_all () override
	[CORBA interface] Disconnect the All Ports

void	setName (const char *name)
	Set the name of this Port.

const char *	getName () const
	Get the name of this Port.

const PortProfile &	getProfile () const
	Get the PortProfile of the Port.

void	setPortRef (PortService_ptr port_ref)
	Set the object reference of this Port.

PortService_ptr	getPortRef () const
	Get the object reference of this Port.

void	setOwner (RTObject_ptr owner)
	Set the owner RTObject of the Port.

void	setOnPublishInterfaces (ConnectionCallback *on_publish)
	Setting callback called on publish interfaces.

void	setOnSubscribeInterfaces (ConnectionCallback *on_subscribe)
	Setting callback called on publish interfaces.

void	setOnConnected (ConnectionCallback *on_connected)
	Setting callback called on connection established.

void	setOnUnsubscribeInterfaces (ConnectionCallback *on_unsubscribe)
	Setting callback called on unsubscribe interfaces.

void	setOnDisconnected (ConnectionCallback *on_disconnected)
	Setting callback called on disconnected.

void	setOnConnectionLost (ConnectionCallback *on_connection_lost)
	Setting callback called on connection lost.

void	setPortConnectListenerHolder (PortConnectListeners *portconnListeners)
	Setting PortConnectListener holder.

virtual DirectPortBase *	getDirectPort ()

Additional Inherited Members
Public Types inherited from RTC::InPortBase
using	ConnectorList = std::vector<InPortConnector*>

Protected Member Functions inherited from RTC::InPortBase
ReturnCode_t	publishInterfaces (ConnectorProfile &cprof) override
	Publish interface information.

ReturnCode_t	subscribeInterfaces (const ConnectorProfile &cprof) override
	Subscribe to the interface.

void	unsubscribeInterfaces (const ConnectorProfile &connector_profile) override
	Disconnect the interface connection.

void	initProviders ()
	InPort provider initialization .

void	initConsumers ()
	OutPort consumer initialization .

bool	checkEndian (const coil::Properties &prop, bool &littleEndian)
	Checking endian flag of serializer.

InPortProvider *	createProvider (ConnectorProfile &cprof, coil::Properties &prop)
	InPort provider creation .

OutPortConsumer *	createConsumer (const ConnectorProfile &cprof, coil::Properties &prop)
	InPort provider creation .

InPortConnector *	createConnector (ConnectorProfile &cprof, coil::Properties &prop, InPortProvider *provider)
	InPortPushConnector creation .

InPortConnector *	createConnector (const ConnectorProfile &cprof, coil::Properties &prop, OutPortConsumer *consumer)
	InPortPullConnector creation .

OutPortBase *	getLocalOutPort (const ConnectorInfo &profile)
	Getting local peer OutPort if available .

virtual void	initConnectorListeners ()

Protected Member Functions inherited from RTC::PortBase
virtual ReturnCode_t	connectNext (ConnectorProfile &connector_profile)
	Call notify_connect() of the next Port.

virtual ReturnCode_t	disconnectNext (ConnectorProfile &cprof)
	Call notify_disconnect() of the next Port.

virtual void	setConnectionLimit (int limit_value)
	Set the maximum number of connections.

virtual ReturnCode_t	_publishInterfaces ()
	Publish interface information.

bool	isExistingConnId (const char *id)
	Check whether the given id exists in stored ConnectorProfiles.

ConnectorProfile	findConnProfile (const char *id)
	Find ConnectorProfile with id.

CORBA::Long	findConnProfileIndex (const char *id)
	Find ConnectorProfile with id.

void	updateConnectorProfile (const ConnectorProfile &connector_profile)
	Append or update the ConnectorProfile list.

bool	eraseConnectorProfile (const char *id)
	Delete the ConnectorProfile.

bool	appendInterface (const char instance_name, const char type_name, PortInterfacePolarity pol)
	Append an interface to the PortInterfaceProfile.

bool	deleteInterface (const char *name, PortInterfacePolarity pol)
	Delete the interface registration from the PortInterfaceProfile.

template<class ValueType >
void	addProperty (const char *key, ValueType value)
	Add NameValue data to PortProfile's properties.

void	appendProperty (const char key, const char value)
	Append NameValue data to PortProfile's properties.

void	updateConnectors ()
	Disconnect ports that doesn't exist.

bool	checkPorts (::RTC::PortServiceList &ports)
	Existence of ports.

void	onNotifyConnect (const char *portname, RTC::ConnectorProfile &profile)

void	onNotifyDisconnect (const char *portname, RTC::ConnectorProfile &profile)

void	onUnsubscribeInterfaces (const char *portname, RTC::ConnectorProfile &profile)

void	onPublishInterfaces (const char *portname, RTC::ConnectorProfile &profile, ReturnCode_t ret)

void	onConnectNextport (const char *portname, RTC::ConnectorProfile &profile, ReturnCode_t ret)

void	onSubscribeInterfaces (const char *portname, RTC::ConnectorProfile &profile, ReturnCode_t ret)

void	onConnected (const char *portname, RTC::ConnectorProfile &profile, ReturnCode_t ret)

void	onDisconnectNextport (const char *portname, RTC::ConnectorProfile &profile, ReturnCode_t ret)

void	onDisconnected (const char *portname, RTC::ConnectorProfile &profile, ReturnCode_t ret)

bool	isExistingMarshalingType (coil::Properties &con_prop)
	Whether the specified serializer can be used.

Static Protected Member Functions inherited from RTC::PortBase
static bool	isEmptyId (const ConnectorProfile &connector_profile)
	Check whether connector_id of ConnectorProfile is empty.

static std::string	getUUID ()
	Generate the UUID.

static void	setUUID (ConnectorProfile &connector_profile)
	Generate and set the UUID to the ConnectorProfile.

Protected Attributes inherited from RTC::InPortBase
bool	m_singlebuffer
	Buffer mode.

CdrBufferBase *	m_thebuffer
	Buffer .

coil::vstring	m_providerTypes
	Available providers .

coil::vstring	m_consumerTypes
	Available consumers .

ConnectorList	m_connectors
	Connection list .

bool	m_littleEndian
	Connected Endian .

ConnectorListenersBase *	m_listeners
	ConnectorDataListener listener .

Protected Attributes inherited from RTC::PortBase
coil::Properties	m_properties
	Properties .

Logger	rtclog
	Logger stream .

PortProfile	m_profile
	PortProfile of the Port .

RTC::PortService_var	m_objref
	Object Reference of the Port .

std::mutex	m_profile_mutex
	Mutex of PortProfile .

std::mutex	m_connectorsMutex

std::string	m_ownerInstanceName = "unknown"
	Instance name .

int	m_connectionLimit {-1}
	The maximum number of connections .

ConnectionCallback *	m_onPublishInterfaces {nullptr}
	Callback functor objects.

ConnectionCallback *	m_onSubscribeInterfaces {nullptr}
	Callback functor objects.

ConnectionCallback *	m_onConnected {nullptr}
	Callback functor objects.

ConnectionCallback *	m_onUnsubscribeInterfaces {nullptr}
	Callback functor objects.

ConnectionCallback *	m_onDisconnected {nullptr}
	Callback functor objects.

ConnectionCallback *	m_onConnectionLost {nullptr}
	Callback functor objects.

PortConnectListeners *	m_portconnListeners {nullptr}
	PortConnectListener holder.

DirectPortBase *	m_directport {nullptr}

Detailed Description

template<class FsmType>
class RTC::EventInPort< FsmType >

EventInPort template class.

This is a template class that implements EventInPort. <T> is the type defined in BasicDataType.idl and must be the structure which has both Time type tm and type-T data as a member. EventInPort has a ring buffer internally, and stores the received data externally in this buffer one by one. Unread data and data which is already read are managed with the flag, and the data can be handled by the isNew(), write(), read(), isFull() and isEmpty() method etc.

Since: 0.2.0

Constructor & Destructor Documentation

◆ EventInPort()

template<class FsmType >

RTC::EventInPort< FsmType >::EventInPort	(	const char *	name,
		FsmType &	fsm )

inline

A constructor.

constructor. This is bound to type-T variable given as a parameter.

Parameters

name	A name of the EventInPort. This name is referred by EventInPortBase::name().
fsm	type-T variable that is bound to this EventInPort.

◆ ~EventInPort()

template<class FsmType >

RTC::EventInPort< FsmType >::~EventInPort ( )

overridedefault

Destructor.

Destructor

Member Function Documentation

◆ bindEvent() [1/2]

template<class FsmType >

template<typename TOP , class R >

void RTC::EventInPort< FsmType >::bindEvent	(	const char *	name,
		R(TOP::*	handler )() )

inline

References RTC::InPortBase::addConnectorDataListener(), RTC::EventInPort< FsmType >::name(), and RTC::ON_RECEIVED.

◆ bindEvent() [2/2]

template<class FsmType >

template<class TOP , class R , class P0 >

void RTC::EventInPort< FsmType >::bindEvent	(	const char *	name,
		R(TOP::*	handler )(P0) )

inline

References RTC::InPortBase::addConnectorDataListener(), RTC::EventInPort< FsmType >::name(), and RTC::ON_RECEIVED.

◆ init()

template<class FsmType >

void RTC::EventInPort< FsmType >::init ( coil::Properties & prop )

inlineoverridevirtual

Initializing properties.

This method initializes the port in the specified property.

Parameters

prop	Property for setting ports

Reimplemented from RTC::InPortBase.

References RTC::InPortBase::addConnectorListener(), RTC::InPortBase::init(), RTC::InPortBase::m_thebuffer, and RTC::ON_CONNECT.

◆ name()

template<class FsmType >

virtual const char * RTC::EventInPort< FsmType >::name ( )

inlinevirtual

Get port name.

Returns: The port name

Referenced by RTC::EventInPort< FsmType >::bindEvent(), and RTC::EventInPort< FsmType >::bindEvent().

◆ read()

template<class FsmType >

bool RTC::EventInPort< FsmType >::read ( std::string name = "" )

inlineoverridevirtual

It is a virtual method that is called from RTObject_impl::readAll(). This method reads out data from DataPort.

Returns: true:Success,false:Failure

Implements RTC::InPortBase.

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

EventPort.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EventInPort()

◆ ~EventInPort()

Member Function Documentation

◆ bindEvent() [1/2]

◆ bindEvent() [2/2]

◆ init()

◆ name()

◆ read()