RTC::InPortBase Class Reference

Port for InPort. More...

#include <InPortBase.h>

Inheritance diagram for RTC::InPortBase:

RTC::PortBase RTC::DataPortStatus RTC::InPort< DataType >

List of all members.

Public Member Functions

 InPortBase (const char *name, const char *data_type)
 Constructor.
virtual ~InPortBase (void)
 Destructor.
coil::Properties & properties ()
void init ()
virtual void activateInterfaces ()
 Activate all Port interfaces.
virtual void deactivateInterfaces ()
 Deactivate all Port interfaces.

Public Attributes

DATAPORTSTATUS_ENUM
typedef std::vector
< InPortConnector * > 
ConnectorList

Protected Member Functions

virtual ReturnCode_t publishInterfaces (ConnectorProfile &connector_profile)
 Publish interface information.
virtual ReturnCode_t subscribeInterfaces (const ConnectorProfile &connector_profile)
 Subscribe to the interface.
virtual void unsubscribeInterfaces (const ConnectorProfile &connector_profile)
 Disconnect the interface connection.
void initProviders ()
 InPort provider initialization.
void initConsumers ()
 OutPort consumer initialization.
InPortProvidercreateProvider (ConnectorProfile &cprof, coil::Properties &prop)
 InPort provider creation.
OutPortConsumercreateConsumer (const ConnectorProfile &cprof, coil::Properties &prop)
 InPort provider creation.
InPortConnectorcreateConnector (ConnectorProfile &cprof, coil::Properties &prop, InPortProvider *provider)
 InPortPushConnector creation.
InPortConnectorcreateConnector (const ConnectorProfile &cprof, coil::Properties &prop, OutPortConsumer *consumer)
 InPortPullConnector creation.

Protected Attributes

bool m_singlebuffer
CdrBufferBasem_thebuffer
coil::Properties m_properties
coil::vstring m_providerTypes
coil::vstring m_consumerTypes
ConnectorList m_connectors


Detailed Description

Port for InPort.

This is an implementation class for the data input port.

Since:
0.4.0

Constructor & Destructor Documentation

RTC::InPortBase::InPortBase ( const char *  name,
const char *  data_type 
)

Constructor.

Constructor

Parameters:
name Port name
inport InPort object that is associated with this data input port. Specify also the data type and the buffer type used in the InPort object.
prop Property for setting ports

virtual RTC::InPortBase::~InPortBase ( void   )  [virtual]

Destructor.

Destructor


Member Function Documentation

coil::Properties& RTC::InPortBase::properties (  ) 

void RTC::InPortBase::init (  ) 

virtual void RTC::InPortBase::activateInterfaces (  )  [virtual]

Activate all Port interfaces.

This operation activate all interfaces that is registered in the ports.

Implements RTC::PortBase.

virtual void RTC::InPortBase::deactivateInterfaces (  )  [virtual]

Deactivate all Port interfaces.

This operation deactivate all interfaces that is registered in the ports.

Implements RTC::PortBase.

virtual ReturnCode_t RTC::InPortBase::publishInterfaces ( ConnectorProfile &  connector_profile  )  [protected, virtual]

Publish interface information.

Publish interface information. Assign the Provider information that owned by this port to ConnectorProfile::properties

Parameters:
connector_profile The connector profile
Returns:
The return code of ReturnCode_t type

Implements RTC::PortBase.

virtual ReturnCode_t RTC::InPortBase::subscribeInterfaces ( const ConnectorProfile &  connector_profile  )  [protected, virtual]

Subscribe to the interface.

Subscribe to interface. Derive Provider information that matches Consumer owned by the Port from ConnectorProfile::properties and set the Consumer to the reference of the CORBA object.

Parameters:
connector_profile The connector profile
Returns:
ReturnCode_t The return code of ReturnCode_t type

Implements RTC::PortBase.

virtual void RTC::InPortBase::unsubscribeInterfaces ( const ConnectorProfile &  connector_profile  )  [protected, virtual]

Disconnect the interface connection.

Disconnect the interface connection. Release all objects set in Consumer associated with given ConnectorProfile and unscribe the interface.

Parameters:
connector_profile The connector profile

Implements RTC::PortBase.

void RTC::InPortBase::initProviders (  )  [protected]

InPort provider initialization.

void RTC::InPortBase::initConsumers (  )  [protected]

OutPort consumer initialization.

InPortProvider* RTC::InPortBase::createProvider ( ConnectorProfile &  cprof,
coil::Properties &  prop 
) [protected]

InPort provider creation.

OutPortConsumer* RTC::InPortBase::createConsumer ( const ConnectorProfile &  cprof,
coil::Properties &  prop 
) [protected]

InPort provider creation.

InPortConnector* RTC::InPortBase::createConnector ( ConnectorProfile &  cprof,
coil::Properties &  prop,
InPortProvider provider 
) [protected]

InPortPushConnector creation.

InPortConnector* RTC::InPortBase::createConnector ( const ConnectorProfile &  cprof,
coil::Properties &  prop,
OutPortConsumer consumer 
) [protected]

InPortPullConnector creation.


Member Data Documentation

DATAPORTSTATUS_ENUM typedef std::vector<InPortConnector*> RTC::InPortBase::ConnectorList

bool RTC::InPortBase::m_singlebuffer [protected]

CdrBufferBase* RTC::InPortBase::m_thebuffer [protected]

coil::Properties RTC::InPortBase::m_properties [protected]

coil::vstring RTC::InPortBase::m_providerTypes [protected]

coil::vstring RTC::InPortBase::m_consumerTypes [protected]

ConnectorList RTC::InPortBase::m_connectors [protected]


Generated on Sun May 24 14:08:45 2009 for OpenRTM by  doxygen 1.5.3