OpenRTM_aist.PortAdmin.PortAdmin Class Reference

PortAdmin class. More...

Classes
class	comp_op
class	del_port
	Functor to delete the Port. More...
class	find_port
class	find_port_name

Public Member Functions
def	__init__ (self, orb, poa)
	Constructor.
def	getPortServiceList (self)
	Get PortServiceList. More...
def	getPortProfileList (self)
	Get PorProfileList. More...
def	getPortRef (self, port_name)
	Get PortServiceList. More...
def	getPort (self, port_name)
	Getpointer to the Port's servant. More...
def	registerPort (self, port)
	Regsiter Port. More...
def	deletePort (self, port)
	Delete the Port's registration. More...
def	deletePortByName (self, port_name)
	Delete the Port' registration. More...
def	activatePorts (self)
	Activate all Port interfaces void PortAdmin::activatePorts()
def	deactivatePorts (self)
	Deactivate all Port interfaces void PortAdmin::deactivatePorts()
def	finalizePorts (self)
	Unregister the Port. More...

Detailed Description

PortAdmin class.

Member Function Documentation

def OpenRTM_aist.PortAdmin.PortAdmin.deletePort	(		self,
			port
	)

Delete the Port's registration.

This operation unregisters the Port's registration. When the Port is unregistered, Port is deactivated, and the object reference in the Port's profile is set to nil.

Parameters

port	The Port's servant.

def OpenRTM_aist.PortAdmin.PortAdmin.deletePortByName	(		self,
			port_name
	)

Delete the Port' registration.

This operation delete the Port's registration specified by port_ name. When the Port is unregistered, Port is deactivated, and the object reference in the Port's profile is set to nil.

Parameters

port_name

The Port's name.

def OpenRTM_aist.PortAdmin.PortAdmin.finalizePorts

(

self

)

Unregister the Port.

This operation deactivates the all Port and deletes the all Port's registrations from the list.

def OpenRTM_aist.PortAdmin.PortAdmin.getPort	(		self,
			port_name
	)

Getpointer to the Port's servant.

This operation returns the pointer to the PortBase servant regsitered by registerPort().

Parameters

port_name

The name of Port to be returned the servant pointer.

Returns

PortBase* Port's servant's pointer.

def OpenRTM_aist.PortAdmin.PortAdmin.getPortProfileList

(

self

)

Get PorProfileList.

This operation gets the Profile list of Ports registered by addPort().

Returns

The pointer points PortProfile list

def OpenRTM_aist.PortAdmin.PortAdmin.getPortRef	(		self,
			port_name
	)

Get PortServiceList.

This operation returns the pointer to the PortServiceList of Ports regsitered by registerPort().

Parameters

port_name

The name of Port to be returned the reference.

Returns

Port_ptr Port's object reference.

def OpenRTM_aist.PortAdmin.PortAdmin.getPortServiceList

(

self

)

Get PortServiceList.

This operation returns the pointer to the PortServiceList of Ports regsitered by registerPort().

Returns

PortServiceList+ The pointer points PortServiceList

def OpenRTM_aist.PortAdmin.PortAdmin.registerPort	(		self,
			port
	)

Regsiter Port.

This operation registers the Port's servant given by argument. The given Port's servant will be activated on the POA that is given to the constructor, and the created object reference is set to the Port's profile.

Parameters

port	The Port's servant.

void registerPort(PortBase& port);

---

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

• /home/openrtm/git-src/OpenRTM-aist-Python/OpenRTM_aist/PortAdmin.py