PortProfile helper class. More...

#include <PortProfileHelper.h>

Classes
struct	conn_id

struct	conn_name

struct	if_name

Public Member Functions
void	appendConnectorProfile (ConnectorProfile conn_profile)
	Append ConnectorProfile. More...

void	appendPortInterfaceProfile (PortInterfaceProfile if_prof)
	Append PortInterfaceProfile to the PortProfile. More...

void	eraseConnectorProfile (const char *name)
	Erase ConnectorProfile. More...

void	eraseConnectorProfileById (const char *id)
	Erase ConnectorProfile. More...

void	erasePortInterfaceProfile (const char *instance_name)
	Erase PortInterfaceProfile from the PortProfile. More...

const ConnectorProfile	getConnectorProfile (const char *name) const
	Get ConnectorProfile. More...

const ConnectorProfile	getConnectorProfileById (const char *id) const
	Get ConnectorProfile. More...

const ConnectorProfileList	getConnectorProfiles () const
	Get ConnectorProfileList. More...

const char *	getName () const
	Get PortProfile.name. More...

RTObject_ptr	getOwner () const
	Get owner's object reference from the PortProfile. More...

const PortInterfaceProfile	getPortInterfaceProfile (const char *instance_name) const
	Get PortInterfaceProfile. More...

const PortInterfaceProfileList &	getPortInterfaceProfiles () const
	Get PortInterfaceProfileList. More...

PortProfile *	getPortProfile ()
	Get PortProfile. More...

PortService_ptr	getPortRef () const
	Get Port's object reference. More...

const NVList &	getProperties () const
	Get properties of the PortProfile. More...

	PortProfileHelper ()
	Constructor. More...

void	setName (const char *name)
	Set PortProfile.name. More...

void	setOwner (RTObject_ptr owner)
	Set owner's object reference to the PortProfile. More...

void	setPortProfile (const PortProfile &profile)
	Set PortProfile. More...

void	setPortRef (PortService_ptr port)
	Set Port's object reference. More...

void	setProperties (NVList &prop)
	Set properties to the PortProfile. More...

virtual	~PortProfileHelper (void)
	Destructor. More...

Private Types
typedef SequenceEx< ConnectorProfileList, ConnectorProfile, Mutex >	ConnProfiles

typedef SequenceEx< PortInterfaceProfileList, PortInterfaceProfile, Mutex >	IfProfiles

typedef coil::Mutex	Mutex

Private Attributes
ConnProfiles	m_connProfiles

IfProfiles	m_ifProfiles

Mutex	m_mutex

std::string	m_name

RTObject_var	m_owner

PortService_var	m_portRef

NVList	m_properties

Detailed Description

PortProfile helper class.

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

Definition at line 57 of file PortProfileHelper.h.

Member Typedef Documentation

◆ ConnProfiles

typedef SequenceEx<ConnectorProfileList, ConnectorProfile, Mutex> RTC::PortProfileHelper::ConnProfiles

private

Definition at line 574 of file PortProfileHelper.h.

◆ IfProfiles

typedef SequenceEx<PortInterfaceProfileList, PortInterfaceProfile, Mutex> RTC::PortProfileHelper::IfProfiles

private

Definition at line 565 of file PortProfileHelper.h.

◆ Mutex

typedef coil::Mutex RTC::PortProfileHelper::Mutex

private

Definition at line 59 of file PortProfileHelper.h.

Constructor & Destructor Documentation

◆ PortProfileHelper()

RTC::PortProfileHelper::PortProfileHelper ( )

Constructor.

Constructor

Definition at line 23 of file PortProfileHelper.cpp.

◆ ~PortProfileHelper()

RTC::PortProfileHelper::~PortProfileHelper ( void )

virtual

Destructor.

Destructor

Definition at line 29 of file PortProfileHelper.cpp.

Member Function Documentation

◆ appendConnectorProfile()

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

Append ConnectorProfile.

This operation appends the ConnectorProfile to the PortProfile.

Parameters

conn_profile ConnectorProfile to be added.

Definition at line 212 of file PortProfileHelper.cpp.

◆ appendPortInterfaceProfile()

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

Definition at line 118 of file PortProfileHelper.cpp.

◆ eraseConnectorProfile()

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.

Definition at line 276 of file PortProfileHelper.cpp.

◆ eraseConnectorProfileById()

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.

Definition at line 292 of file PortProfileHelper.cpp.

◆ erasePortInterfaceProfile()

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

Definition at line 166 of file PortProfileHelper.cpp.

◆ getConnectorProfile()

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.

Definition at line 244 of file PortProfileHelper.cpp.

◆ getConnectorProfileById()

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.

Definition at line 260 of file PortProfileHelper.cpp.

◆ getConnectorProfiles()

const ConnectorProfileList RTC::PortProfileHelper::getConnectorProfiles ( ) const

Get ConnectorProfileList.

This operation returns the list of ConnectorProfile of the PortProfile.

Returns: Port's ConnectorProfileList.

Definition at line 227 of file PortProfileHelper.cpp.

◆ getName()

const char * RTC::PortProfileHelper::getName ( void ) const

Get PortProfile.name.

This operation returns a pointer to the PortProfile.name.

Returns: The pointer to PortProfile.name.

Definition at line 102 of file PortProfileHelper.cpp.

◆ getOwner()

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.

Definition at line 322 of file PortProfileHelper.cpp.

◆ getPortInterfaceProfile()

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

Definition at line 151 of file PortProfileHelper.cpp.

◆ getPortInterfaceProfiles()

const PortInterfaceProfileList & RTC::PortProfileHelper::getPortInterfaceProfiles ( ) const

Get PortInterfaceProfileList.

This operation returns the PortInterfaceProfileList.

Returns: PortInterfaceProfileList

Definition at line 135 of file PortProfileHelper.cpp.

◆ getPortProfile()

PortProfile * RTC::PortProfileHelper::getPortProfile ( )

Get PortProfile.

This operation returns the PortProfile.

Returns: The PortProfile stored by the object.

Definition at line 64 of file PortProfileHelper.cpp.

◆ getPortRef()

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.

Definition at line 197 of file PortProfileHelper.cpp.

◆ getProperties()

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.

Definition at line 352 of file PortProfileHelper.cpp.

◆ setName()

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.

Definition at line 87 of file PortProfileHelper.cpp.

◆ setOwner()

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.

Definition at line 308 of file PortProfileHelper.cpp.

◆ setPortProfile()

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.

Definition at line 42 of file PortProfileHelper.cpp.

◆ setPortRef()

void RTC::PortProfileHelper::setPortRef ( PortService_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.

Definition at line 182 of file PortProfileHelper.cpp.

◆ setProperties()

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.

Definition at line 337 of file PortProfileHelper.cpp.

Member Data Documentation

◆ m_connProfiles

ConnProfiles RTC::PortProfileHelper::m_connProfiles

private

Definition at line 575 of file PortProfileHelper.h.

◆ m_ifProfiles

IfProfiles RTC::PortProfileHelper::m_ifProfiles

private

Definition at line 566 of file PortProfileHelper.h.

◆ m_mutex

Mutex RTC::PortProfileHelper::m_mutex

mutableprivate

Definition at line 584 of file PortProfileHelper.h.

◆ m_name

std::string RTC::PortProfileHelper::m_name

private

Definition at line 560 of file PortProfileHelper.h.

◆ m_owner

RTObject_var RTC::PortProfileHelper::m_owner

private

Definition at line 578 of file PortProfileHelper.h.

◆ m_portRef

PortService_var RTC::PortProfileHelper::m_portRef

private

Definition at line 569 of file PortProfileHelper.h.

◆ m_properties

NVList RTC::PortProfileHelper::m_properties

private

Definition at line 581 of file PortProfileHelper.h.

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

Classes

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ConnProfiles

◆ IfProfiles

◆ Mutex

Constructor & Destructor Documentation

◆ PortProfileHelper()

◆ ~PortProfileHelper()

Member Function Documentation

◆ appendConnectorProfile()

◆ appendPortInterfaceProfile()

◆ eraseConnectorProfile()

◆ eraseConnectorProfileById()

◆ erasePortInterfaceProfile()

◆ getConnectorProfile()

◆ getConnectorProfileById()

◆ getConnectorProfiles()

◆ getName()

◆ getOwner()

◆ getPortInterfaceProfile()

◆ getPortInterfaceProfiles()

◆ getPortProfile()

◆ getPortRef()

◆ getProperties()

◆ setName()

◆ setOwner()

◆ setPortProfile()

◆ setPortRef()

◆ setProperties()

Member Data Documentation

◆ m_connProfiles

◆ m_ifProfiles

◆ m_mutex

◆ m_name

◆ m_owner

◆ m_portRef

◆ m_properties