OpenRTM  1.0.0
Classes | Public Member Functions | List of all members
RTC::PortProfileHelper Class Reference

PortProfile helper class. More...

#include <PortProfileHelper.h>

Classes

struct  conn_id
struct  conn_name
struct  if_name

Public Member Functions

 PortProfileHelper ()
 Constructor.
virtual ~PortProfileHelper (void)
 Destructor.
void setPortProfile (const PortProfile &profile)
 Set PortProfile.
PortProfile * getPortProfile ()
 Get PortProfile.
void setName (const char *name)
 Set PortProfile.name.
const char * getName () const
 Get PortProfile.name.
void appendPortInterfaceProfile (PortInterfaceProfile if_prof)
 Append PortInterfaceProfile to the PortProfile.
const PortInterfaceProfileList & getPortInterfaceProfiles () const
 Get PortInterfaceProfileList.
const PortInterfaceProfile getPortInterfaceProfile (const char *instance_name) const
 Get PortInterfaceProfile.
void erasePortInterfaceProfile (const char *instance_name)
 Erase PortInterfaceProfile from the PortProfile.
void setPortRef (PortService_ptr port)
 Set Port's object reference.
PortService_ptr getPortRef () const
 Get Port's object reference.
void appendConnectorProfile (ConnectorProfile conn_profile)
 Append ConnectorProfile.
const ConnectorProfileList getConnectorProfiles () const
 Get ConnectorProfileList.
const ConnectorProfile getConnectorProfile (const char *name) const
 Get ConnectorProfile.
const ConnectorProfile getConnectorProfileById (const char *id) const
 Get ConnectorProfile.
void eraseConnectorProfile (const char *name)
 Erase ConnectorProfile.
void eraseConnectorProfileById (const char *id)
 Erase ConnectorProfile.
void setOwner (RTObject_ptr owner)
 Set owner's object reference to the PortProfile.
RTObject_ptr getOwner () const
 Get owner's object reference from the PortProfile.
void setProperties (NVList &prop)
 Set properties to the PortProfile.
const NVList & getProperties () const
 Get properties of the PortProfile.

Detailed Description

PortProfile helper class.

This class manages the PortProfile that is profiles of the RTC:Port. This is mainly used in PortBase class.

Constructor & Destructor Documentation

RTC::PortProfileHelper::PortProfileHelper ( )

Constructor.

Constructor

virtual RTC::PortProfileHelper::~PortProfileHelper ( void  )
virtual

Destructor.

Destructor

Member Function Documentation

void RTC::PortProfileHelper::appendConnectorProfile ( ConnectorProfile  conn_profile)

Append ConnectorProfile.

This operation appends the ConnectorProfile to the PortProfile.

Parameters
conn_profileConnectorProfile to be added.
void RTC::PortProfileHelper::appendPortInterfaceProfile ( PortInterfaceProfile  if_prof)

Append PortInterfaceProfile to the PortProfile.

This operation appends the PortInterfaceProfile to the PortProfile

Parameters
if_profilePortInterfaceProfile to be appended the PortProfile
void RTC::PortProfileHelper::eraseConnectorProfile ( const char *  name)

Erase ConnectorProfile.

This operation erases the ConnectorProfile from the PortProfile.

Parameters
nameThe name of the ConnectorProfile to be erased.
void RTC::PortProfileHelper::eraseConnectorProfileById ( const char *  id)

Erase ConnectorProfile.

This operation erases the ConnectorProfile from the PortProfile.

Parameters
idThe ID of the ConnectorProfile to be erased.
void RTC::PortProfileHelper::erasePortInterfaceProfile ( const char *  instance_name)

Erase PortInterfaceProfile from the PortProfile.

This operation erases the PortInterfaceProfile from the PortProfile

Parameters
instance_namePortInterfaceProfile to be erased from the PortProfile
const ConnectorProfile RTC::PortProfileHelper::getConnectorProfile ( const char *  name) const

Get ConnectorProfile.

This operation returns the ConnectorProfile specified by name.

Parameters
nameThe name of ConnectorProfile
Returns
ConnectorProfile.
const ConnectorProfile RTC::PortProfileHelper::getConnectorProfileById ( const char *  id) const

Get ConnectorProfile.

This operation returns the ConnectorProfile specified by ID.

Parameters
idThe ID of ConnectorProfile
Returns
ConnectorProfile.
const ConnectorProfileList RTC::PortProfileHelper::getConnectorProfiles ( ) const

Get ConnectorProfileList.

This operation returns the list of ConnectorProfile of the PortProfile.

Returns
Port's ConnectorProfileList.
const char* RTC::PortProfileHelper::getName ( ) const

Get PortProfile.name.

This operation returns a pointer to the PortProfile.name.

Returns
The pointer to PortProfile.name.
RTObject_ptr RTC::PortProfileHelper::getOwner ( ) const

Get owner's object reference from the PortProfile.

This operation returns the owner's object reference of the PortProfile.

Returns
The owner's object reference of PortProfile.
const PortInterfaceProfile RTC::PortProfileHelper::getPortInterfaceProfile ( const char *  instance_name) const

Get PortInterfaceProfile.

This operation returns the PortInterfaceProfile specified by instance_name.

Parameters
instance_nameinstance_name of the PortInterfaceProfile
Returns
PortInterfaceProfile
const PortInterfaceProfileList& RTC::PortProfileHelper::getPortInterfaceProfiles ( ) const

Get PortInterfaceProfileList.

This operation returns the PortInterfaceProfileList.

Returns
PortInterfaceProfileList
PortProfile* RTC::PortProfileHelper::getPortProfile ( )

Get PortProfile.

This operation returns the PortProfile.

Returns
The PortProfile stored by the object.
PortService_ptr RTC::PortProfileHelper::getPortRef ( ) const

Get Port's object reference.

This operation returns the object reference of the PortProfile.

Returns
Port's object reference associated with the PortProfile.
const NVList& RTC::PortProfileHelper::getProperties ( ) const

Get properties of the PortProfile.

This operation returns the properties of the PortProfile.

Returns
The NVList of PortProfile's properties.
void RTC::PortProfileHelper::setName ( const char *  name)

Set PortProfile.name.

This operation stores a copy of given name to the PortProfile.name.

Parameters
nameThe name of Port to be stored to the PortProfile.name.
void RTC::PortProfileHelper::setOwner ( RTObject_ptr  owner)

Set owner's object reference to the PortProfile.

This operation sets the owner's object reference to the PortProfile.

Parameters
ownerThe owner's object reference of PortProfile.
void RTC::PortProfileHelper::setPortProfile ( const PortProfile &  profile)

Set PortProfile.

This operation copies the given PortProfile and overwrites the existent PortProfile by the given ProtProfile.

Parameters
PortProfileThe PortProfile to be stored.
void RTC::PortProfileHelper::setPortRef ( PortService_ptr  port)

Set Port's object reference.

This operation set the object reference of the Port.

Parameters
portPort's object reference to be set.
void RTC::PortProfileHelper::setProperties ( NVList &  prop)

Set properties to the PortProfile.

This operation set the properties to the PortProfile.

Parameters
propThe NVList of PortProfile's properties.