Member values
| Member name | Data type | Description |
|---|---|---|
| handle | SequenceHandle | Sequence handle |
| in_loop | bool |
Member functions
| Function name | Return type | Input type | Description |
|---|---|---|---|
| has_handle() const | bool | void | Returns true if handle is set. |
| handle() | const SequenceHandle& | void | Returns the current value of handle. If handle is not set, returns a SequenceHandle with none of its fields set (possibly handle::default_instance()). |
| mutable_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_handle() will return true and handle() will return a reference to the same instance of SequenceHandle. |
| clear_handle() | void | void | Clears the value of the field. After calling this, has_handle() will return false and handle() will return the default value. |
| set_allocated_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 handle is NULL, the behavior is the same as calling clear_handle(). |
| release_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_handle() will return false, and handle() will return the default value. |
| in_loop() | bool | void | Returns the current value of in_loop. If the in_loop is not set, returns 0. |
| set_in_loop() | void | bool | Sets the value of in_loop. After calling this, in_loop() will return value. |
| clear_in_loop() | void | void | Clears the value of in_loop. After calling this, in_loop() will return 0. |
Parent topic: Base (C++)