Execution context object. More...

Public Member Functions
def	__init__
def	activate_component
def	deactivate_component
def	get_component_state
def	handle
def	kind
def	kind_as_string
def	kind_string
def	owner
def	owner_name
def	participant_names
def	participants
def	properties
def	rate
def	rate
def	reparse
def	reset_component
def	running
def	running_as_string
def	running_string
def	start
def	stop
Public Attributes
	kind
Static Public Attributes
int	EVENT_DRIVEN = 2
	Constant for an event driven execution context.
int	OTHER = 3
	Constant for an execution context of some other type.
int	PERIODIC = 1
	Constant for a periodic execution context.
Private Member Functions
def	_parse
Private Attributes
	_handle
	_is_service
	_mutex
	_obj
	_owner
	_participants
	_properties

Detailed Description

Execution context object.

An execution context, within which components may be executing.

Definition at line 30 of file exec_context.py.

Constructor & Destructor Documentation

def rtctree.exec_context.ExecutionContext.__init__	(	self,
		ec_obj = `None`,
		handle = `None`,
		args,
		kwargs
	)

Constructor.

@param ec_obj The CORBA ExecutionContext object to wrap.
@param handle The handle of this execution context, which can be used
      to uniquely identify it.

Definition at line 32 of file exec_context.py.

Member Function Documentation

def rtctree.exec_context.ExecutionContext._parse ( self ) [private]

Definition at line 224 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.activate_component	(	self,
		comp_ref
	)

Activate a component within this context.

@param comp_ref The CORBA LightweightRTObject to activate.

Definition at line 51 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.deactivate_component	(	self,
		comp_ref
	)

Deactivate a component within this context.

@param comp_ref The CORBA LightweightRTObject to deactivate.

Definition at line 60 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.get_component_state	(	self,
		comp
	)

Get the state of a component within this context.

@param comp The CORBA LightweightRTObject to get the state of.
@return The component state, as a LifeCycleState value.

Definition at line 78 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.handle ( self )

The handle of this execution context.

Definition at line 146 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.kind ( self )

The kind of this execution context.

Definition at line 152 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.kind_as_string	(	self,
		add_colour = `True`
	)

Get the type of this context as an optionally coloured string.

@param add_colour If True, ANSI colour codes will be added.
@return A string describing the kind of execution context this is.

Definition at line 88 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.kind_string ( self )

The kind of this execution context as a coloured string.

Definition at line 164 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.owner ( self )

The RTObject that owns this context.

Definition at line 169 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.owner_name ( self )

The name of the RTObject that owns this context.

Definition at line 175 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.participant_names ( self )

The names of the RTObjects participating in this context.

Definition at line 190 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.participants ( self )

The list of RTObjects participating in this context.

Definition at line 184 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.properties ( self )

The execution context's extra properties dictionary.

Definition at line 197 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.rate ( self )

The execution rate of this execution context.

Definition at line 203 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.rate	(	self,
		new_rate
	)

Definition at line 209 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.reparse ( self )

Reparse this execution context.

This causes the execution context's state, profile and other
information to be reloaded from the remote object.

Definition at line 108 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.reset_component	(	self,
		comp_ref
	)

Reset a component within this context.

@param comp_ref The CORBA LightweightRTObject to reset.

Definition at line 69 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.running ( self )

Is this execution context running?

Definition at line 214 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.running_as_string	(	self,
		add_colour = `True`
	)

Get the state of this context as an optionally coloured string.

@param add_colour If True, ANSI colour codes will be added.
@return A string describing this context's running state.

Definition at line 117 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.running_string ( self )

The state of this execution context as a coloured string.

Definition at line 220 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.start ( self )

Start the context.

Definition at line 135 of file exec_context.py.

def rtctree.exec_context.ExecutionContext.stop ( self )

Stop the context.

Definition at line 140 of file exec_context.py.

Member Data Documentation

rtctree::exec_context.ExecutionContext::_handle [private]

Definition at line 38 of file exec_context.py.

rtctree::exec_context.ExecutionContext::_is_service [private]

Definition at line 38 of file exec_context.py.

rtctree::exec_context.ExecutionContext::_mutex [private]

Definition at line 38 of file exec_context.py.

rtctree::exec_context.ExecutionContext::_obj [private]

Definition at line 38 of file exec_context.py.

rtctree::exec_context.ExecutionContext::_owner [private]

Definition at line 224 of file exec_context.py.

rtctree::exec_context.ExecutionContext::_participants [private]

Definition at line 224 of file exec_context.py.

rtctree::exec_context.ExecutionContext::_properties [private]

Definition at line 224 of file exec_context.py.

int rtctree::exec_context.ExecutionContext::EVENT_DRIVEN = 2 [static]

Constant for an event driven execution context.

Definition at line 240 of file exec_context.py.

rtctree::exec_context.ExecutionContext::kind

Definition at line 93 of file exec_context.py.

int rtctree::exec_context.ExecutionContext::OTHER = 3 [static]

Constant for an execution context of some other type.

Definition at line 242 of file exec_context.py.

int rtctree::exec_context.ExecutionContext::PERIODIC = 1 [static]

Constant for a periodic execution context.

Definition at line 238 of file exec_context.py.

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

exec_context.py

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation