class SequenceTasksConfiguration

February 26, 2020 ยท View on GitHub

Member values

Member nameData typeDescription
sequence_task_handleSequenceTaskHandleSequence Handle and task index as the insertion point
sequence_tasksSequenceTaskTasks to be inserted

Member functions

Function nameReturn typeInput typeDescription
has_sequence_task_handle() constboolvoidReturns true if sequence_task_handle is set.
sequence_task_handle()const SequenceTaskHandle&voidReturns 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 *voidReturns 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()voidvoidClears 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()voidSequenceTaskHandle *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 *voidReleases 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.
sequence_tasks_size() constintvoidReturns the number of elements currently in the field.
sequence_tasks() constconst SequenceTaskint indexReturns the element at the given zero-based index. Calling this method with index outside of [0, sequence_tasks_size()) yields undefined behavior.
mutable_sequence_tasks()SequenceTask*int indexReturns a pointer to the mutable SequenceTask object that stores the value of the element at the given zero-based index. Calling this method with index outside of [0, sequence_tasks_size()) yields undefined behavior.
add_sequence_tasks()SequenceTask*voidAdds a new element and returns a pointer to it. The returned SequenceTask is mutable and will have none of its fields set (i.e. it will be identical to a newly-allocated SequenceTask).
clear_sequence_tasks()voidvoidRemoves all elements from the field. After calling this, sequence_tasks_size() will return zero.
sequence_tasks() constconst RepeatedPtrField< SequenceTask>&voidReturns the underlying RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods.
mutable_sequence_tasks()RepeatedPtrField< SequenceTask>*voidReturns a pointer to the underlying mutable RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods.

Parent topic: Base (C++)