This object is used to format and output a numeric value based on a supplied integer value. More...

#include <isobus_virtual_terminal_objects.hpp>

Inheritance diagram for isobus::OutputNumber:

Collaboration diagram for isobus::OutputNumber:

Public Types
enum class	AttributeName : std::uint8_t { Type = 0 , Width = 1 , Height = 2 , BackgroundColour = 3 , FontAttributes = 4 , Options = 5 , VariableReference = 6 , Offset = 7 , Scale = 8 , NumberOfDecimals = 9 , Format = 10 , Justification = 11 , NumberOfAttributes = 12 }
	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 { Transparent = 0 , DisplayLeadingZeros = 1 , DisplayZeroAsBlank = 2 , Truncate = 3 }
	Options that can be applied to the input number. More...

enum class	HorizontalJustification : std::uint8_t { PositionLeft = 0 , PositionMiddle = 1 , PositionRight = 2 , Reserved = 3 }
	The allowable horizontal justification options. More...

enum class	VerticalJustification : std::uint8_t { PositionTop = 0 , PositionMiddle = 1 , PositionBottom = 2 , Reserved = 3 }
	The allowable vertical justification options. 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
	OutputNumber ()=default
	Constructor for an output number object.

	~OutputNumber () override=default
	Virtual destructor for an output number 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.

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 value)
	Sets the options bitfield for this object to a new value.

void	set_option (Options option, bool value)
	Sets a single option in the options bitfield to the specified value.

HorizontalJustification	get_horizontal_justification () const
	Returns the horizontal justification of the output number within its bounding box.

VerticalJustification	get_vertical_justification () const
	Returns the vertical justification of the output number within its bounding box.

void	set_justification_bitfield (std::uint8_t value)
	Sets the justification bitfield to a new value.

float	get_scale () const
	Returns the scale factor of the output number.

void	set_scale (float scaleValue)
	Sets the scale factor for the output number.

std::int32_t	get_offset () const
	Returns the offset that is applied to the output number.

void	set_offset (std::int32_t offsetValue)
	Sets the offset of the output number.

std::uint8_t	get_number_of_decimals () const
	Returns the number of decimals to render in the output number.

void	set_number_of_decimals (std::uint8_t decimalValue)
	Sets the number of decimals to render in the output number.

bool	get_format () const
	Returns if the "format" option is set for this object.

void	set_format (bool shouldFormatAsExponential)
	Sets the format option for this object.

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

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

void	set_variable_reference (std::uint16_t referencedObjectID)
	A dedicated way to set the stored variable reference so we don't have to worry about the child object list getting messed up from changing the attribute or a list item.

std::uint16_t	get_variable_reference () const
	Returns the variable reference, which is an object ID of a number variable or NULL_OBJECT_ID (0xFFFF)

std::uint16_t	get_font_attributes () const
	Returns the object ID of a font attributes object that defines the font attributes of the Output Number object.

void	set_font_attributes (std::uint16_t fontAttributesValue)
	Sets the object ID of a font attributes object that defines the font attributes of the Output Number object. Does no error checking on the type of the supplied object.

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
float	scale = 1.0f
	Scale to be applied to the input value and min/max values.

std::int32_t	offset = 0
	Offset to be applied to the input value and min/max values.

std::uint32_t	value = 0
	Raw unsigned value of the output field before scaling (unsigned 32-bit integer). Used only if variable reference attribute is NULL.

std::uint16_t	variableReference = NULL_OBJECT_ID
	Stores the object ID of a number variable that will be used as the value, or the NULL_OBJECT_ID if not used.

std::uint16_t	fontAttributes = NULL_OBJECT_ID
	Stores the object ID of a font attributes object that will be used to display this object.

std::uint8_t	numberOfDecimals = 0
	Specifies number of decimals to display after the decimal point.

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

std::uint8_t	justificationBitfield = 0
	Bitfield of justification options.

bool	format = false
	0 = use fixed format decimal display (####.nn), 1 = use exponential format ([-]###.nnE[+/-]##) where n is set by the number of decimals

Static Private Attributes
static constexpr std::uint32_t	MIN_OBJECT_LENGTH = 29
	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 used to format and output a numeric value based on a supplied integer value.

Definition at line 1820 of file isobus_virtual_terminal_objects.hpp.

Member Enumeration Documentation

◆ AttributeName

enum class isobus::OutputNumber::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 1825 of file isobus_virtual_terminal_objects.hpp.

◆ HorizontalJustification

enum class isobus::OutputNumber::HorizontalJustification : std::uint8_t

strong

The allowable horizontal justification options.

Enumerator
PositionLeft	The output number is horizontally justified to the left side of its bounding box.
PositionMiddle	The output number is horizontally justified to the center of its bounding box.
PositionRight	The output number is horizontally justified to the right side of its bounding box.
Reserved	Reserved.

Definition at line 1853 of file isobus_virtual_terminal_objects.hpp.

◆ Options

enum class isobus::OutputNumber::Options : std::uint8_t

strong

Options that can be applied to the input number.

Enumerator
Transparent	If true, the input field is displayed with background showing through instead of using the background colour.
DisplayLeadingZeros	If true, fill left to width of field with zeros; justification is applied after filling.
DisplayZeroAsBlank	When this option bit is set, a blank field is displayed if and only if the displayed value of the object is exactly zero.
Truncate	If true the value shall be truncated to the specified number of decimals. Otherwise it shall be rounded off to the specified number of decimals.

Definition at line 1844 of file isobus_virtual_terminal_objects.hpp.

◆ VerticalJustification

enum class isobus::OutputNumber::VerticalJustification : std::uint8_t

strong

The allowable vertical justification options.

Enumerator
PositionTop	The output number is vertically justified to the top of its bounding box.
PositionMiddle	The output number is vertically justified to the center of its bounding box.
PositionBottom	The output number is vertically justified to the bottom of its bounding box.
Reserved	Reserved.

Definition at line 1862 of file isobus_virtual_terminal_objects.hpp.

Member Function Documentation

◆ get_attribute()

bool isobus::OutputNumber::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 3546 of file isobus_virtual_terminal_objects.cpp.

Here is the call graph for this function:

◆ get_font_attributes()

std::uint16_t isobus::OutputNumber::get_font_attributes ( ) const

Returns the object ID of a font attributes object that defines the font attributes of the Output Number object.

Returns: The object ID of a font attributes object that defines the font attributes of the Output Number object

Definition at line 3747 of file isobus_virtual_terminal_objects.cpp.

◆ get_format()

bool isobus::OutputNumber::get_format ( ) const

Returns if the "format" option is set for this object.

The format option determines if fixed decimal or exponential notation is used. A value of false is fixed decimal notation, and true is exponential notation

Returns: true if the format option is set

Definition at line 3717 of file isobus_virtual_terminal_objects.cpp.

◆ get_horizontal_justification()

OutputNumber::HorizontalJustification isobus::OutputNumber::get_horizontal_justification ( ) const

Returns the horizontal justification of the output number within its bounding box.

Returns: The horizontal justification of the output number within its bounding box

Definition at line 3672 of file isobus_virtual_terminal_objects.cpp.

◆ get_is_valid()

bool isobus::OutputNumber::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 3369 of file isobus_virtual_terminal_objects.cpp.

Here is the call graph for this function:

◆ get_minumum_object_length()

std::uint32_t isobus::OutputNumber::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 3364 of file isobus_virtual_terminal_objects.cpp.

◆ get_number_of_decimals()

std::uint8_t isobus::OutputNumber::get_number_of_decimals ( ) const

Returns the number of decimals to render in the output number.

Returns: The number of decimals to render in the output number

Definition at line 3707 of file isobus_virtual_terminal_objects.cpp.

◆ get_object_type()

VirtualTerminalObjectType isobus::OutputNumber::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 3359 of file isobus_virtual_terminal_objects.cpp.

◆ get_offset()

std::int32_t isobus::OutputNumber::get_offset ( ) const

Returns the offset that is applied to the output number.

Returns: The offset of the output number

Definition at line 3697 of file isobus_virtual_terminal_objects.cpp.

◆ get_option()

bool isobus::OutputNumber::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 3650 of file isobus_virtual_terminal_objects.cpp.

◆ get_scale()

float isobus::OutputNumber::get_scale ( ) const

Returns the scale factor of the output number.

Returns: The scale factor of the output number

Definition at line 3687 of file isobus_virtual_terminal_objects.cpp.

◆ get_value()

std::uint32_t isobus::OutputNumber::get_value ( ) const

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

Returns: The value of the output number.

Definition at line 3727 of file isobus_virtual_terminal_objects.cpp.

◆ get_variable_reference()

std::uint16_t isobus::OutputNumber::get_variable_reference ( ) const

Returns the variable reference, which is an object ID of a number variable or NULL_OBJECT_ID (0xFFFF)

Returns: The variable reference, which is an object ID of a number variable or NULL_OBJECT_ID (0xFFFF)

Definition at line 3742 of file isobus_virtual_terminal_objects.cpp.

◆ get_vertical_justification()

OutputNumber::VerticalJustification isobus::OutputNumber::get_vertical_justification ( ) const

Returns the vertical justification of the output number within its bounding box.

Returns: The vertical justification of the output number within its bounding box

Definition at line 3677 of file isobus_virtual_terminal_objects.cpp.

◆ set_attribute()

bool isobus::OutputNumber::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 3423 of file isobus_virtual_terminal_objects.cpp.

Here is the call graph for this function:

◆ set_font_attributes()

void isobus::OutputNumber::set_font_attributes ( std::uint16_t fontAttributesValue )

Sets the object ID of a font attributes object that defines the font attributes of the Output Number object. Does no error checking on the type of the supplied object.

Parameters

[in] fontAttributesValue The object ID of a font attributes object that defines the font attributes of the Output Number object

Definition at line 3752 of file isobus_virtual_terminal_objects.cpp.

◆ set_format()

void isobus::OutputNumber::set_format ( bool shouldFormatAsExponential )

Sets the format option for this object.

The format option determines if fixed decimal or exponential notation is used. A value of false is fixed decimal notation, and true is exponential notation

Parameters

[in] shouldFormatAsExponential true to use fixed decimal notation (####.nn), false to use exponential ([−]###.nnE[+/−]##)

Definition at line 3722 of file isobus_virtual_terminal_objects.cpp.

◆ set_justification_bitfield()

void isobus::OutputNumber::set_justification_bitfield ( std::uint8_t value )

Sets the justification bitfield to a new value.

Parameters

[in] value The new value for the justification bitfield

Definition at line 3682 of file isobus_virtual_terminal_objects.cpp.

◆ set_number_of_decimals()

void isobus::OutputNumber::set_number_of_decimals ( std::uint8_t decimalValue )

Sets the number of decimals to render in the output number.

Parameters

[in] decimalValue The number of decimals to render in the output number

Definition at line 3712 of file isobus_virtual_terminal_objects.cpp.

◆ set_offset()

void isobus::OutputNumber::set_offset ( std::int32_t offsetValue )

Sets the offset of the output number.

Parameters

[in] offsetValue The offset to set for the output number

Definition at line 3702 of file isobus_virtual_terminal_objects.cpp.

◆ set_option()

void isobus::OutputNumber::set_option	(	Options	option,
		bool	value )

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

Parameters

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

Definition at line 3660 of file isobus_virtual_terminal_objects.cpp.

◆ set_options()

void isobus::OutputNumber::set_options ( std::uint8_t value )

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

Parameters

[in] value The new value for the options bitfield

Definition at line 3655 of file isobus_virtual_terminal_objects.cpp.

◆ set_scale()

void isobus::OutputNumber::set_scale ( float scaleValue )

Sets the scale factor for the output number.

Parameters

[in] scaleValue The new value for the scale factor

Definition at line 3692 of file isobus_virtual_terminal_objects.cpp.

◆ set_value()

void isobus::OutputNumber::set_value ( std::uint32_t inputValue )

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

Parameters

[in] inputValue The value to set for the output number

Definition at line 3732 of file isobus_virtual_terminal_objects.cpp.

◆ set_variable_reference()

void isobus::OutputNumber::set_variable_reference ( std::uint16_t referencedObjectID )

A dedicated way to set the stored variable reference so we don't have to worry about the child object list getting messed up from changing the attribute or a list item.

Parameters

[in] referencedObjectID The object ID of a number variable to set as the value reference

Definition at line 3737 of file isobus_virtual_terminal_objects.cpp.

Member Data Documentation

◆ fontAttributes

std::uint16_t isobus::OutputNumber::fontAttributes = NULL_OBJECT_ID

private

Stores the object ID of a font attributes object that will be used to display this object.

Definition at line 2003 of file isobus_virtual_terminal_objects.hpp.

◆ format

bool isobus::OutputNumber::format = false

private

0 = use fixed format decimal display (####.nn), 1 = use exponential format ([-]###.nnE[+/-]##) where n is set by the number of decimals

Definition at line 2007 of file isobus_virtual_terminal_objects.hpp.

◆ justificationBitfield

std::uint8_t isobus::OutputNumber::justificationBitfield = 0

private

Bitfield of justification options.

Definition at line 2006 of file isobus_virtual_terminal_objects.hpp.

◆ MIN_OBJECT_LENGTH

constexpr std::uint32_t isobus::OutputNumber::MIN_OBJECT_LENGTH = 29

staticconstexprprivate

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

Definition at line 1997 of file isobus_virtual_terminal_objects.hpp.

◆ numberOfDecimals

std::uint8_t isobus::OutputNumber::numberOfDecimals = 0

private

Specifies number of decimals to display after the decimal point.

Definition at line 2004 of file isobus_virtual_terminal_objects.hpp.

◆ offset

std::int32_t isobus::OutputNumber::offset = 0

private

Offset to be applied to the input value and min/max values.

Definition at line 2000 of file isobus_virtual_terminal_objects.hpp.

◆ optionsBitfield

std::uint8_t isobus::OutputNumber::optionsBitfield = 0

private

Bitfield of options defined in Options enum.

Definition at line 2005 of file isobus_virtual_terminal_objects.hpp.

◆ scale

float isobus::OutputNumber::scale = 1.0f

private

Scale to be applied to the input value and min/max values.

Definition at line 1999 of file isobus_virtual_terminal_objects.hpp.

◆ value

std::uint32_t isobus::OutputNumber::value = 0

private

Raw unsigned value of the output field before scaling (unsigned 32-bit integer). Used only if variable reference attribute is NULL.

Definition at line 2001 of file isobus_virtual_terminal_objects.hpp.

◆ variableReference

std::uint16_t isobus::OutputNumber::variableReference = NULL_OBJECT_ID

private

Stores the object ID of a number variable that will be used as the value, or the NULL_OBJECT_ID if not used.

Definition at line 2002 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

◆ HorizontalJustification

◆ Options

◆ VerticalJustification

Member Function Documentation

◆ get_attribute()

◆ get_font_attributes()

◆ get_format()

◆ get_horizontal_justification()

◆ get_is_valid()

◆ get_minumum_object_length()

◆ get_number_of_decimals()

◆ get_object_type()

◆ get_offset()

◆ get_option()

◆ get_scale()

◆ get_value()

◆ get_variable_reference()

◆ get_vertical_justification()

◆ set_attribute()

◆ set_font_attributes()

◆ set_format()

◆ set_justification_bitfield()

◆ set_number_of_decimals()

◆ set_offset()

◆ set_option()

◆ set_options()

◆ set_scale()

◆ set_value()

◆ set_variable_reference()

Member Data Documentation

◆ fontAttributes

◆ format

◆ justificationBitfield

◆ MIN_OBJECT_LENGTH

◆ numberOfDecimals

◆ offset

◆ optionsBitfield

◆ scale

◆ value

◆ variableReference