Member values
| Member name | Data type | Description |
|---|---|---|
| frame_id | uint32 | Frame ID |
| custom_data_0 | uint32 | Custom data word 0 |
| custom_data_1 | uint32 | Custom data word 1 |
| custom_data_2 | uint32 | Custom data word 2 |
| custom_data_3 | uint32 | Custom data word 3 |
| custom_data_4 | uint32 | Custom data word 4 |
| custom_data_5 | uint32 | Custom data word 5 |
| custom_data_6 | uint32 | Custom data word 6 |
| custom_data_7 | uint32 | Custom data word 7 |
| actuators_custom_data | ActuatorCustomData | Actuator custom data (repeated) |
| interconnect_custom_data | CustomData | Interconnect custom data |
Member functions
| Function name | Return type | Input type | Description |
|---|---|---|---|
| frame_id() | uint32 | void | Returns the current value of frame_id. If the frame_id is not set, returns 0. |
| set_frame_id() | void | uint32 | Sets the value of frame_id. After calling this, frame_id() will return value. |
| clear_frame_id() | void | void | Clears the value of frame_id. After calling this, frame_id() will return 0. |
| custom_data_0() | uint32 | void | Returns the current value of custom_data_0. If the custom_data_0 is not set, returns 0. |
| set_custom_data_0() | void | uint32 | Sets the value of custom_data_0. After calling this, custom_data_0() will return value. |
| clear_custom_data_0() | void | void | Clears the value of custom_data_0. After calling this, custom_data_0() will return 0. |
| custom_data_1() | uint32 | void | Returns the current value of custom_data_1. If the custom_data_1 is not set, returns 0. |
| set_custom_data_1() | void | uint32 | Sets the value of custom_data_1. After calling this, custom_data_1() will return value. |
| clear_custom_data_1() | void | void | Clears the value of custom_data_1. After calling this, custom_data_1() will return 0. |
| custom_data_2() | uint32 | void | Returns the current value of custom_data_2. If the custom_data_2 is not set, returns 0. |
| set_custom_data_2() | void | uint32 | Sets the value of custom_data_2. After calling this, custom_data_2() will return value. |
| clear_custom_data_2() | void | void | Clears the value of custom_data_2. After calling this, custom_data_2() will return 0. |
| custom_data_3() | uint32 | void | Returns the current value of custom_data_3. If the custom_data_3 is not set, returns 0. |
| set_custom_data_3() | void | uint32 | Sets the value of custom_data_3. After calling this, custom_data_3() will return value. |
| clear_custom_data_3() | void | void | Clears the value of custom_data_3. After calling this, custom_data_3() will return 0. |
| custom_data_4() | uint32 | void | Returns the current value of custom_data_4. If the custom_data_4 is not set, returns 0. |
| set_custom_data_4() | void | uint32 | Sets the value of custom_data_4. After calling this, custom_data_4() will return value. |
| clear_custom_data_4() | void | void | Clears the value of custom_data_4. After calling this, custom_data_4() will return 0. |
| custom_data_5() | uint32 | void | Returns the current value of custom_data_5. If the custom_data_5 is not set, returns 0. |
| set_custom_data_5() | void | uint32 | Sets the value of custom_data_5. After calling this, custom_data_5() will return value. |
| clear_custom_data_5() | void | void | Clears the value of custom_data_5. After calling this, custom_data_5() will return 0. |
| custom_data_6() | uint32 | void | Returns the current value of custom_data_6. If the custom_data_6 is not set, returns 0. |
| set_custom_data_6() | void | uint32 | Sets the value of custom_data_6. After calling this, custom_data_6() will return value. |
| clear_custom_data_6() | void | void | Clears the value of custom_data_6. After calling this, custom_data_6() will return 0. |
| custom_data_7() | uint32 | void | Returns the current value of custom_data_7. If the custom_data_7 is not set, returns 0. |
| set_custom_data_7() | void | uint32 | Sets the value of custom_data_7. After calling this, custom_data_7() will return value. |
| clear_custom_data_7() | void | void | Clears the value of custom_data_7. After calling this, custom_data_7() will return 0. |
| actuators_custom_data_size() const | int | void | Returns the number of elements currently in the field. |
| actuators_custom_data() const | const ActuatorCustomData | int index | Returns the element at the given zero-based index. Calling this method with index outside of [0, actuators_custom_data_size()) yields undefined behavior. |
| mutable_actuators_custom_data() | ActuatorCustomData* | int index | Returns a pointer to the mutable ActuatorCustomData object that stores the value of the element at the given zero-based index. Calling this method with index outside of [0, actuators_custom_data_size()) yields undefined behavior. |
| add_actuators_custom_data() | ActuatorCustomData* | void | Adds a new element and returns a pointer to it. The returned ActuatorCustomData is mutable and will have none of its fields set (i.e. it will be identical to a newly-allocated ActuatorCustomData). |
| clear_actuators_custom_data() | void | void | Removes all elements from the field. After calling this, actuators_custom_data_size() will return zero. |
| actuators_custom_data() const | const RepeatedPtrField< ActuatorCustomData>& | void | Returns the underlying RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods. |
| mutable_actuators_custom_data() | RepeatedPtrField< ActuatorCustomData>* | void | Returns a pointer to the underlying mutable RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods. |
| has_interconnect_custom_data() const | bool | void | Returns true if interconnect_custom_data is set. |
| interconnect_custom_data() | const CustomData& | void | Returns the current value of interconnect_custom_data. If interconnect_custom_data is not set, returns a CustomData with none of its fields set (possibly interconnect_custom_data::default_instance()). |
| mutable_interconnect_custom_data() | CustomData * | void | Returns a pointer to the mutable CustomData object that stores the field's value. If the field was not set prior to the call, then the returned CustomData will have none of its fields set (i.e. it will be identical to a newly-allocated CustomData). After calling this, has_interconnect_custom_data() will return true and interconnect_custom_data() will return a reference to the same instance of CustomData. |
| clear_interconnect_custom_data() | void | void | Clears the value of the field. After calling this, has_interconnect_custom_data() will return false and interconnect_custom_data() will return the default value. |
| set_allocated_interconnect_custom_data() | void | CustomData * | Sets the CustomData object to the field and frees the previous field value if it exists. If the CustomData pointer is not NULL, the message takes ownership of the allocated CustomData object and has_ CustomData() will return true. Otherwise, if the interconnect_custom_data is NULL, the behavior is the same as calling clear_interconnect_custom_data(). |
| release_interconnect_custom_data() | CustomData * | void | Releases the ownership of the field and returns the pointer of the CustomData object. After calling this, caller takes the ownership of the allocated CustomData object, has_interconnect_custom_data() will return false, and interconnect_custom_data() will return the default value. |
Parent topic: BaseCyclic (C++)