|
OpenRTM-aist
1.1.2
|
PortProfile helper class. More...
#include <PortProfileHelper.h>
Public Member Functions | |
| PortProfileHelper () | |
| Constructor. More... | |
| virtual | ~PortProfileHelper (void) |
| Destructor. More... | |
| void | setPortProfile (const PortProfile &profile) |
| Set PortProfile. More... | |
| PortProfile * | getPortProfile () |
| Get PortProfile. More... | |
| void | setName (const char *name) |
| Set PortProfile.name. More... | |
| const char * | getName () const |
| Get PortProfile.name. More... | |
| void | appendPortInterfaceProfile (PortInterfaceProfile if_prof) |
| Append PortInterfaceProfile to the PortProfile. More... | |
| const PortInterfaceProfileList & | getPortInterfaceProfiles () const |
| Get PortInterfaceProfileList. More... | |
| const PortInterfaceProfile | getPortInterfaceProfile (const char *instance_name) const |
| Get PortInterfaceProfile. More... | |
| void | erasePortInterfaceProfile (const char *instance_name) |
| Erase PortInterfaceProfile from the PortProfile. More... | |
| void | setPortRef (PortService_ptr port) |
| Set Port's object reference. More... | |
| PortService_ptr | getPortRef () const |
| Get Port's object reference. More... | |
| void | appendConnectorProfile (ConnectorProfile conn_profile) |
| Append ConnectorProfile. More... | |
| const ConnectorProfileList | getConnectorProfiles () const |
| Get ConnectorProfileList. More... | |
| const ConnectorProfile | getConnectorProfile (const char *name) const |
| Get ConnectorProfile. More... | |
| const ConnectorProfile | getConnectorProfileById (const char *id) const |
| Get ConnectorProfile. More... | |
| void | eraseConnectorProfile (const char *name) |
| Erase ConnectorProfile. More... | |
| void | eraseConnectorProfileById (const char *id) |
| Erase ConnectorProfile. More... | |
| void | setOwner (RTObject_ptr owner) |
| Set owner's object reference to the PortProfile. More... | |
| RTObject_ptr | getOwner () const |
| Get owner's object reference from the PortProfile. More... | |
| void | setProperties (NVList &prop) |
| Set properties to the PortProfile. More... | |
| const NVList & | getProperties () const |
| Get properties of the PortProfile. More... | |
PortProfile helper class.
This class manages the PortProfile that is profiles of the RTC:Port. This is mainly used in PortBase class.
| RTC::PortProfileHelper::PortProfileHelper | ( | ) |
Constructor.
Constructor
|
virtual |
Destructor.
Destructor
| void RTC::PortProfileHelper::appendConnectorProfile | ( | ConnectorProfile | conn_profile | ) |
Append ConnectorProfile.
This operation appends the ConnectorProfile to the PortProfile.
| 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
| 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.
| 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.
| 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
| 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.
| name | The name of ConnectorProfile |
| const ConnectorProfile RTC::PortProfileHelper::getConnectorProfileById | ( | const char * | id | ) | const |
Get ConnectorProfile.
This operation returns the ConnectorProfile specified by ID.
| id | The ID of ConnectorProfile |
| const ConnectorProfileList RTC::PortProfileHelper::getConnectorProfiles | ( | ) | const |
Get ConnectorProfileList.
This operation returns the list of ConnectorProfile of the PortProfile.
| const char* RTC::PortProfileHelper::getName | ( | ) | const |
Get PortProfile.name.
This operation returns a pointer to the 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.
| const PortInterfaceProfile RTC::PortProfileHelper::getPortInterfaceProfile | ( | const char * | instance_name | ) | const |
Get PortInterfaceProfile.
This operation returns the PortInterfaceProfile specified by instance_name.
| instance_name | instance_name of the PortInterfaceProfile |
| const PortInterfaceProfileList& RTC::PortProfileHelper::getPortInterfaceProfiles | ( | ) | const |
Get PortInterfaceProfileList.
This operation returns the PortInterfaceProfileList.
| PortProfile* RTC::PortProfileHelper::getPortProfile | ( | ) |
Get PortProfile.
This operation returns the PortProfile.
| PortService_ptr RTC::PortProfileHelper::getPortRef | ( | ) | const |
Get Port's object reference.
This operation returns the object reference of the PortProfile.
| const NVList& RTC::PortProfileHelper::getProperties | ( | ) | const |
Get properties of the PortProfile.
This operation returns the properties of the PortProfile.
| void RTC::PortProfileHelper::setName | ( | const char * | name | ) |
Set PortProfile.name.
This operation stores a copy of given name to the PortProfile.name.
| 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.
| 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.
| PortProfile | The 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.
| 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.
| prop | The NVList of PortProfile's properties. |
1.8.11