OpenRTM_aist.PortAdmin.PortAdmin.find_port Class Reference

List of all members.

Public Member Functions
def	__init__
	Constructor.
def	getPortServiceList
	Get PortServiceList.
def	getPortProfileList
	Get PorProfileList.
def	getPortRef
	Get PortServiceList.
def	getPort
	Getpointer to the Port's servant.
def	registerPort
	Regsiter Port.
def	deletePort
	Delete the Port's registration.
def	deletePortByName
	Delete the Port' registration.
def	activatePorts
	Activate all Port interfacesvoid PortAdmin.activatePorts().
def	deactivatePorts
	Deactivate all Port interfacesvoid PortAdmin.deactivatePorts().
def	finalizePorts
	Unregister the Port.

---

Member Function Documentation

def OpenRTM_aist.PortAdmin.PortAdmin.find_port.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.find_port.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.find_port.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.find_port.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.find_port.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.find_port.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.find_port.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.find_port.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:

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