Public Member Functions |
ComponentProfile | get_component_profile () |
| get_component_profile
|
PortServiceList | get_ports () |
| get_ports
|
ReturnCode_t | initialize () |
| initialize
|
ReturnCode_t | finalize () |
| finalize
|
boolean | is_alive (in ExecutionContext exec_context) |
| is_alive
|
ReturnCode_t | exit () |
| exit
|
ExecutionContextHandle_t | attach_context (in ExecutionContext exec_context) |
| attach_context
|
ReturnCode_t | detach_context (in ExecutionContextHandle_t exec_handle) |
| detach_context
|
ExecutionContext | get_context (in ExecutionContextHandle_t exec_handle) |
| get_context
|
ExecutionContextList | get_owned_contexts () |
| get_owned_contexts
|
ExecutionContextList | get_participating_contexts () |
|
- get_participating_contexts
|
ExecutionContextHandle_t | get_context_handle (in ExecutionContext cxt) |
| get_context_handle
|
ReturnCode_t | on_initialize () |
| on_initialize
|
ReturnCode_t | on_finalize () |
| on_finalize
|
ReturnCode_t | on_startup (in ExecutionContextHandle_t exec_handle) |
| on_startup
|
ReturnCode_t | on_shutdown (in ExecutionContextHandle_t exec_handle) |
| on_shutdown
|
ReturnCode_t | on_activated (in ExecutionContextHandle_t exec_handle) |
| on_activated
|
ReturnCode_t | on_deactivated (in ExecutionContextHandle_t exec_handle) |
| on_deactivated
|
ReturnCode_t | on_aborting (in ExecutionContextHandle_t exec_handle) |
| on_aborting
|
ReturnCode_t | on_error (in ExecutionContextHandle_t exec_handle) |
| on_error
|
ReturnCode_t | on_reset (in ExecutionContextHandle_t exec_handle) |
| on_reset
|
UniqueIdentifier | get_sdo_id () raises (NotAvailable, InternalError) |
string | get_sdo_type () raises (NotAvailable, InternalError) |
DeviceProfile | get_device_profile () raises (NotAvailable, InternalError) |
ServiceProfileList | get_service_profiles () raises (NotAvailable, InternalError) |
ServiceProfile | get_service_profile (in UniqueIdentifier id) raises (InvalidParameter, NotAvailable, InternalError) |
SDOService | get_sdo_service (in UniqueIdentifier id) raises (InvalidParameter, NotAvailable, InternalError) |
Configuration | get_configuration () raises (InterfaceNotImplemented, NotAvailable, InternalError) |
Monitoring | get_monitoring () raises (InterfaceNotImplemented, NotAvailable, InternalError) |
OrganizationList | get_organizations () raises (NotAvailable, InternalError) |
NVList | get_status_list () raises (NotAvailable, InternalError) |
any | get_status (in string nme) raises (InvalidParameter, NotAvailable, InternalError) |
OrganizationList | get_owned_organizations () raises (NotAvailable,InternalError) |
RTObject.
Description
The RTObject interface defines the operations that all SDO-based RTCs must provide. It is required by the rtComponent stereotype.
exit
Description
Stop the RTC¡Çs execution context(s) and finalize it along with its contents.
Semantics
Any execution contexts for which the RTC is the owner shall be stopped. If the RTC participates in any execution contexts belonging to another RTC that contains it, directly or indirectly (i.e., the containing RTC is the owner of the ExecutionContext), it shall be deactivated in those contexts. After the RTC is no longer Active in any Running execution context, it and any RTCs contained transitively within it shall be finalized.
Constraints
An RTC cannot be exited if it has not yet been initialized. Any attempt to exit an RTC that is in the Created state shall fail with ReturnCode_t::PRECONDITION_NOT_MET.
is_alive
Description
A component is alive or not regardless of the execution context from which it is observed. However, whether or not it is Active, Inactive, or in Error is dependent on the execution context(s) (see Figure 5.7) in which it is running. That is, it may be Active in one context but Inactive in another. Therefore, this operation shall report whether this RTC is either Active, Inactive, or in Error; which of those states a component is in with respect to a particular context may be queried from the context itself.