AgIsoStack++
A control-function-focused implementation of the major ISOBUS and J1939 protocols
|
TThis object is similar in concept to a linear bar graph but appears arched. Arched bar graphs are drawn about an Output Ellipse object enclosed within a defined rectangle. More...
#include <isobus_virtual_terminal_objects.hpp>
Public Types | |
enum class | AttributeName : std::uint8_t { Type = 0 , Width = 1 , Height = 2 , Colour = 3 , TargetLineColour = 4 , Options = 5 , StartAngle = 6 , EndAngle = 7 , BarGraphWidth = 8 , MinValue = 9 , MaxValue = 10 , VariableReference = 11 , TargetValueVariableReference = 12 , TargetValue = 13 , NumberOfAttributes = 14 } |
Enumerates this object's attributes which are assigned an attribute ID. The Change Attribute command allows any writable attribute with an AID to be changed. More... | |
enum class | Options : std::uint8_t { DrawBorder = 0 , DrawTargetLine = 1 , Undefined = 2 , BarGraphType = 3 , Deflection = 4 } |
Options that can be applied to the input number. More... | |
Public Types inherited from isobus::VTObject | |
enum class | AttributeError : std::uint8_t { InvalidObjectID = 0 , InvalidAttributeID = 1 , InvalidValue = 2 , AnyOtherError = 4 } |
Enumerates the bit indices of the error fields that can be set when changing an attribute. More... | |
Public Member Functions | |
OutputArchedBarGraph ()=default | |
Constructor for an output arched bar graph object. | |
~OutputArchedBarGraph () override=default | |
Virtual destructor for an output arched bar graph object. | |
VirtualTerminalObjectType | get_object_type () const override |
Returns the VT object type of the underlying derived object. | |
std::uint32_t | get_minumum_object_length () const override |
Returns the minimum binary serialized length of the associated object. | |
bool | get_is_valid (const std::map< std::uint16_t, std::shared_ptr< VTObject > > &objectPool) const override |
Performs basic error checking on the object and returns if the object is valid. | |
bool | set_attribute (std::uint8_t attributeID, std::uint32_t rawAttributeData, const std::map< std::uint16_t, std::shared_ptr< VTObject > > &objectPool, AttributeError &returnedError) override |
Sets an attribute and optionally returns an error code in the last parameter. | |
bool | get_attribute (std::uint8_t attributeID, std::uint32_t &returnedAttributeData) const override |
Gets an attribute and returns the raw data in the last parameter. | |
std::uint16_t | get_bar_graph_width () const |
Returns the width (px) of the bar graph. | |
void | set_bar_graph_width (std::uint16_t width) |
Sets the width (px) of the bar graph. | |
std::uint16_t | get_min_value () const |
Returns the minimum value of the bar graph. | |
void | set_min_value (std::uint16_t minimumValue) |
Sets the minimum value for the bar graph. | |
std::uint16_t | get_max_value () const |
Returns the maximum value of the bar graph. | |
void | set_max_value (std::uint16_t maximumValue) |
Sets the max value of the bar graph. | |
std::uint16_t | get_value () const |
Returns the value of the bar graph (only matters when no child number variable is used) | |
void | set_value (std::uint16_t value) |
Sets the value of the bar graph (only matters when no child number variable is used) | |
std::uint8_t | get_target_line_colour () const |
Returns the colour of the target line. | |
void | set_target_line_colour (std::uint8_t value) |
Sets the colour of the target line. | |
std::uint8_t | get_colour () const |
Returns the colour of the bar graph. | |
void | set_colour (std::uint8_t value) |
Sets the colour of the bar graph. | |
bool | get_option (Options option) const |
Returns the state of a single option in the object's option bitfield. | |
void | set_options (std::uint8_t options) |
Sets the options bitfield for this object to a new value. | |
void | set_option (Options option, bool optionValue) |
Sets a single option in the options bitfield to the specified value. | |
std::uint8_t | get_start_angle () const |
Returns the start angle of the graph. | |
void | set_start_angle (std::uint8_t value) |
Sets the start angle for the graph. | |
std::uint8_t | get_end_angle () const |
Returns the end angle of the graph. | |
void | set_end_angle (std::uint8_t value) |
Sets the end angle for the graph. | |
std::uint16_t | get_target_value () const |
Returns the target value of the graph (only matters when no target value reference is used) | |
void | set_target_value (std::uint16_t value) |
Sets the target value of the graph (only matters when no target value reference is used) | |
std::uint16_t | get_target_value_reference () const |
Returns the target value reference object ID. | |
void | set_target_value_reference (std::uint16_t value) |
Sets the target value reference object ID. | |
std::uint16_t | get_variable_reference () const |
Returns the value reference object ID, which is a number variable object that should be used to determine the value of the graph instead of the value itself if it's not NULL_OBJECT_ID. | |
void | set_variable_reference (std::uint16_t variableReferenceValue) |
Sets the value reference object ID, which is a number variable object that should be used to determine the value of the graph instead of the value itself if it's not NULL_OBJECT_ID. Does not do any checking on the type of the object ID. | |
Public Member Functions inherited from isobus::VTObject | |
VTObject ()=default | |
Constructor for a generic VT object. Sets up default values and the pointer to the member object pool. | |
virtual | ~VTObject ()=default |
Virtual destructor for a generic VT object. | |
std::uint16_t | get_id () const |
Returns the object ID of this VT object. | |
void | set_id (std::uint16_t value) |
Sets the object ID of this VT object. | |
std::uint16_t | get_width () const |
Returns the width of this object in px. | |
void | set_width (std::uint16_t value) |
Sets the width of this object in px. | |
std::uint16_t | get_height () const |
Returns the height of this object in px. | |
void | set_height (std::uint16_t value) |
Sets the height of this object in px. | |
std::uint8_t | get_background_color () const |
Returns the background color attribute of this object. | |
void | set_background_color (std::uint8_t value) |
Sets the background color attribute of this object. | |
std::uint16_t | get_number_children () const |
Returns the number of child objects within this object. | |
void | add_child (std::uint16_t objectID, std::int16_t relativeXLocation, std::int16_t relativeYLocation) |
Adds an object as a child to another object, which essentially creates a tree of object association. | |
std::uint16_t | get_child_id (std::uint16_t index) const |
Returns the ID of the child by index, if one was added previously. | |
std::int16_t | get_child_x (std::uint16_t index) const |
Returns the X offset of the child object associated with the specified index into the parent object. | |
std::int16_t | get_child_y (std::uint16_t index) const |
Returns the Y offset of the child object associated with the specified index into the parent object. | |
void | set_child_x (std::uint16_t index, std::int16_t xOffset) |
Sets the X offset of the child object associated with the specified index into the parent object. | |
void | set_child_y (std::uint16_t index, std::int16_t yOffset) |
Sets the Y offset of the child object associated with the specified index into the parent object. | |
bool | offset_all_children_with_id (std::uint16_t childObjectID, std::int8_t xOffset, std::int8_t yOffset) |
Offsets all child objects with the specified ID by the amount specified relative to its parent. | |
void | remove_child (std::uint16_t objectIDToRemove, std::int16_t relativeXLocation, std::int16_t relativeYLocation) |
Removes an object reference from another object. All fields must exactly match for the object to be removed. This is because objects can have multiple of the same child at different places, so we can't infer which one to remove without the exact position. | |
void | pop_child () |
Removes the last added child object. This is meant to be a faster way to deal with objects that only have a max of 1 child. | |
std::uint8_t | get_number_macros () const |
Returns the number of macros referenced by this object. | |
void | add_macro (MacroMetadata macroToAdd) |
Adds a macro to the list of macros referenced by this object. | |
MacroMetadata | get_macro (std::uint8_t index) const |
Returns the macro ID at the specified index. | |
Private Attributes | |
std::uint16_t | barGraphWidth = 0 |
Bar graph width in pixels. Bar graph width should be less than half the total width, or less than half the total height, whichever is least. | |
std::uint16_t | minValue = 0 |
Minimum value. Represents value when needle is at the start of arc. | |
std::uint16_t | maxValue = 0 |
Maximum value. Represents when the needle is at the end of the arc. | |
std::uint16_t | value = 0 |
Current value. Needle position set to this value, used if variable ref is NULL. | |
std::uint16_t | targetValue = 0 |
Current target value. Used only if Target value variable Reference attribute is NULL. | |
std::uint16_t | targetValueReference = NULL_OBJECT_ID |
Object ID of a Number Variable object in which to retrieve the bar graph’s target value. | |
std::uint16_t | variableReference = NULL_OBJECT_ID |
Object ID of a Number Variable object in which to retrieve the bar graph’s value. | |
std::uint8_t | targetLineColour = 0 |
Target line colour (if drawn) | |
std::uint8_t | colour = 0 |
Bar graph fill and border colour. | |
std::uint8_t | optionsBitfield = 0 |
Bitfield of options defined in Options enum. | |
std::uint8_t | startAngle = 0 |
Start angle / 2 in degrees from positive X axis counterclockwise. | |
std::uint8_t | endAngle = 0 |
End angle / 2 in degrees from positive X axis counterclockwise. | |
Static Private Attributes | |
static constexpr std::uint32_t | MIN_OBJECT_LENGTH = 27 |
The fewest bytes of IOP data that can represent this object. | |
Additional Inherited Members | |
Static Public Member Functions inherited from isobus::VTObject | |
static std::shared_ptr< VTObject > | get_object_by_id (std::uint16_t objectID, const std::map< std::uint16_t, std::shared_ptr< VTObject > > &objectPool) |
Returns a VT object from its member pool by ID, or the null id if it does not exist. | |
Protected Attributes inherited from isobus::VTObject | |
std::vector< ChildObjectData > | children |
List of child objects. | |
std::vector< MacroMetadata > | macros |
List of macros referenced by this object. | |
std::uint16_t | objectID = NULL_OBJECT_ID |
Object identifier. Shall be unique within the object pool. | |
std::uint16_t | width = 0 |
The width of the object. Not always applicable, but often used. | |
std::uint16_t | height = 0 |
The height of the object. Not always applicable, but often used. | |
std::uint8_t | backgroundColor = 0 |
The background color (from the VT colour table) | |
TThis object is similar in concept to a linear bar graph but appears arched. Arched bar graphs are drawn about an Output Ellipse object enclosed within a defined rectangle.
Definition at line 2916 of file isobus_virtual_terminal_objects.hpp.
|
strong |
Enumerates this object's attributes which are assigned an attribute ID. The Change Attribute command allows any writable attribute with an AID to be changed.
Definition at line 2921 of file isobus_virtual_terminal_objects.hpp.
|
strong |
Options that can be applied to the input number.
Definition at line 2942 of file isobus_virtual_terminal_objects.hpp.
|
overridevirtual |
Gets an attribute and returns the raw data in the last parameter.
[in] | attributeID | The ID of the attribute to get |
[out] | returnedAttributeData | The raw data of the attribute, as decoded in little endian format with unused bytes/bits set to zero. You may need to cast this to the correct type. If this function returns false, this value is undefined. |
Implements isobus::VTObject.
Definition at line 5950 of file isobus_virtual_terminal_objects.cpp.
std::uint16_t isobus::OutputArchedBarGraph::get_bar_graph_width | ( | ) | const |
Returns the width (px) of the bar graph.
Definition at line 6066 of file isobus_virtual_terminal_objects.cpp.
std::uint8_t isobus::OutputArchedBarGraph::get_colour | ( | ) | const |
Returns the colour of the bar graph.
Definition at line 6116 of file isobus_virtual_terminal_objects.cpp.
std::uint8_t isobus::OutputArchedBarGraph::get_end_angle | ( | ) | const |
Returns the end angle of the graph.
Definition at line 6158 of file isobus_virtual_terminal_objects.cpp.
|
overridevirtual |
Performs basic error checking on the object and returns if the object is valid.
[in] | objectPool | The object pool to use when validating the object |
true
if the object passed basic error checks Implements isobus::VTObject.
Definition at line 5772 of file isobus_virtual_terminal_objects.cpp.
std::uint16_t isobus::OutputArchedBarGraph::get_max_value | ( | ) | const |
Returns the maximum value of the bar graph.
Definition at line 6086 of file isobus_virtual_terminal_objects.cpp.
std::uint16_t isobus::OutputArchedBarGraph::get_min_value | ( | ) | const |
Returns the minimum value of the bar graph.
Definition at line 6076 of file isobus_virtual_terminal_objects.cpp.
|
overridevirtual |
Returns the minimum binary serialized length of the associated object.
Implements isobus::VTObject.
Definition at line 5767 of file isobus_virtual_terminal_objects.cpp.
|
overridevirtual |
Returns the VT object type of the underlying derived object.
Implements isobus::VTObject.
Definition at line 5762 of file isobus_virtual_terminal_objects.cpp.
bool isobus::OutputArchedBarGraph::get_option | ( | Options | option | ) | const |
Returns the state of a single option in the object's option bitfield.
[in] | option | The option to check the value of in the object's option bitfield |
Definition at line 6126 of file isobus_virtual_terminal_objects.cpp.
std::uint8_t isobus::OutputArchedBarGraph::get_start_angle | ( | ) | const |
Returns the start angle of the graph.
Definition at line 6148 of file isobus_virtual_terminal_objects.cpp.
std::uint8_t isobus::OutputArchedBarGraph::get_target_line_colour | ( | ) | const |
Returns the colour of the target line.
Definition at line 6106 of file isobus_virtual_terminal_objects.cpp.
std::uint16_t isobus::OutputArchedBarGraph::get_target_value | ( | ) | const |
Returns the target value of the graph (only matters when no target value reference is used)
Definition at line 6168 of file isobus_virtual_terminal_objects.cpp.
std::uint16_t isobus::OutputArchedBarGraph::get_target_value_reference | ( | ) | const |
Returns the target value reference object ID.
This object will be used (if it's not NULL_OBJECT_ID) to determine the target value of the graph instead of the target value itself.
Definition at line 6178 of file isobus_virtual_terminal_objects.cpp.
std::uint16_t isobus::OutputArchedBarGraph::get_value | ( | ) | const |
Returns the value of the bar graph (only matters when no child number variable is used)
Definition at line 6096 of file isobus_virtual_terminal_objects.cpp.
std::uint16_t isobus::OutputArchedBarGraph::get_variable_reference | ( | ) | const |
Returns the value reference object ID, which is a number variable object that should be used to determine the value of the graph instead of the value itself if it's not NULL_OBJECT_ID.
Definition at line 6188 of file isobus_virtual_terminal_objects.cpp.
|
overridevirtual |
Sets an attribute and optionally returns an error code in the last parameter.
[in] | attributeID | The ID of the attribute to change |
[in] | rawAttributeData | The raw data to change the attribute to, as decoded in little endian format with unused bytes/bits set to zero. |
[in] | objectPool | The object pool to use when validating the objects affected by setting this attribute |
[out] | returnedError | If this function returns false, this will be the error code. If the function returns true, this value is undefined. |
Implements isobus::VTObject.
Definition at line 5826 of file isobus_virtual_terminal_objects.cpp.
void isobus::OutputArchedBarGraph::set_bar_graph_width | ( | std::uint16_t | width | ) |
Sets the width (px) of the bar graph.
[in] | width | The width (px) to set for the bar graph |
Definition at line 6071 of file isobus_virtual_terminal_objects.cpp.
void isobus::OutputArchedBarGraph::set_colour | ( | std::uint8_t | value | ) |
Sets the colour of the bar graph.
[in] | value | The colour to set for the bar graph as an index into the VT colour table |
Definition at line 6121 of file isobus_virtual_terminal_objects.cpp.
void isobus::OutputArchedBarGraph::set_end_angle | ( | std::uint8_t | value | ) |
Sets the end angle for the graph.
[in] | value | End angle/2 (in degrees) from positive X axis anticlockwise (90° is straight up) for the graph |
Definition at line 6163 of file isobus_virtual_terminal_objects.cpp.
void isobus::OutputArchedBarGraph::set_max_value | ( | std::uint16_t | maximumValue | ) |
Sets the max value of the bar graph.
[in] | maximumValue | The maximum value of the bar graph to set |
Definition at line 6091 of file isobus_virtual_terminal_objects.cpp.
void isobus::OutputArchedBarGraph::set_min_value | ( | std::uint16_t | minimumValue | ) |
Sets the minimum value for the bar graph.
[in] | minimumValue | The minimum value to set |
Definition at line 6081 of file isobus_virtual_terminal_objects.cpp.
void isobus::OutputArchedBarGraph::set_option | ( | Options | option, |
bool | optionValue ) |
Sets a single option in the options bitfield to the specified value.
[in] | option | The option to set |
[in] | optionValue | The new value of the option bit |
Definition at line 6136 of file isobus_virtual_terminal_objects.cpp.
void isobus::OutputArchedBarGraph::set_options | ( | std::uint8_t | options | ) |
Sets the options bitfield for this object to a new value.
[in] | options | The new value for the options bitfield |
Definition at line 6131 of file isobus_virtual_terminal_objects.cpp.
void isobus::OutputArchedBarGraph::set_start_angle | ( | std::uint8_t | value | ) |
Sets the start angle for the graph.
[in] | value | Start angle/2 (in degrees) from positive X axis anticlockwise (90° is straight up) for the graph |
Definition at line 6153 of file isobus_virtual_terminal_objects.cpp.
void isobus::OutputArchedBarGraph::set_target_line_colour | ( | std::uint8_t | value | ) |
Sets the colour of the target line.
[in] | value | The colour to set as an index into the VT colour table |
Definition at line 6111 of file isobus_virtual_terminal_objects.cpp.
void isobus::OutputArchedBarGraph::set_target_value | ( | std::uint16_t | value | ) |
Sets the target value of the graph (only matters when no target value reference is used)
[in] | value | The target value of the graph |
Definition at line 6173 of file isobus_virtual_terminal_objects.cpp.
void isobus::OutputArchedBarGraph::set_target_value_reference | ( | std::uint16_t | value | ) |
Sets the target value reference object ID.
This object will be used (if it's not NULL_OBJECT_ID) to determine the target value of the graph instead of the target value itself.
[in] | value | The object ID of a number variable to use for the target value |
Definition at line 6183 of file isobus_virtual_terminal_objects.cpp.
void isobus::OutputArchedBarGraph::set_value | ( | std::uint16_t | value | ) |
Sets the value of the bar graph (only matters when no child number variable is used)
[in] | value | The value to set for the bar graph |
Definition at line 6101 of file isobus_virtual_terminal_objects.cpp.
void isobus::OutputArchedBarGraph::set_variable_reference | ( | std::uint16_t | variableReferenceValue | ) |
Sets the value reference object ID, which is a number variable object that should be used to determine the value of the graph instead of the value itself if it's not NULL_OBJECT_ID. Does not do any checking on the type of the object ID.
[in] | variableReferenceValue | The object ID of a number variable to use for the target value |
Definition at line 6193 of file isobus_virtual_terminal_objects.cpp.
|
private |
Bar graph width in pixels. Bar graph width should be less than half the total width, or less than half the total height, whichever is least.
Definition at line 3104 of file isobus_virtual_terminal_objects.hpp.
|
private |
Bar graph fill and border colour.
Definition at line 3112 of file isobus_virtual_terminal_objects.hpp.
|
private |
End angle / 2 in degrees from positive X axis counterclockwise.
Definition at line 3115 of file isobus_virtual_terminal_objects.hpp.
|
private |
Maximum value. Represents when the needle is at the end of the arc.
Definition at line 3106 of file isobus_virtual_terminal_objects.hpp.
|
staticconstexprprivate |
The fewest bytes of IOP data that can represent this object.
Definition at line 3102 of file isobus_virtual_terminal_objects.hpp.
|
private |
Minimum value. Represents value when needle is at the start of arc.
Definition at line 3105 of file isobus_virtual_terminal_objects.hpp.
|
private |
Bitfield of options defined in Options
enum.
Definition at line 3113 of file isobus_virtual_terminal_objects.hpp.
|
private |
Start angle / 2 in degrees from positive X axis counterclockwise.
Definition at line 3114 of file isobus_virtual_terminal_objects.hpp.
|
private |
Target line colour (if drawn)
Definition at line 3111 of file isobus_virtual_terminal_objects.hpp.
|
private |
Current target value. Used only if Target value variable Reference attribute is NULL.
Definition at line 3108 of file isobus_virtual_terminal_objects.hpp.
|
private |
Object ID of a Number Variable object in which to retrieve the bar graph’s target value.
Definition at line 3109 of file isobus_virtual_terminal_objects.hpp.
|
private |
Current value. Needle position set to this value, used if variable ref is NULL.
Definition at line 3107 of file isobus_virtual_terminal_objects.hpp.
|
private |
Object ID of a Number Variable object in which to retrieve the bar graph’s value.
Definition at line 3110 of file isobus_virtual_terminal_objects.hpp.