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. More...
def	activatePorts (self)
	Activate all Port interfaces void PortAdmin::activatePorts() More...
def	addPort (self, port)
def	deactivatePorts (self)
	Deactivate all Port interfaces void PortAdmin::deactivatePorts() More...
def	deletePort (self, port)
	Delete the Port's registration. More...
def	deletePortByName (self, port_name)
	Delete the Port' registration. More...
def	finalizePorts (self)
	Unregister the Port. More...
def	getPort (self, port_name)
	Getpointer to the Port's servant. More...
def	getPortProfileList (self)
	Get PorProfileList. More...
def	getPortRef (self, port_name)
	Get PortServiceList. More...
def	getPortServiceList (self)
	Get PortServiceList. More...
def	registerPort (self, port)
	Regsiter Port. More...
def	removePort (self, port)

Private Attributes
	_orb
	_poa
	_portRefs
	_portServants
	_rtcout

Detailed Description

PortAdmin class.

Definition at line 41 of file PortAdmin.py.

Constructor & Destructor Documentation

def OpenRTM_aist.PortAdmin.PortAdmin.__init__	(		self,
			orb,
			poa
	)

Constructor.

Definition at line 120 of file PortAdmin.py.

Member Function Documentation

def OpenRTM_aist.PortAdmin.PortAdmin.activatePorts

(

self

)

Activate all Port interfaces void PortAdmin::activatePorts()

Definition at line 400 of file PortAdmin.py.

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

Definition at line 288 of file PortAdmin.py.

def OpenRTM_aist.PortAdmin.PortAdmin.deactivatePorts

(

self

)

Deactivate all Port interfaces void PortAdmin::deactivatePorts()

Definition at line 415 of file PortAdmin.py.

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.

Definition at line 334 of file PortAdmin.py.

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.

Definition at line 384 of file PortAdmin.py.

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.

Definition at line 441 of file PortAdmin.py.

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.

Definition at line 247 of file PortAdmin.py.

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

Definition at line 180 of file PortAdmin.py.

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.

Definition at line 214 of file PortAdmin.py.

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

Definition at line 156 of file PortAdmin.py.

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);

Definition at line 276 of file PortAdmin.py.

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

Definition at line 340 of file PortAdmin.py.

Member Data Documentation

OpenRTM_aist.PortAdmin.PortAdmin._orb

private

Definition at line 122 of file PortAdmin.py.

OpenRTM_aist.PortAdmin.PortAdmin._poa

private

Definition at line 125 of file PortAdmin.py.

OpenRTM_aist.PortAdmin.PortAdmin._portRefs

private

Definition at line 128 of file PortAdmin.py.

OpenRTM_aist.PortAdmin.PortAdmin._portServants

private

Definition at line 131 of file PortAdmin.py.

OpenRTM_aist.PortAdmin.PortAdmin._rtcout

private

Definition at line 133 of file PortAdmin.py.

---

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

• PortAdmin.py