RTT::corba::CTaskContext Interface Reference

A CTaskContext is the main entry point of a distributed component and maps to a RTT::TaskContext. More...

import"rtt/transports/corba/TaskContext.idl";

Public Types
typedef sequence< string >	CPeerNames

Public Member Functions
string	getName ()
	Return the instance name of this component. More...
string	getDescription ()
	Return the description of this component. More...
CTaskContextDescription	getCTaskContextDescription ()
	Return the full description of this component with all TaskContext objects. More...
CDataFlowInterface	ports ()
	Access to the Data Flow ports. More...
boolean	connectPeers (in CTaskContext p)
	Create a two-way peer connection. More...
boolean	disconnectPeers (in string name)
	Destroy a two-way peer connection. More...
boolean	connectPorts (in CTaskContext p)
	Connect all compatible and equally named data ports with another CTaskContext's data ports. More...
boolean	connectServices (in CTaskContext p)
	Connect all compatible and equally named services with another CTaskContext's services. More...
TaskContext life-cycle
CTaskState	getTaskState ()
	Returns the current state of the component. More...
boolean	configure ()
	Configure this component. More...
boolean	start ()
	Start this component. More...
boolean	activate ()
	Activate this component. More...
boolean	stop ()
	Stop this component. More...
boolean	recover ()
	Recover this component. More...
boolean	resetException ()
	Asks the component to transition from an Exception state to the Stopped state. More...
boolean	cleanup ()
	Cleanup this component. More...
boolean	isActive ()
	Is this component's ExecutionEngine active ? More...
boolean	isRunning ()
	Is this component running ? More...
boolean	isConfigured ()
	Is this component configured ? More...
boolean	inFatalError ()
	Is this component in a Fatal error state ? More...
boolean	inRunTimeError ()
	Is this component in a RunTime error state ? More...
boolean	inException ()
	Is this component in an Exception error state ? More...
CTaskContext services
CService	getProvider (in string service_name)
	Get a service. More...
CServiceRequester	getRequester (in string service_name)
	Get a required service. More...
CTaskContext Browsing functions.
CPeerNames	getPeerList ()
	Get a list of all the peers this task is connected to. More...
CTaskContext	getPeer (in string name)
	Get a peer this task is connected to. More...
boolean	hasPeer (in string name)
	Has this task a peer with given name ? More...
boolean	addPeer (in CTaskContext p, in string peer_alias)
	Add a one-way peer connection. More...
boolean	removePeer (in string name)
	Remove a one-way peer connection. More...

Detailed Description

A CTaskContext is the main entry point of a distributed component and maps to a RTT::TaskContext.

Definition at line 45 of file TaskContext.idl.

Member Typedef Documentation

typedef sequence<string> RTT::corba::CTaskContext::CPeerNames

Definition at line 47 of file TaskContext.idl.

Member Function Documentation

boolean RTT::corba::CTaskContext::activate

(

)

Activate this component.

See also

RTT::base::TaskCore::activate()

boolean RTT::corba::CTaskContext::addPeer	(	in CTaskContext	p,
		in string	peer_alias
	)

Add a one-way peer connection.

See also

RTT::TaskContext::addPeer()

boolean RTT::corba::CTaskContext::cleanup

(

)

Cleanup this component.

See also

RTT::base::TaskCore::cleanup()

boolean RTT::corba::CTaskContext::configure

(

)

Configure this component.

See also

RTT::base::TaskCore::configure()

boolean RTT::corba::CTaskContext::connectPeers

(

in CTaskContext

p

)

Create a two-way peer connection.

See also

RTT::TaskContext::connectPeers()

boolean RTT::corba::CTaskContext::connectPorts

(

in CTaskContext

p

)

Connect all compatible and equally named data ports with another CTaskContext's data ports.

See also

RTT::TaskContext::connectPorts()

boolean RTT::corba::CTaskContext::connectServices

(

in CTaskContext

p

)

Connect all compatible and equally named services with another CTaskContext's services.

See also

RTT::TaskContext::connectServices()

boolean RTT::corba::CTaskContext::disconnectPeers

(

in string

name

)

Destroy a two-way peer connection.

See also

RTT::TaskContext::disconnectPeers()

CTaskContextDescription RTT::corba::CTaskContext::getCTaskContextDescription

(

)

Return the full description of this component with all TaskContext objects.

string RTT::corba::CTaskContext::getDescription

(

)

Return the description of this component.

string RTT::corba::CTaskContext::getName

(

)

Return the instance name of this component.

CTaskContext RTT::corba::CTaskContext::getPeer

(

in string

name

)

Get a peer this task is connected to.

See also

RTT::TaskContext::getPeer()

CPeerNames RTT::corba::CTaskContext::getPeerList

(

)

Get a list of all the peers this task is connected to.

See also

RTT::TaskContext::getPeerList()

CService RTT::corba::CTaskContext::getProvider

(

in string

service_name

)

Get a service.

Use 'this' as the name to get the task context's own service provider

See also

RTT::TaskContext::provides()

CServiceRequester RTT::corba::CTaskContext::getRequester

(

in string

service_name

)

Get a required service.

See also

RTT::TaskContext::requires()

CTaskState RTT::corba::CTaskContext::getTaskState

(

)

Returns the current state of the component.

boolean RTT::corba::CTaskContext::hasPeer

(

in string

name

)

Has this task a peer with given name ?

See also

RTT::TaskContext::hasPeer()

boolean RTT::corba::CTaskContext::inException

(

)

Is this component in an Exception error state ?

See also

RTT::base::TaskCore::inException()

boolean RTT::corba::CTaskContext::inFatalError

(

)

Is this component in a Fatal error state ?

See also

RTT::base::TaskCore::inFatalError()

boolean RTT::corba::CTaskContext::inRunTimeError

(

)

Is this component in a RunTime error state ?

See also

RTT::base::TaskCore::inRunTimeError()

boolean RTT::corba::CTaskContext::isActive

(

)

Is this component's ExecutionEngine active ?

See also

RTT::base::TaskCore::isActive()

boolean RTT::corba::CTaskContext::isConfigured

(

)

Is this component configured ?

See also

RTT::base::TaskCore::isConfigured()

boolean RTT::corba::CTaskContext::isRunning

(

)

Is this component running ?

See also

RTT::base::TaskCore::isRunning()

CDataFlowInterface RTT::corba::CTaskContext::ports

(

)

Access to the Data Flow ports.

See also

RTT::base::TaskCore::ports()

boolean RTT::corba::CTaskContext::recover

(

)

Recover this component.

See also

RTT::base::TaskCore::recover()

boolean RTT::corba::CTaskContext::removePeer

(

in string

name

)

Remove a one-way peer connection.

See also

RTT::TaskContext::removePeer()

boolean RTT::corba::CTaskContext::resetException

(

)

Asks the component to transition from an Exception state to the Stopped state.

See also

RTT::base::TaskCore::exception() and RTT::base::TaskCore::recover()

boolean RTT::corba::CTaskContext::start

(

)

Start this component.

See also

RTT::base::TaskCore::start()

boolean RTT::corba::CTaskContext::stop

(

)

Stop this component.

See also

RTT::base::TaskCore::stop()

---

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

• rtt/transports/corba/TaskContext.idl