Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 4.69 KB

SequenceTaskConfiguration.md

File metadata and controls

28 lines (22 loc) · 4.69 KB

class SequenceTaskConfiguration

Member values

Member name Data type Description
sequence_task_handle SequenceTaskHandle Sequence Handle and index of task to update
sequence_task SequenceTask Configuration information on task to be updated

Member functions

Function name Return type Input type Description
has_sequence_task_handle() const bool void Returns true if sequence_task_handle is set.
sequence_task_handle() const SequenceTaskHandle& void Returns the current value of sequence_task_handle. If sequence_task_handle is not set, returns a SequenceTaskHandle with none of its fields set (possibly sequence_task_handle::default_instance()).
mutable_sequence_task_handle() SequenceTaskHandle * void Returns a pointer to the mutable SequenceTaskHandle object that stores the field's value. If the field was not set prior to the call, then the returned SequenceTaskHandle will have none of its fields set (i.e. it will be identical to a newly-allocated SequenceTaskHandle). After calling this, has_sequence_task_handle() will return true and sequence_task_handle() will return a reference to the same instance of SequenceTaskHandle.
clear_sequence_task_handle() void void Clears the value of the field. After calling this, has_sequence_task_handle() will return false and sequence_task_handle() will return the default value.
set_allocated_sequence_task_handle() void SequenceTaskHandle * Sets the SequenceTaskHandle object to the field and frees the previous field value if it exists. If the SequenceTaskHandle pointer is not NULL, the message takes ownership of the allocated SequenceTaskHandle object and has_ SequenceTaskHandle() will return true. Otherwise, if the sequence_task_handle is NULL, the behavior is the same as calling clear_sequence_task_handle().
release_sequence_task_handle() SequenceTaskHandle * void Releases the ownership of the field and returns the pointer of the SequenceTaskHandle object. After calling this, caller takes the ownership of the allocated SequenceTaskHandle object, has_sequence_task_handle() will return false, and sequence_task_handle() will return the default value.
has_sequence_task() const bool void Returns true if sequence_task is set.
sequence_task() const SequenceTask& void Returns the current value of sequence_task. If sequence_task is not set, returns a SequenceTask with none of its fields set (possibly sequence_task::default_instance()).
mutable_sequence_task() SequenceTask * void Returns a pointer to the mutable SequenceTask object that stores the field's value. If the field was not set prior to the call, then the returned SequenceTask will have none of its fields set (i.e. it will be identical to a newly-allocated SequenceTask). After calling this, has_sequence_task() will return true and sequence_task() will return a reference to the same instance of SequenceTask.
clear_sequence_task() void void Clears the value of the field. After calling this, has_sequence_task() will return false and sequence_task() will return the default value.
set_allocated_sequence_task() void SequenceTask * Sets the SequenceTask object to the field and frees the previous field value if it exists. If the SequenceTask pointer is not NULL, the message takes ownership of the allocated SequenceTask object and has_ SequenceTask() will return true. Otherwise, if the sequence_task is NULL, the behavior is the same as calling clear_sequence_task().
release_sequence_task() SequenceTask * void Releases the ownership of the field and returns the pointer of the SequenceTask object. After calling this, caller takes the ownership of the allocated SequenceTask object, has_sequence_task() will return false, and sequence_task() will return the default value.

Parent topic: Base (C++)