Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members

PortBase Class Reference

List of all members.

Public Member Functions

 __init__ (name=None)
 Constructor.
 __del__ ()
 Destructor.
 get_port_profile ()
 [CORBA interface] Get the PortProfile of the Port
 get_connector_profiles ()
 [CORBA interface] Get the ConnectorProfileList of the Port
 get_connector_profile (connector_id)
 [CORBA interface] Get the ConnectorProfile
 connect (connector_profile)
 [CORBA interface] Connect the Port
 notify_connect (connector_profile)
 [CORBA interface] Notify the Ports connection
 disconnect (connector_id)
 [CORBA interface] Connect the Port
 notify_disconnect (connector_id)
 [CORBA interface] Notify the Ports disconnection
 disconnect_all ()
 [CORBA interface] Connect the Port
 setName (name)
 Set the name of this Port.
 getProfile ()
 Get the PortProfile of the Port.
 setPortRef (port_ref)
 Set the object reference of this Port.
 getPortRef ()
 Get the object reference of this Port.
 setOwner (owner)
 Set the owner RTObject of the Port.
 connectNext (connector_profile)
 Call notify_connect() of the next Port.
 disconnectNext (connector_profile)
 Call notify_disconnect() of the next Port.
 isEmptyId (connector_profile)
 Whether connector_id of ConnectorProfile is empty.
 getUUID ()
 Get the UUID.
 setUUID (connector_profile)
 Create and set the UUID to the ConnectorProfile.
 isExistingConnId (id_)
 Whether the given id exists in stored ConnectorProfiles.
 findConnProfile (id_)
 Find ConnectorProfile with id.
 findConnProfileIndex (id_)
 Find ConnectorProfile with id.
 updateConnectorProfile (connector_profile)
 Append or update the ConnectorProfile list.
 eraseConnectorProfile (id_)
 Delete the ConnectorProfile.
 appendInterface (instance_name, type_name, pol)
 Append an interface to the PortInterfaceProfile.
 deleteInterface (name, pol)
 Delete an interface from the PortInterfaceProfile.
 addProperty (key, value)
 Add NameValue data to PortProfile's properties.
 __init__ (name)
 __call__ (prof)
 __init__ (id_)
 __call__ (cprof)
 __init__ (port_ref)
 __call__ (port_ref)
 __init__ (p, prof)
 __call__ (p)
 __init__ (p, prof)
 __call__ (p)
 __init__ (p)
 __call__ (p)
 __init__ (name, pol)
 __call__ (prof)

Member Function Documentation

PortBase::__call__ prof   ) 
 

PortBase::__call__  ) 
 

PortBase::__call__  ) 
 

PortBase::__call__  ) 
 

PortBase::__call__ port_ref   ) 
 

PortBase::__call__ cprof   ) 
 

PortBase::__call__ prof   ) 
 

PortBase::__del__  ) 
 

Destructor.

PortBase::__init__ name  ,
pol 
 

PortBase::__init__  ) 
 

PortBase::__init__ ,
prof 
 

PortBase::__init__ ,
prof 
 

PortBase::__init__ port_ref   ) 
 

PortBase::__init__ id_   ) 
 

PortBase::__init__ name   ) 
 

PortBase::__init__ name  = None  ) 
 

Constructor.

The constructor of the ProtBase class is given the name of this Port and initialized. At the same time, the PortBase activates itself as CORBA object and stores its object reference to the PortProfile's port_ref member.

Parameters:
name The name of Port

PortBase::addProperty key  ,
value 
 

Add NameValue data to PortProfile's properties.

Parameters:
ValueType The type of value
key The name of properties
value The value of properties

PortBase::appendInterface instance_name  ,
type_name  ,
pol 
 

Append an interface to the PortInterfaceProfile.

This operation appends interface information to the PortInterfaceProfile that is owned by the Port. The given interfaces information only updates PortInterfaceProfile of PortProfile that is obtained through get_port_profile(). In order to provide and require interfaces, proper functions (for example publishInterface(), subscribeInterface() and so on) should be overridden in subclasses, and these functions provide concrete interface connection and disconnection functionality.

The interface (instance) name have to be unique in the Port. If the given interface name is identical with stored interface name, this function returns false.

Parameters:
name The instance name of the interface.
type_name The type name of the interface.
pol The interface's polarity (RTC::PROVIDED or RTC:REQUIRED)
Returns:
false would be returned if the same name is already registered.

PortBase::connect connector_profile   ) 
 

[CORBA interface] Connect the Port

This operation establishes connection according to the given ConnectionProfile inforamtion. Application programs, which is going to establish the connection among Ports owned by RT-Components, have to set valid values to the ConnectorProfile and give it to the argument of connect() operation.

name, ports, (properties) members of ConnectorProfile should be set valid values before giving to the argument of connect() operation.

Parameters:
connector_profile The ConnectorProfile.
Returns:
ReturnCode_t The return code of this operation.

PortBase::connectNext connector_profile   ) 
 

Call notify_connect() of the next Port.

This operation calls the notify_connect() of the next Port's that stored in ConnectorProfile's port_ref sequence.

Parameters:
connector_profile The connection profile information
Returns:
The return code of ReturnCode_t type.

PortBase::deleteInterface name  ,
pol 
 

Delete an interface from the PortInterfaceProfile.

This operation deletes interface information from the PortInterfaceProfile that is owned by the Port.

Parameters:
name The instance name of the interface.
pol The interface's polarity (RTC::PROVIDED or RTC:REQUIRED)
Returns:
false would be returned if the given name is not registered.

PortBase::disconnect connector_id   ) 
 

[CORBA interface] Connect the Port

This operation destroys connection between this port and the peer port according to given id that is given when the connection established.

Parameters:
connector_id The ID of the ConnectorProfile.
Returns:
ReturnCode_t The return code of this operation.

PortBase::disconnect_all  ) 
 

[CORBA interface] Connect the Port

This operation destroys all connection channels owned by the Port.

Returns:
ReturnCode_t The return code of this operation.

PortBase::disconnectNext connector_profile   ) 
 

Call notify_disconnect() of the next Port.

This operation calls the notify_disconnect() of the next Port's that stored in ConnectorProfile's port_ref sequence.

Parameters:
connector_profile The connection profile information
Returns:
The return code of ReturnCode_t type.

PortBase::eraseConnectorProfile id_   ) 
 

Delete the ConnectorProfile.

This operation deletes a ConnectorProfile specified by id from ConnectorProfileList owned by PortProfile of this Port.

Parameters:
id The id of the ConnectorProfile to be deleted.

PortBase::findConnProfile id_   ) 
 

Find ConnectorProfile with id.

This operation returns ConnectorProfile with the given id from Port's ConnectorProfiles' list. If the ConnectorProfile with connector id that is identical with the given id does not exist, empty ConnectorProfile is returned.

Parameters:
id the connector_id to be searched in Port's ConnectorProfiles
Returns:
CoonectorProfile with connector_id

PortBase::findConnProfileIndex id_   ) 
 

Find ConnectorProfile with id.

This operation returns ConnectorProfile with the given id from Port's ConnectorProfiles' list. If the ConnectorProfile with connector id that is identical with the given id does not exist, empty ConnectorProfile is returned.

Parameters:
id the connector_id to be searched in Port's ConnectorProfiles
Returns:
The index of ConnectorProfile of the Port

PortBase::get_connector_profile connector_id   ) 
 

[CORBA interface] Get the ConnectorProfile

This operation returns the ConnectorProfiles specified connector_id.

Parameters:
connector_id ID of the ConnectorProfile
Returns:
the ConnectorProfile identified by the connector_id

PortBase::get_connector_profiles  ) 
 

[CORBA interface] Get the ConnectorProfileList of the Port

This operation returns a list of the ConnectorProfiles of the Port. ConnectorProfile includes the connection information that describes relation between (among) Ports, and Ports exchange the ConnectionProfile on connection process and hold the same information in each Port. ConnectionProfile has the following members,

  • name [string] The name of the connection.
  • connector_id [string] Unique identifier.
  • ports [Port sequnce] The sequence of Port's object reference that are related the connection.
  • properties [NVList] The other properties.

Returns:
the ConnectorProfileList of the Port

PortBase::get_port_profile  ) 
 

[CORBA interface] Get the PortProfile of the Port

This operation returns the PortProfile of the Port. PortProfile struct has the following members,

  • name [string ] The name of the Port.
  • interfaces [PortInterfaceProfileList Œ^] The sequence of PortInterfaceProfile owned by the Port
  • port_ref [Port Object] The object reference of the Port.
  • connector_profile [ConnectorProfileList Œ^] The sequence of ConnectorProfile owned by the Port.
  • owner [RTObject Object] The object reference of RTObject that is owner of the Port.
  • properties [NVList] The other properties.

Returns:
the PortProfile of the Port

PortBase::getPortRef  ) 
 

Get the object reference of this Port.

This operation returns the object reference that is stored in the Port's PortProfile.

Returns:
The object reference of this Port.

PortBase::getProfile  ) 
 

Get the PortProfile of the Port.

This operation returns const reference of the PortProfile.

Returns:
the PortProfile of the Port

PortBase::getUUID  ) 
 

Get the UUID.

This operation generates UUID.

Returns:
uuid

PortBase::isEmptyId connector_profile   ) 
 

Whether connector_id of ConnectorProfile is empty.

Returns:
If the given ConnectorProfile's connector_id is empty string, it returns true.

PortBase::isExistingConnId id_   ) 
 

Whether the given id exists in stored ConnectorProfiles.

This operation returns boolean whether the given id exists in the Port's ConnectorProfiles.

Parameters:
id connector_id to be find in Port's ConnectorProfiles

PortBase::notify_connect connector_profile   ) 
 

[CORBA interface] Notify the Ports connection

This operation is invoked between Ports internally when the connection

is established.

Parameters:
connector_profile The ConnectorProfile.
Returns:
ReturnCode_t The return code of this operation.

PortBase::notify_disconnect connector_id   ) 
 

[CORBA interface] Notify the Ports disconnection

This operation is invoked between Ports internally when the connection is destroied.

Parameters:
connector_id The ID of the ConnectorProfile.
Returns:
ReturnCode_t The return code of this operation.

PortBase::setName name   ) 
 

Set the name of this Port.

This operation sets the name of this Port. The given Port's name is applied to Port's PortProfile.name.

Parameters:
name The name of this Port.

PortBase::setOwner owner   ) 
 

Set the owner RTObject of the Port.

This operation sets the owner RTObject of this Port.

Parameters:
owner The owner RTObject's reference of this Port

PortBase::setPortRef port_ref   ) 
 

Set the object reference of this Port.

This operation sets the object reference itself to the Port's PortProfile.

Parameters:
The object reference of this Port.

PortBase::setUUID connector_profile   ) 
 

Create and set the UUID to the ConnectorProfile.

This operation generates and set UUID to the ConnectorProfile.

Parameters:
connector_profile ConnectorProfile to be set connector_id

PortBase::updateConnectorProfile connector_profile   ) 
 

Append or update the ConnectorProfile list.

This operation appends or updates ConnectorProfile of the Port by the given ConnectorProfile. If the connector_id of the given ConnectorProfile does not exist in the Port's ConnectorProfile list, the given ConnectorProfile would be append to the list. If the same id exists, the list would be updated.

Parameters:
connector_profile the ConnectorProfile to be appended or updated


The documentation for this class was generated from the following file:
Generated on Mon Oct 29 15:51:44 2007 for OpenRTM by  doxygen 1.4.3