OpenRTM-aist IDL 2.1.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
RTC::ExecutionContext Interface Reference

ExecutionContext. More...

import <RTC.idl;

Inheritance diagram for RTC::ExecutionContext:
Inheritance graph
[legend]

Public Member Functions

boolean is_running ()
 is_running
 
ReturnCode_t start ()
 start
 
ReturnCode_t stop ()
 stop
 
double get_rate ()
 get_rate
 
ReturnCode_t set_rate (in double rate)
 set_rate
 
ReturnCode_t add_component (in LightweightRTObject comp)
 add_component
 
ReturnCode_t remove_component (in LightweightRTObject comp)
 remove_component
 
ReturnCode_t activate_component (in LightweightRTObject comp)
 activate_component
 
ReturnCode_t deactivate_component (in LightweightRTObject comp)
 deactivate_component
 
ReturnCode_t reset_component (in LightweightRTObject comp)
 reset_component
 
LifeCycleState get_component_state (in LightweightRTObject comp)
 get_component_state
 
ExecutionKind get_kind ()
 get_kind
 

Detailed Description

ExecutionContext.

Member Function Documentation

◆ activate_component()

ReturnCode_t RTC::ExecutionContext::activate_component ( in LightweightRTObject  comp)

activate_component

◆ add_component()

ReturnCode_t RTC::ExecutionContext::add_component ( in LightweightRTObject  comp)

add_component

◆ deactivate_component()

ReturnCode_t RTC::ExecutionContext::deactivate_component ( in LightweightRTObject  comp)

deactivate_component

◆ get_component_state()

LifeCycleState RTC::ExecutionContext::get_component_state ( in LightweightRTObject  comp)

get_component_state

◆ get_kind()

ExecutionKind RTC::ExecutionContext::get_kind ( )

get_kind

◆ get_rate()

double RTC::ExecutionContext::get_rate ( )

get_rate

◆ is_running()

boolean RTC::ExecutionContext::is_running ( )

is_running

◆ remove_component()

ReturnCode_t RTC::ExecutionContext::remove_component ( in LightweightRTObject  comp)

remove_component

◆ reset_component()

ReturnCode_t RTC::ExecutionContext::reset_component ( in LightweightRTObject  comp)

reset_component

◆ set_rate()

ReturnCode_t RTC::ExecutionContext::set_rate ( in double  rate)

set_rate

◆ start()

ReturnCode_t RTC::ExecutionContext::start ( )

start

Description

Request that the context enter the Running state. Once the state transition occurs, the ComponentAction::on_startup operation (see Section 5.2.2.4.3) will be invoked.

Description

Semantics

An execution context may not be started until the RT components that participate in it have been initialized. An execution context may be started and stopped multiple times.

Constraints

◆ stop()

ReturnCode_t RTC::ExecutionContext::stop ( )

stop


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