This object is a meter. Meter is drawn about a circle enclosed within a defined square. More...

#include <isobus_virtual_terminal_objects.hpp>

Inheritance diagram for isobus::OutputMeter:

Collaboration diagram for isobus::OutputMeter:

Public Types
enum class	AttributeName : std::uint8_t { Type = 0 , Width = 1 , NeedleColour = 2 , BorderColour = 3 , ArcAndTickColour = 4 , Options = 5 , NumberOfTicks = 6 , StartAngle = 7 , EndAngle = 8 , MinValue = 9 , MaxValue = 10 , VariableReference = 11 , Value = 12 , NumberOfAttributes = 13 }
	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 { DrawArc = 0 , DrawBorder = 1 , DrawTicks = 2 , DeflectionDirection = 3 }
	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
	OutputMeter ()=default
	Constructor for an output meter object.

	~OutputMeter () override=default
	Virtual destructor for an output meter 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_min_value () const
	Returns the minimum value of the output meter.

void	set_min_value (std::uint16_t value)
	Sets the minimum value of the output meter.

std::uint16_t	get_max_value () const
	Returns the max value for the output meter.

void	set_max_value (std::uint16_t value)
	Sets the max value for the output meter.

std::uint16_t	get_value () const
	Returns the value for the output meter (only matters if there's no child number variable object).

void	set_value (std::uint16_t value)
	Sets the value of the output meter (only matters if there's no child number variable object).

std::uint8_t	get_needle_colour () const
	Returns the value of the needle colour.

void	set_needle_colour (std::uint8_t colourIndex)
	Sets the value of the needle colour.

std::uint8_t	get_border_colour () const
	Returns the border colour of the meter.

void	set_border_colour (std::uint8_t colourIndex)
	Sets the border colour of the meter.

std::uint8_t	get_arc_and_tick_colour () const
	Returns the arc and tick colour for the meter.

void	set_arc_and_tick_colour (std::uint8_t colourIndex)
	Sets the arc and tick colour for the meter.

std::uint8_t	get_number_of_ticks () const
	Returns the number of ticks to render across the meter.

void	set_number_of_ticks (std::uint8_t ticks)
	Sets the number of ticks to render when drawing the meter.

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 for the meter.

void	set_start_angle (std::uint8_t value)
	Sets the start angle for the meter.

std::uint8_t	get_end_angle () const
	Returns the end angle of the meter.

void	set_end_angle (std::uint8_t value)
	Sets the end angle for this meter in degrees from the +x axis counter clockwise.

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	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	variableReference = NULL_OBJECT_ID
	Object ID of a number variable to use for the value, or NULL_OBJECT_ID if not used.

std::uint8_t	needleColour = 0
	Needle (indicator) colour.

std::uint8_t	borderColour = 0
	Border colour (if drawn)

std::uint8_t	arcAndTickColour = 0
	Meter arc and tick colour (if drawn)

std::uint8_t	optionsBitfield = 0
	Bitfield of options defined in `Options` enum.

std::uint8_t	numberOfTicks = 0
	Number of ticks to draw about meter arc.

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 positve X axis counterclockwise.

Static Private Attributes
static constexpr std::uint32_t	MIN_OBJECT_LENGTH = 21
	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)

Detailed Description

This object is a meter. Meter is drawn about a circle enclosed within a defined square.

Definition at line 2545 of file isobus_virtual_terminal_objects.hpp.

Member Enumeration Documentation

◆ AttributeName

enum class isobus::OutputMeter::AttributeName : std::uint8_t

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 2550 of file isobus_virtual_terminal_objects.hpp.

◆ Options

enum class isobus::OutputMeter::Options : std::uint8_t

strong

Options that can be applied to the input number.

Enumerator
DrawArc	Draw Arc.
DrawBorder	Draw Border.
DrawTicks	Draw Ticks.
DeflectionDirection	0 = From min to max, counterclockwisee. 1 = from min to max, clockwise

Definition at line 2570 of file isobus_virtual_terminal_objects.hpp.

Member Function Documentation

◆ get_arc_and_tick_colour()

std::uint8_t isobus::OutputMeter::get_arc_and_tick_colour ( ) const

Returns the arc and tick colour for the meter.

Returns: The arc and tick colour for the meter as an index into the VT colour table

Definition at line 5288 of file isobus_virtual_terminal_objects.cpp.

◆ get_attribute()

bool isobus::OutputMeter::get_attribute	(	std::uint8_t	attributeID,
		std::uint32_t &	returnedAttributeData ) const

overridevirtual

Gets an attribute and returns the raw data in the last parameter.

Parameters

[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.

Returns: True if the attribute was retrieved, otherwise false (the attribute ID was invalid)

Implements isobus::VTObject.

Definition at line 5129 of file isobus_virtual_terminal_objects.cpp.

Here is the call graph for this function:

◆ get_border_colour()

std::uint8_t isobus::OutputMeter::get_border_colour ( ) const

Returns the border colour of the meter.

Returns: The border colour of the meter as an index into the VT colour table

Definition at line 5278 of file isobus_virtual_terminal_objects.cpp.

◆ get_end_angle()

std::uint8_t isobus::OutputMeter::get_end_angle ( ) const

Returns the end angle of the meter.

Note: If the start and end angles are the same the meter’s arc is closed.

Returns: The end angle/2 (in degrees) from positive X axis anticlockwise(90° is straight up).

Definition at line 5340 of file isobus_virtual_terminal_objects.cpp.

◆ get_is_valid()

bool isobus::OutputMeter::get_is_valid ( const std::map< std::uint16_t, std::shared_ptr< VTObject > > & objectPool ) const

overridevirtual

Performs basic error checking on the object and returns if the object is valid.

Parameters

[in] objectPool The object pool to use when validating the object

Returns: true if the object passed basic error checks

Implements isobus::VTObject.

Definition at line 4976 of file isobus_virtual_terminal_objects.cpp.

Here is the call graph for this function:

◆ get_max_value()

std::uint16_t isobus::OutputMeter::get_max_value ( ) const

Returns the max value for the output meter.

Returns: The max value for the output meter

Definition at line 5248 of file isobus_virtual_terminal_objects.cpp.

◆ get_min_value()

std::uint16_t isobus::OutputMeter::get_min_value ( ) const

Returns the minimum value of the output meter.

Returns: The minimum value of the output meter

Definition at line 5238 of file isobus_virtual_terminal_objects.cpp.

◆ get_minumum_object_length()

std::uint32_t isobus::OutputMeter::get_minumum_object_length ( ) const

overridevirtual

Returns the minimum binary serialized length of the associated object.

Returns: The minimum binary serialized length of the associated object

Implements isobus::VTObject.

Definition at line 4971 of file isobus_virtual_terminal_objects.cpp.

◆ get_needle_colour()

std::uint8_t isobus::OutputMeter::get_needle_colour ( ) const

Returns the value of the needle colour.

Returns: The value of the needle colour as an index into the VT colour table

Definition at line 5268 of file isobus_virtual_terminal_objects.cpp.

◆ get_number_of_ticks()

std::uint8_t isobus::OutputMeter::get_number_of_ticks ( ) const

Returns the number of ticks to render across the meter.

Returns: The number of ticks to render across the meter

Definition at line 5298 of file isobus_virtual_terminal_objects.cpp.

◆ get_object_type()

VirtualTerminalObjectType isobus::OutputMeter::get_object_type ( ) const

overridevirtual

Returns the VT object type of the underlying derived object.

Returns: The VT object type of the underlying derived object

Implements isobus::VTObject.

Definition at line 4966 of file isobus_virtual_terminal_objects.cpp.

◆ get_option()

bool isobus::OutputMeter::get_option ( Options option ) const

Returns the state of a single option in the object's option bitfield.

Parameters

[in] option The option to check the value of in the object's option bitfield

Returns: The state of the associated option bit

Definition at line 5308 of file isobus_virtual_terminal_objects.cpp.

◆ get_start_angle()

std::uint8_t isobus::OutputMeter::get_start_angle ( ) const

Returns the start angle for the meter.

Note: If the start and end angles are the same the meter’s arc is closed.

Returns: Start angle/2 (in degrees) from positive X axis anticlockwise(90° is straight up).

Definition at line 5330 of file isobus_virtual_terminal_objects.cpp.

◆ get_value()

std::uint16_t isobus::OutputMeter::get_value ( ) const

Returns the value for the output meter (only matters if there's no child number variable object).

Returns: The value of the output meter

Definition at line 5258 of file isobus_virtual_terminal_objects.cpp.

◆ get_variable_reference()

std::uint16_t isobus::OutputMeter::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.

Returns: The object ID of a number variable to use for the value, or NULL_OBJECT_ID if not used.

Definition at line 5350 of file isobus_virtual_terminal_objects.cpp.

◆ set_arc_and_tick_colour()

void isobus::OutputMeter::set_arc_and_tick_colour ( std::uint8_t colourIndex )

Sets the arc and tick colour for the meter.

Parameters

[in] colourIndex The arc and tick colour to set for the meter as an index into the VT colour table

Definition at line 5293 of file isobus_virtual_terminal_objects.cpp.

◆ set_attribute()

bool isobus::OutputMeter::set_attribute	(	std::uint8_t	attributeID,
		std::uint32_t	rawAttributeData,
		const std::map< std::uint16_t, std::shared_ptr< VTObject > > &	objectPool,
		AttributeError &	returnedError )

overridevirtual

Sets an attribute and optionally returns an error code in the last parameter.

Parameters

[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.

Returns: True if the attribute was changed, otherwise false (check the returnedError in this case to know why).

Implements isobus::VTObject.

Definition at line 5012 of file isobus_virtual_terminal_objects.cpp.

Here is the call graph for this function:

◆ set_border_colour()

void isobus::OutputMeter::set_border_colour ( std::uint8_t colourIndex )

Sets the border colour of the meter.

Parameters

[in] colourIndex The border colour to set for the meter as an index into the VT colour table

Definition at line 5283 of file isobus_virtual_terminal_objects.cpp.

◆ set_end_angle()

void isobus::OutputMeter::set_end_angle ( std::uint8_t value )

Sets the end angle for this meter in degrees from the +x axis counter clockwise.

Note: If the start and end angles are the same the meter’s arc is closed.

Parameters

[in] value End angle/2 (in degrees) from positive X axis anticlockwise(90° is straight up).

Definition at line 5345 of file isobus_virtual_terminal_objects.cpp.

◆ set_max_value()

void isobus::OutputMeter::set_max_value ( std::uint16_t value )

Sets the max value for the output meter.

Parameters

[in] value The max value to set for the output meter

Definition at line 5253 of file isobus_virtual_terminal_objects.cpp.

◆ set_min_value()

void isobus::OutputMeter::set_min_value ( std::uint16_t value )

Sets the minimum value of the output meter.

Parameters

[in] value The minimum value to set for the output meter

Definition at line 5243 of file isobus_virtual_terminal_objects.cpp.

◆ set_needle_colour()

void isobus::OutputMeter::set_needle_colour ( std::uint8_t colourIndex )

Sets the value of the needle colour.

Parameters

[in] colourIndex The colour to set for the needle as an index into the VT colour table

Definition at line 5273 of file isobus_virtual_terminal_objects.cpp.

◆ set_number_of_ticks()

void isobus::OutputMeter::set_number_of_ticks ( std::uint8_t ticks )

Sets the number of ticks to render when drawing the meter.

Parameters

[in] ticks The number of ticks to render

Definition at line 5303 of file isobus_virtual_terminal_objects.cpp.

◆ set_option()

void isobus::OutputMeter::set_option	(	Options	option,
		bool	optionValue )

Sets a single option in the options bitfield to the specified value.

Parameters

[in]	option	The option to set
[in]	optionValue	The new value of the option bit

Definition at line 5318 of file isobus_virtual_terminal_objects.cpp.

◆ set_options()

void isobus::OutputMeter::set_options ( std::uint8_t options )

Sets the options bitfield for this object to a new value.

Parameters

[in] options The new value for the options bitfield

Definition at line 5313 of file isobus_virtual_terminal_objects.cpp.

◆ set_start_angle()

void isobus::OutputMeter::set_start_angle ( std::uint8_t value )

Sets the start angle for the meter.

Note: If the start and end angles are the same the meter’s arc is closed.

Parameters

[in] value Start angle/2 (in degrees) from positive X axis anticlockwise(90° is straight up).

Definition at line 5335 of file isobus_virtual_terminal_objects.cpp.

◆ set_value()

void isobus::OutputMeter::set_value ( std::uint16_t value )

Sets the value of the output meter (only matters if there's no child number variable object).

Parameters

[in] value The value to set for the output meter

Definition at line 5263 of file isobus_virtual_terminal_objects.cpp.

◆ set_variable_reference()

void isobus::OutputMeter::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.

Parameters

[in] variableReferenceValue The object ID of a number variable to use for the target value

Definition at line 5355 of file isobus_virtual_terminal_objects.cpp.

Member Data Documentation

◆ arcAndTickColour

std::uint8_t isobus::OutputMeter::arcAndTickColour = 0

private

Meter arc and tick colour (if drawn)

Definition at line 2725 of file isobus_virtual_terminal_objects.hpp.

◆ borderColour

std::uint8_t isobus::OutputMeter::borderColour = 0

private

Border colour (if drawn)

Definition at line 2724 of file isobus_virtual_terminal_objects.hpp.

◆ endAngle

std::uint8_t isobus::OutputMeter::endAngle = 0

private

End angle / 2 in degrees from positve X axis counterclockwise.

Definition at line 2729 of file isobus_virtual_terminal_objects.hpp.

◆ maxValue

std::uint16_t isobus::OutputMeter::maxValue = 0

private

Maximum value. Represents when the needle is at the end of the arc.

Definition at line 2720 of file isobus_virtual_terminal_objects.hpp.

◆ MIN_OBJECT_LENGTH

constexpr std::uint32_t isobus::OutputMeter::MIN_OBJECT_LENGTH = 21

staticconstexprprivate

The fewest bytes of IOP data that can represent this object.

Definition at line 2717 of file isobus_virtual_terminal_objects.hpp.

◆ minValue

std::uint16_t isobus::OutputMeter::minValue = 0

private

Minimum value. Represents value when needle is at the start of arc.

Definition at line 2719 of file isobus_virtual_terminal_objects.hpp.

◆ needleColour

std::uint8_t isobus::OutputMeter::needleColour = 0

private

Needle (indicator) colour.

Definition at line 2723 of file isobus_virtual_terminal_objects.hpp.

◆ numberOfTicks

std::uint8_t isobus::OutputMeter::numberOfTicks = 0

private

Number of ticks to draw about meter arc.

Definition at line 2727 of file isobus_virtual_terminal_objects.hpp.

◆ optionsBitfield

std::uint8_t isobus::OutputMeter::optionsBitfield = 0

private

Bitfield of options defined in Options enum.

Definition at line 2726 of file isobus_virtual_terminal_objects.hpp.

◆ startAngle

std::uint8_t isobus::OutputMeter::startAngle = 0

private

Start angle / 2 in degrees from positive X axis counterclockwise.

Definition at line 2728 of file isobus_virtual_terminal_objects.hpp.

◆ value

std::uint16_t isobus::OutputMeter::value = 0

private

Current value. Needle position set to this value, used if variable ref is NULL.

Definition at line 2721 of file isobus_virtual_terminal_objects.hpp.

◆ variableReference

std::uint16_t isobus::OutputMeter::variableReference = NULL_OBJECT_ID

private

Object ID of a number variable to use for the value, or NULL_OBJECT_ID if not used.

Definition at line 2722 of file isobus_virtual_terminal_objects.hpp.

The documentation for this class was generated from the following files:

isobus/include/isobus/isobus/isobus_virtual_terminal_objects.hpp
isobus/src/isobus_virtual_terminal_objects.cpp

Public Types

Public Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ AttributeName

◆ Options

Member Function Documentation

◆ get_arc_and_tick_colour()

◆ get_attribute()

◆ get_border_colour()

◆ get_end_angle()

◆ get_is_valid()

◆ get_max_value()

◆ get_min_value()

◆ get_minumum_object_length()

◆ get_needle_colour()

◆ get_number_of_ticks()

◆ get_object_type()

◆ get_option()

◆ get_start_angle()

◆ get_value()

◆ get_variable_reference()

◆ set_arc_and_tick_colour()

◆ set_attribute()

◆ set_border_colour()

◆ set_end_angle()

◆ set_max_value()

◆ set_min_value()

◆ set_needle_colour()

◆ set_number_of_ticks()

◆ set_option()

◆ set_options()

◆ set_start_angle()

◆ set_value()

◆ set_variable_reference()

Member Data Documentation

◆ arcAndTickColour

◆ borderColour

◆ endAngle

◆ maxValue

◆ MIN_OBJECT_LENGTH

◆ minValue

◆ needleColour

◆ numberOfTicks

◆ optionsBitfield

◆ startAngle

◆ value

◆ variableReference