Documentation ¶
Index ¶
- Constants
- Variables
- func CloneStateSlice(dst, src []State)
- func CloneTransitionDescriptionSlice(dst, src []TransitionDescription)
- func CloneTransitionEventSlice(dst, src []TransitionEvent)
- func CloneTransitionSlice(dst, src []Transition)
- func State__Array_to_C(cSlice []CState, goSlice []State)
- func State__Array_to_Go(goSlice []State, cSlice []CState)
- func State__Sequence_to_C(cSlice *CState__Sequence, goSlice []State)
- func State__Sequence_to_Go(goSlice *[]State, cSlice CState__Sequence)
- func TransitionDescription__Array_to_C(cSlice []CTransitionDescription, goSlice []TransitionDescription)
- func TransitionDescription__Array_to_Go(goSlice []TransitionDescription, cSlice []CTransitionDescription)
- func TransitionDescription__Sequence_to_C(cSlice *CTransitionDescription__Sequence, goSlice []TransitionDescription)
- func TransitionDescription__Sequence_to_Go(goSlice *[]TransitionDescription, cSlice CTransitionDescription__Sequence)
- func TransitionEvent__Array_to_C(cSlice []CTransitionEvent, goSlice []TransitionEvent)
- func TransitionEvent__Array_to_Go(goSlice []TransitionEvent, cSlice []CTransitionEvent)
- func TransitionEvent__Sequence_to_C(cSlice *CTransitionEvent__Sequence, goSlice []TransitionEvent)
- func TransitionEvent__Sequence_to_Go(goSlice *[]TransitionEvent, cSlice CTransitionEvent__Sequence)
- func Transition__Array_to_C(cSlice []CTransition, goSlice []Transition)
- func Transition__Array_to_Go(goSlice []Transition, cSlice []CTransition)
- func Transition__Sequence_to_C(cSlice *CTransition__Sequence, goSlice []Transition)
- func Transition__Sequence_to_Go(goSlice *[]Transition, cSlice CTransition__Sequence)
- type CState
- type CState__Sequence
- type CTransition
- type CTransitionDescription
- type CTransitionDescription__Sequence
- type CTransitionEvent
- type CTransitionEvent__Sequence
- type CTransition__Sequence
- type State
- type Transition
- type TransitionDescription
- type TransitionEvent
Constants ¶
const ( State_PRIMARY_STATE_UNKNOWN uint8 = 0 // Indicates state has not yet been set. State_PRIMARY_STATE_UNCONFIGURED uint8 = 1 // This is the life cycle state the node is in immediately after beinginstantiated. State_PRIMARY_STATE_INACTIVE uint8 = 2 // This state represents a node that is not currently performing any processing. State_PRIMARY_STATE_ACTIVE uint8 = 3 // This is the main state of the node’s life cycle. While in this state, the nodeperforms any processing, responds to service requests, reads and processesdata, produces output, etc. State_PRIMARY_STATE_FINALIZED uint8 = 4 // The finalized state is the state in which the node ends immediately beforebeing destroyed. State_TRANSITION_STATE_CONFIGURING uint8 = 10 // In this transition state the node’s onConfigure callback will be called toallow the node to load its configuration and conduct any required setup. State_TRANSITION_STATE_CLEANINGUP uint8 = 11 // In this transition state the node’s callback onCleanup will be called to clearall state and return the node to a functionally equivalent state as whenfirst created. State_TRANSITION_STATE_SHUTTINGDOWN uint8 = 12 // In this transition state the callback onShutdown will be executed to do anycleanup necessary before destruction. State_TRANSITION_STATE_ACTIVATING uint8 = 13 // In this transition state the callback onActivate will be executed to do anyfinal preparations to start executing. State_TRANSITION_STATE_DEACTIVATING uint8 = 14 // In this transition state the callback onDeactivate will be executed to do anycleanup to start executing, and reverse the onActivate changes. State_TRANSITION_STATE_ERRORPROCESSING uint8 = 15 // This transition state is where any error may be cleaned up. )
const ( Transition_TRANSITION_CREATE uint8 = 0 // This transition will instantiate the node, but will not run any code beyondthe constructor. Transition_TRANSITION_CONFIGURE uint8 = 1 // The node’s onConfigure callback will be called to allow the node to load itsconfiguration and conduct any required setup. Transition_TRANSITION_CLEANUP uint8 = 2 // The node’s callback onCleanup will be called in this transition to allow thenode to load its configuration and conduct any required setup. Transition_TRANSITION_ACTIVATE uint8 = 3 // The node's callback onActivate will be executed to do any final preparationsto start executing. Transition_TRANSITION_DEACTIVATE uint8 = 4 // The node's callback onDeactivate will be executed to do any cleanup to startexecuting, and reverse the onActivate changes. Transition_TRANSITION_UNCONFIGURED_SHUTDOWN uint8 = 5 // This signals shutdown during an unconfigured state, the node's callbackonShutdown will be executed to do any cleanup necessary before destruction. Transition_TRANSITION_INACTIVE_SHUTDOWN uint8 = 6 // This signals shutdown during an inactive state, the node's callback onShutdownwill be executed to do any cleanup necessary before destruction. Transition_TRANSITION_ACTIVE_SHUTDOWN uint8 = 7 // This signals shutdown during an active state, the node's callback onShutdownwill be executed to do any cleanup necessary before destruction. Transition_TRANSITION_DESTROY uint8 = 8 // This transition will simply cause the deallocation of the node. Transition_TRANSITION_ON_CONFIGURE_SUCCESS uint8 = 10 // Reserved [10-69], private transitionsThese transitions are not publicly available and cannot be invoked by a user.The following transitions are implicitly invoked based on the callbackfeedback of the intermediate transition states. Transition_TRANSITION_ON_CONFIGURE_FAILURE uint8 = 11 // Reserved [10-69], private transitionsThese transitions are not publicly available and cannot be invoked by a user.The following transitions are implicitly invoked based on the callbackfeedback of the intermediate transition states. Transition_TRANSITION_ON_CONFIGURE_ERROR uint8 = 12 // Reserved [10-69], private transitionsThese transitions are not publicly available and cannot be invoked by a user.The following transitions are implicitly invoked based on the callbackfeedback of the intermediate transition states. Transition_TRANSITION_ON_CLEANUP_SUCCESS uint8 = 20 Transition_TRANSITION_ON_CLEANUP_FAILURE uint8 = 21 Transition_TRANSITION_ON_CLEANUP_ERROR uint8 = 22 Transition_TRANSITION_ON_ACTIVATE_SUCCESS uint8 = 30 Transition_TRANSITION_ON_ACTIVATE_FAILURE uint8 = 31 Transition_TRANSITION_ON_ACTIVATE_ERROR uint8 = 32 Transition_TRANSITION_ON_DEACTIVATE_SUCCESS uint8 = 40 Transition_TRANSITION_ON_DEACTIVATE_FAILURE uint8 = 41 Transition_TRANSITION_ON_DEACTIVATE_ERROR uint8 = 42 Transition_TRANSITION_ON_SHUTDOWN_SUCCESS uint8 = 50 Transition_TRANSITION_ON_SHUTDOWN_FAILURE uint8 = 51 Transition_TRANSITION_ON_SHUTDOWN_ERROR uint8 = 52 Transition_TRANSITION_ON_ERROR_SUCCESS uint8 = 60 Transition_TRANSITION_ON_ERROR_FAILURE uint8 = 61 Transition_TRANSITION_ON_ERROR_ERROR uint8 = 62 Transition_TRANSITION_CALLBACK_SUCCESS uint8 = 97 // The transition callback successfully performed its required functionality. Transition_TRANSITION_CALLBACK_FAILURE uint8 = 98 // The transition callback failed to perform its required functionality. Transition_TRANSITION_CALLBACK_ERROR uint8 = 99 // The transition callback encountered an error that requires special cleanup, ifpossible. )
Variables ¶
var StateTypeSupport types.MessageTypeSupport = _StateTypeSupport{}
Modifying this variable is undefined behavior.
var TransitionDescriptionTypeSupport types.MessageTypeSupport = _TransitionDescriptionTypeSupport{}
Modifying this variable is undefined behavior.
var TransitionEventTypeSupport types.MessageTypeSupport = _TransitionEventTypeSupport{}
Modifying this variable is undefined behavior.
var TransitionTypeSupport types.MessageTypeSupport = _TransitionTypeSupport{}
Modifying this variable is undefined behavior.
Functions ¶
func CloneStateSlice ¶
func CloneStateSlice(dst, src []State)
CloneStateSlice clones src to dst by calling Clone for each element in src. Panics if len(dst) < len(src).
func CloneTransitionDescriptionSlice ¶
func CloneTransitionDescriptionSlice(dst, src []TransitionDescription)
CloneTransitionDescriptionSlice clones src to dst by calling Clone for each element in src. Panics if len(dst) < len(src).
func CloneTransitionEventSlice ¶
func CloneTransitionEventSlice(dst, src []TransitionEvent)
CloneTransitionEventSlice clones src to dst by calling Clone for each element in src. Panics if len(dst) < len(src).
func CloneTransitionSlice ¶
func CloneTransitionSlice(dst, src []Transition)
CloneTransitionSlice clones src to dst by calling Clone for each element in src. Panics if len(dst) < len(src).
func State__Array_to_C ¶
func State__Array_to_Go ¶
func State__Sequence_to_C ¶
func State__Sequence_to_C(cSlice *CState__Sequence, goSlice []State)
func State__Sequence_to_Go ¶
func State__Sequence_to_Go(goSlice *[]State, cSlice CState__Sequence)
func TransitionDescription__Array_to_C ¶
func TransitionDescription__Array_to_C(cSlice []CTransitionDescription, goSlice []TransitionDescription)
func TransitionDescription__Array_to_Go ¶
func TransitionDescription__Array_to_Go(goSlice []TransitionDescription, cSlice []CTransitionDescription)
func TransitionDescription__Sequence_to_C ¶
func TransitionDescription__Sequence_to_C(cSlice *CTransitionDescription__Sequence, goSlice []TransitionDescription)
func TransitionDescription__Sequence_to_Go ¶
func TransitionDescription__Sequence_to_Go(goSlice *[]TransitionDescription, cSlice CTransitionDescription__Sequence)
func TransitionEvent__Array_to_C ¶
func TransitionEvent__Array_to_C(cSlice []CTransitionEvent, goSlice []TransitionEvent)
func TransitionEvent__Array_to_Go ¶
func TransitionEvent__Array_to_Go(goSlice []TransitionEvent, cSlice []CTransitionEvent)
func TransitionEvent__Sequence_to_C ¶
func TransitionEvent__Sequence_to_C(cSlice *CTransitionEvent__Sequence, goSlice []TransitionEvent)
func TransitionEvent__Sequence_to_Go ¶
func TransitionEvent__Sequence_to_Go(goSlice *[]TransitionEvent, cSlice CTransitionEvent__Sequence)
func Transition__Array_to_C ¶
func Transition__Array_to_C(cSlice []CTransition, goSlice []Transition)
func Transition__Array_to_Go ¶
func Transition__Array_to_Go(goSlice []Transition, cSlice []CTransition)
func Transition__Sequence_to_C ¶
func Transition__Sequence_to_C(cSlice *CTransition__Sequence, goSlice []Transition)
func Transition__Sequence_to_Go ¶
func Transition__Sequence_to_Go(goSlice *[]Transition, cSlice CTransition__Sequence)
Types ¶
type CState ¶
type CState = C.lifecycle_msgs__msg__State
type CState__Sequence ¶
type CState__Sequence = C.lifecycle_msgs__msg__State__Sequence
type CTransition ¶
type CTransition = C.lifecycle_msgs__msg__Transition
type CTransitionDescription ¶
type CTransitionDescription = C.lifecycle_msgs__msg__TransitionDescription
type CTransitionDescription__Sequence ¶
type CTransitionDescription__Sequence = C.lifecycle_msgs__msg__TransitionDescription__Sequence
type CTransitionEvent ¶
type CTransitionEvent = C.lifecycle_msgs__msg__TransitionEvent
type CTransitionEvent__Sequence ¶
type CTransitionEvent__Sequence = C.lifecycle_msgs__msg__TransitionEvent__Sequence
type CTransition__Sequence ¶
type CTransition__Sequence = C.lifecycle_msgs__msg__Transition__Sequence
type State ¶
type State struct { Id uint8 `yaml:"id"` // The state id value from the above definitions. Label string `yaml:"label"` // A text label of the state. }
Do not create instances of this type directly. Always use NewState function instead.
func (*State) SetDefaults ¶
func (t *State) SetDefaults()
type Transition ¶
type Transition struct { Id uint8 `yaml:"id"` // The transition id from above definitions. Label string `yaml:"label"` // A text label of the transition. }
Do not create instances of this type directly. Always use NewTransition function instead.
func NewTransition ¶
func NewTransition() *Transition
NewTransition creates a new Transition with default values.
func (*Transition) Clone ¶
func (t *Transition) Clone() *Transition
func (*Transition) CloneMsg ¶
func (t *Transition) CloneMsg() types.Message
func (*Transition) SetDefaults ¶
func (t *Transition) SetDefaults()
type TransitionDescription ¶
type TransitionDescription struct { Transition Transition `yaml:"transition"` // The transition id and label of this description. StartState State `yaml:"start_state"` // The current state from which this transition transitions. GoalState State `yaml:"goal_state"` // The desired target state of this transition. }
Do not create instances of this type directly. Always use NewTransitionDescription function instead.
func NewTransitionDescription ¶
func NewTransitionDescription() *TransitionDescription
NewTransitionDescription creates a new TransitionDescription with default values.
func (*TransitionDescription) Clone ¶
func (t *TransitionDescription) Clone() *TransitionDescription
func (*TransitionDescription) CloneMsg ¶
func (t *TransitionDescription) CloneMsg() types.Message
func (*TransitionDescription) SetDefaults ¶
func (t *TransitionDescription) SetDefaults()
type TransitionEvent ¶
type TransitionEvent struct { Timestamp uint64 `yaml:"timestamp"` // The time point at which this event occurred. Transition Transition `yaml:"transition"` // The id and label of this transition event. StartState State `yaml:"start_state"` // The starting state from which this event transitioned. GoalState State `yaml:"goal_state"` // The end state of this transition event. }
Do not create instances of this type directly. Always use NewTransitionEvent function instead.
func NewTransitionEvent ¶
func NewTransitionEvent() *TransitionEvent
NewTransitionEvent creates a new TransitionEvent with default values.
func (*TransitionEvent) Clone ¶
func (t *TransitionEvent) Clone() *TransitionEvent
func (*TransitionEvent) CloneMsg ¶
func (t *TransitionEvent) CloneMsg() types.Message
func (*TransitionEvent) SetDefaults ¶
func (t *TransitionEvent) SetDefaults()