Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members

RTC::PortProfileHelper Class Reference

PortProfile helper class. More...

#include <PortProfileHelper.h>

List of all members.

Public Member Functions

 PortProfileHelper ()
virtual ~PortProfileHelper ()
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 (Port_ptr port)
 Set Port's object reference.
Port_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.

Classes

struct  conn_id
struct  conn_name
struct  if_name


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  ) 
 

virtual RTC::PortProfileHelper::~PortProfileHelper  )  [virtual]
 


Member Function Documentation

void RTC::PortProfileHelper::appendConnectorProfile ConnectorProfile  conn_profile  ) 
 

Append ConnectorProfile.

This operation appends the ConnectorProfile to the PortProfile.

Parameters:
conn_profile ConnectorProfile 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_profile PortInterfaceProfile to be appended the PortProfile

void RTC::PortProfileHelper::eraseConnectorProfile const char *  name  ) 
 

Erase ConnectorProfile.

This operation erases the ConnectorProfile from the PortProfile.

Parameters:
name The 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:
id The 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_name PortInterfaceProfile 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:
name The 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:
id The 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_name instance_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.

Port_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:
name The 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:
owner The 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:
PortProfile The PortProfile to be stored.

void RTC::PortProfileHelper::setPortRef Port_ptr  port  ) 
 

Set Port's object reference.

This operation set the object reference of the Port.

Parameters:
port Port'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:
prop The NVList of PortProfile's properties.


The documentation for this class was generated from the following file:
Generated on Fri Oct 5 05:16:05 2007 for OpenRTM by  doxygen 1.4.1