rtctree.ports.SvcInterface Class Reference

Service port interface object. More...

Inheritance diagram for rtctree.ports.SvcInterface:

Public Member Functions
def	__init__ (self, intf_obj=None, args, kwargs)
def	instance_name (self)
def	polarity (self)
def	polarity_as_string (self, add_colour=True)
def	polarity_string (self)
def	reparse (self)
def	type_name (self)

Public Attributes
	polarity

Static Public Attributes
int	PROVIDED = 1
	Constant for provided interface polarity. More...
int	REQUIRED = 2
	Constant for required interface polarity. More...

Private Member Functions
def	_parse (self)

Private Attributes
	_instance_name
	_mutex
	_obj
	_polarity
	_type_name

Detailed Description

Service port interface object.

Object representing the interface used by a service port.

Definition at line 432 of file ports.py.

Constructor & Destructor Documentation

def rtctree.ports.SvcInterface.__init__	(		self,
			intf_obj = None,
			args,
			kwargs
	)

Constructor.

@param intf_obj The CORBA PortInterfaceProfile object to wrap.

Definition at line 434 of file ports.py.

Member Function Documentation

def rtctree.ports.SvcInterface._parse (   self )

private

Definition at line 493 of file ports.py.

def rtctree.ports.SvcInterface.instance_name

(

self

)

Instance name of the interface.

Definition at line 470 of file ports.py.

def rtctree.ports.SvcInterface.polarity

(

self

)

Polarity of this interface.

Definition at line 476 of file ports.py.

def rtctree.ports.SvcInterface.polarity_as_string	(		self,
			add_colour = True
	)

Get the polarity of this interface as a string.

@param add_colour If True, ANSI colour codes will be added to the
          string.
@return A string describing the polarity of this interface.

Definition at line 445 of file ports.py.

def rtctree.ports.SvcInterface.polarity_string

(

self

)

The polarity of this interface as a coloured string.

Definition at line 482 of file ports.py.

def rtctree.ports.SvcInterface.reparse

(

self

)

Reparse the interface object.

Definition at line 465 of file ports.py.

def rtctree.ports.SvcInterface.type_name

(

self

)

Type name of the interface.

Definition at line 488 of file ports.py.

Member Data Documentation

rtctree.ports.SvcInterface._instance_name

private

Definition at line 496 of file ports.py.

rtctree.ports.SvcInterface._mutex

private

Definition at line 442 of file ports.py.

rtctree.ports.SvcInterface._obj

private

Definition at line 441 of file ports.py.

rtctree.ports.SvcInterface._polarity

private

Definition at line 499 of file ports.py.

rtctree.ports.SvcInterface._type_name

private

Definition at line 497 of file ports.py.

rtctree.ports.SvcInterface.polarity

Definition at line 454 of file ports.py.

int rtctree.ports.SvcInterface.PROVIDED = 1

static

Constant for provided interface polarity.

Definition at line 504 of file ports.py.

int rtctree.ports.SvcInterface.REQUIRED = 2

static

Constant for required interface polarity.

Definition at line 506 of file ports.py.

---

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

• ports.py