Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 2.79 KB

SequenceTaskHandle.md

File metadata and controls

25 lines (19 loc) · 2.79 KB

class SequenceTaskHandle

Member values

Member name Data type Description
sequence_handle SequenceHandle Sequence handle
task_index uint32 Task index inside the sequence

Member functions

Function name Return type Input type Description
has_sequence_handle() const bool void Returns true if sequence_handle is set.
sequence_handle() const SequenceHandle& void Returns the current value of sequence_handle. If sequence_handle is not set, returns a SequenceHandle with none of its fields set (possibly sequence_handle::default_instance()).
mutable_sequence_handle() SequenceHandle * void Returns a pointer to the mutable SequenceHandle object that stores the field's value. If the field was not set prior to the call, then the returned SequenceHandle will have none of its fields set (i.e. it will be identical to a newly-allocated SequenceHandle). After calling this, has_sequence_handle() will return true and sequence_handle() will return a reference to the same instance of SequenceHandle.
clear_sequence_handle() void void Clears the value of the field. After calling this, has_sequence_handle() will return false and sequence_handle() will return the default value.
set_allocated_sequence_handle() void SequenceHandle * Sets the SequenceHandle object to the field and frees the previous field value if it exists. If the SequenceHandle pointer is not NULL, the message takes ownership of the allocated SequenceHandle object and has_ SequenceHandle() will return true. Otherwise, if the sequence_handle is NULL, the behavior is the same as calling clear_sequence_handle().
release_sequence_handle() SequenceHandle * void Releases the ownership of the field and returns the pointer of the SequenceHandle object. After calling this, caller takes the ownership of the allocated SequenceHandle object, has_sequence_handle() will return false, and sequence_handle() will return the default value.
task_index() uint32 void Returns the current value of task_index. If the task_index is not set, returns 0.
set_task_index() void uint32 Sets the value of task_index. After calling this, task_index() will return value.
clear_task_index() void void Clears the value of task_index. After calling this, task_index() will return 0.

Parent topic: Base (C++)