OpenRTM_aist.PortProfileHelper.PortProfileHelper Class Reference

PortProfile helper class. More...

Classes
class	conn_name
class	if_name
	A functor to find a PortInterfaceProfile named instance_name. More...
Public Member Functions
def	setPortProfile
	Set PortProfile.
def	getPortProfile
	Get PortProfile.
def	setName
	Set PortProfile.name.
def	getName
	Get PortProfile.name.
def	appendPortInterfaceProfile
	Append PortInterfaceProfile to the PortProfile.
def	getPortInterfaceProfiles
	Get PortInterfaceProfileList.
def	getPortInterfaceProfile
	Get PortInterfaceProfile.
def	erasePortInterfaceProfile
	Erase PortInterfaceProfile from the PortProfile.
def	setPortRef
	Set Port's object reference.
def	getPortRef
	Get Port's object reference.
def	appendConnectorProfile
	Append ConnectorProfile.
def	getConnectorProfiles
	Get ConnectorProfileList.
def	getConnectorProfile
	Get ConnectorProfile.
def	getConnectorProfileById
	Get ConnectorProfile.
def	eraseConnectorProfile
	Erase ConnectorProfile.
def	eraseConnectorProfileById
	Erase ConnectorProfile.
def	setOwner
	Set owner's object reference to the PortProfile.
def	getOwner
	Get owner's object reference from the PortProfile.
def	setProperties
	Set properties to the PortProfile.
def	getProperties
	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.

Member Function Documentation

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.appendConnectorProfile	(	self,
		conn_profile
	)

Append ConnectorProfile.

This operation appends the ConnectorProfile to the PortProfile.

Parameters:

conn_profile

ConnectorProfile to be added.

void appendConnectorProfile(ConnectorProfile conn_profile);

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.appendPortInterfaceProfile	(	self,
		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 appendPortInterfaceProfile(PortInterfaceProfile if_prof);

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.eraseConnectorProfile	(	self,
		name
	)

Erase ConnectorProfile.

This operation erases the ConnectorProfile from the PortProfile.

Parameters:

name

The name of the ConnectorProfile to be erased.

void eraseConnectorProfile(const char* name);

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.eraseConnectorProfileById	(	self,
		id
	)

Erase ConnectorProfile.

This operation erases the ConnectorProfile from the PortProfile.

Parameters:

id

The ID of the ConnectorProfile to be erased.

void eraseConnectorProfileById(const char* id);

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.erasePortInterfaceProfile	(	self,
		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

void erasePortInterfaceProfile(const char* instance_name);

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getConnectorProfile	(	self,
		name
	)

Get ConnectorProfile.

This operation returns the ConnectorProfile specified by name.

Parameters:

name

The name of ConnectorProfile

Returns:: ConnectorProfile.

const ConnectorProfile getConnectorProfile(const char* name) const;

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getConnectorProfileById	(	self,
		id
	)

Get ConnectorProfile.

This operation returns the ConnectorProfile specified by ID.

Parameters:

id

The ID of ConnectorProfile

Returns:: ConnectorProfile.

const ConnectorProfile getConnectorProfileById(const char* id) const;

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getConnectorProfiles ( self )

Get ConnectorProfileList.

This operation returns the list of ConnectorProfile of the PortProfile.

Returns:: Port's ConnectorProfileList.

const ConnectorProfileList getConnectorProfiles() const;

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getName ( self )

Get PortProfile.name.

This operation returns a pointer to the PortProfile.name.

Returns:: The pointer to PortProfile.name.

const char* getName() const;

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getOwner ( self )

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.

RTObject_ptr getOwner() const;

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getPortInterfaceProfile	(	self,
		instance_name
	)

Get PortInterfaceProfile.

This operation returns the PortInterfaceProfile specified by instance_name.

Parameters:

instance_name

instance_name of the PortInterfaceProfile

Returns:: PortInterfaceProfile

const PortInterfaceProfile getPortInterfaceProfile(const char* instance_name) const;

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getPortInterfaceProfiles ( self )

Get PortInterfaceProfileList.

This operation returns the PortInterfaceProfileList.

Returns:: PortInterfaceProfileList

const PortInterfaceProfileList& getPortInterfaceProfiles() const;

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getPortProfile ( self )

Get PortProfile.

This operation returns the PortProfile.

Returns:: The PortProfile stored by the object.

PortProfile* getPortProfile();

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getPortRef ( self )

Get Port's object reference.

This operation returns the object reference of the PortProfile.

Returns:: Port's object reference associated with the PortProfile.

PortService_ptr getPortRef() const;

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getProperties ( self )

Get properties of the PortProfile.

This operation returns the properties of the PortProfile.

Returns:: The NVList of PortProfile's properties.

const NVList& getProperties() const;

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.setName	(	self,
		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 setName(const char* name);

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.setOwner	(	self,
		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 setOwner(RTObject_ptr owner);

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.setPortProfile	(	self,
		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 setPortProfile(const PortProfile& profile);

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.setPortRef	(	self,
		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 setPortRef(PortService_ptr port);

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.setProperties	(	self,
		prop
	)

Set properties to the PortProfile.

This operation set the properties to the PortProfile.

Parameters:

prop

The NVList of PortProfile's properties.

void setProperties(NVList& prop);

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

/var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/PortProfileHelper.py

OpenRTM_aist.PortProfileHelper.PortProfileHelper Class Reference

Classes

Public Member Functions

Detailed Description

Member Function Documentation