This object is used to output a string of text. More...

#include <isobus_virtual_terminal_objects.hpp>

Inheritance diagram for isobus::OutputString:

Collaboration diagram for isobus::OutputString:

Public Types
enum class	AttributeName : std::uint8_t { Type = 0 , Width = 1 , Height = 2 , BackgroundColour = 3 , FontAttributes = 4 , Options = 5 , VariableReference = 6 , Justification = 7 , NumberOfAttributes = 8 }
	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 { Transparent = 0 , AutoWrap = 1 , WrapOnHyphen = 2 }
	Enumerates the option bits in the options bitfield for an output string. 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
	OutputString ()=default
	Constructor for an output string object.

	~OutputString () override=default
	Virtual destructor for an output string 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 string within its bounding box.

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

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

std::string	get_value () const
	Returns the value of the string, used only if the variable reference (a child var string) is NULL_OBJECT_ID.

void	set_value (const std::string &value)
	Sets the value of the string (only matters if it has no child string variable)

std::uint16_t	get_font_attributes () const
	Returns the object ID of a font attributes object that defines the font attributes of the Output String 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 String object. Does no error checking on the type of the supplied object.

std::uint16_t	get_variable_reference () const
	Returns the object ID of a string variable object that contains the value of the Output String object.

void	set_variable_reference (std::uint16_t variableReferenceValue)
	Sets the object ID of a string variable object that contains the value of the Output String 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
std::string	stringValue
	The actual string. Used only if variable reference attribute is NULL. Pad with spaces as necessary to satisfy length attribute.

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::uint16_t	variableReference = NULL_OBJECT_ID
	Stores the object ID of a string variable object that will be used in place of the string value attribute if it is not NULL_OBJECT_ID.

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

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

Static Private Attributes
static constexpr std::uint32_t	MIN_OBJECT_LENGTH = 16
	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 output a string of text.

Definition at line 1675 of file isobus_virtual_terminal_objects.hpp.

Member Enumeration Documentation

◆ AttributeName

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

◆ HorizontalJustification

enum class isobus::OutputString::HorizontalJustification : std::uint8_t

strong

The allowable horizontal justification options.

Enumerator
PositionLeft	Output string is horizontally aligned to the left of its bounding box.
PositionMiddle	Output string is horizontally aligned to the center of its bounding box.
PositionRight	Output string is horizontally aligned to the right of its bounding box.
Reserved	Reserved.

Definition at line 1703 of file isobus_virtual_terminal_objects.hpp.

◆ Options

enum class isobus::OutputString::Options

strong

Enumerates the option bits in the options bitfield for an output string.

Enumerator
Transparent	If TRUE, the output field is displayed with background showing through instead of using the background colour.
AutoWrap	Auto-Wrapping rules apply.
WrapOnHyphen	If TRUE, Auto-Wrapping can occur between a hyphen and the next character.

Definition at line 1695 of file isobus_virtual_terminal_objects.hpp.

◆ VerticalJustification

enum class isobus::OutputString::VerticalJustification : std::uint8_t

strong

The allowable vertical justification options.

Enumerator
PositionTop	Output string is vertically aligned to the top of its bounding box.
PositionMiddle	Output string is vertically aligned to the center of its bounding box.
PositionBottom	Output string is vertically aligned to the bottom of its bounding box.
Reserved	Reserved.

Definition at line 1712 of file isobus_virtual_terminal_objects.hpp.

Member Function Documentation

◆ get_attribute()

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

Here is the call graph for this function:

◆ get_font_attributes()

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

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

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

Definition at line 3339 of file isobus_virtual_terminal_objects.cpp.

◆ get_horizontal_justification()

OutputString::HorizontalJustification isobus::OutputString::get_horizontal_justification ( ) const

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

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

Definition at line 3314 of file isobus_virtual_terminal_objects.cpp.

◆ get_is_valid()

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

Here is the call graph for this function:

◆ get_minumum_object_length()

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

◆ get_object_type()

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

◆ get_option()

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

◆ get_value()

std::string isobus::OutputString::get_value ( ) const

Returns the value of the string, used only if the variable reference (a child var string) is NULL_OBJECT_ID.

Returns: The value of the string

Definition at line 3329 of file isobus_virtual_terminal_objects.cpp.

◆ get_variable_reference()

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

Returns the object ID of a string variable object that contains the value of the Output String object.

Returns: The object ID of a string variable object that contains the value of the Output String object

Definition at line 3349 of file isobus_virtual_terminal_objects.cpp.

◆ get_vertical_justification()

OutputString::VerticalJustification isobus::OutputString::get_vertical_justification ( ) const

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

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

Definition at line 3319 of file isobus_virtual_terminal_objects.cpp.

◆ set_attribute()

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

Here is the call graph for this function:

◆ set_font_attributes()

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

Sets the object ID of a font attributes object that defines the font attributes of the Output String 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 String object

Definition at line 3344 of file isobus_virtual_terminal_objects.cpp.

◆ set_justification_bitfield()

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

Sets the justification bitfield for the object to a new value.

Parameters

[in] value The new value for the justification bitfield

Definition at line 3324 of file isobus_virtual_terminal_objects.cpp.

◆ set_option()

void isobus::OutputString::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 3302 of file isobus_virtual_terminal_objects.cpp.

◆ set_options()

void isobus::OutputString::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 3297 of file isobus_virtual_terminal_objects.cpp.

◆ set_value()

void isobus::OutputString::set_value ( const std::string & value )

Sets the value of the string (only matters if it has no child string variable)

Parameters

[in] value The new value for the string

Definition at line 3334 of file isobus_virtual_terminal_objects.cpp.

◆ set_variable_reference()

void isobus::OutputString::set_variable_reference ( std::uint16_t variableReferenceValue )

Sets the object ID of a string variable object that contains the value of the Output String object. Does no error checking on the type of the supplied object.

Parameters

[in] variableReferenceValue The object ID of a string variable object that contains the value of the Output String object

Definition at line 3354 of file isobus_virtual_terminal_objects.cpp.

Member Data Documentation

◆ fontAttributes

std::uint16_t isobus::OutputString::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 1813 of file isobus_virtual_terminal_objects.hpp.

◆ justificationBitfield

std::uint8_t isobus::OutputString::justificationBitfield = 0

private

Bitfield of justification options.

Definition at line 1816 of file isobus_virtual_terminal_objects.hpp.

◆ MIN_OBJECT_LENGTH

constexpr std::uint32_t isobus::OutputString::MIN_OBJECT_LENGTH = 16

staticconstexprprivate

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

Definition at line 1810 of file isobus_virtual_terminal_objects.hpp.

◆ optionsBitfield

std::uint8_t isobus::OutputString::optionsBitfield = 0

private

Bitfield of options defined in Options enum.

Definition at line 1815 of file isobus_virtual_terminal_objects.hpp.

◆ stringValue

std::string isobus::OutputString::stringValue

private

The actual string. Used only if variable reference attribute is NULL. Pad with spaces as necessary to satisfy length attribute.

Definition at line 1812 of file isobus_virtual_terminal_objects.hpp.

◆ variableReference

std::uint16_t isobus::OutputString::variableReference = NULL_OBJECT_ID

private

Stores the object ID of a string variable object that will be used in place of the string value attribute if it is not NULL_OBJECT_ID.

Definition at line 1814 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_horizontal_justification()

◆ get_is_valid()

◆ get_minumum_object_length()

◆ get_object_type()

◆ get_option()

◆ get_value()

◆ get_variable_reference()

◆ get_vertical_justification()

◆ set_attribute()

◆ set_font_attributes()

◆ set_justification_bitfield()

◆ set_option()

◆ set_options()

◆ set_value()

◆ set_variable_reference()

Member Data Documentation

◆ fontAttributes

◆ justificationBitfield

◆ MIN_OBJECT_LENGTH

◆ optionsBitfield

◆ stringValue

◆ variableReference