The Key objects contained in this object shall be a grouping of Key objects, or Object Pointers to Key objects. More...

#include <isobus_virtual_terminal_objects.hpp>

Inheritance diagram for isobus::KeyGroup:

Collaboration diagram for isobus::KeyGroup:

Public Types
enum class	AttributeName : std::uint8_t { Type = 0 , Options = 1 , Name = 2 , NumberOfAttributes = 3 }
	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 { Available = 0 , Transparent = 1 }
	Enumerates the options bits in the options bitfield of a KeyGroup. 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
	KeyGroup ()=default
	Constructor for a key group object.

	~KeyGroup () override=default
	Virtual destructor for a key group 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_key_group_icon () const
	Returns the key group icon that represents this key group.

void	set_key_group_icon (std::uint16_t value)
	Sets the object ID of the icon to use when representing this key group.

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.

std::uint16_t	get_name_object_id () const
	Sets the Object ID of an Output String object or an Object Pointer object that points to an Output String object that contains a name for this object.

void	set_name_object_id (std::uint16_t value)
	Sets the Object ID of an Output String object or an Object Pointer object that points to an Output String object that contains a name for this 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.

Static Public Attributes
static constexpr std::uint8_t	MAX_CHILD_KEYS = 4
	There shall be a max of 4 keys per group according to the standard.

Private Member Functions
bool	validate_name (std::uint16_t nameIDToValidate, const std::map< std::uint16_t, std::shared_ptr< VTObject > > &objectPool) const
	Validates that the specified name ID is valid for this object.

Private Attributes
std::uint16_t	keyGroupIcon = NULL_OBJECT_ID
	The VT may use this in the proprietary mapping screen to represent the key group.

std::uint16_t	nameID = NULL_OBJECT_ID
	Object ID of a string variable that contains the name of the key group.

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

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

The Key objects contained in this object shall be a grouping of Key objects, or Object Pointers to Key objects.

Definition at line 827 of file isobus_virtual_terminal_objects.hpp.

Member Enumeration Documentation

◆ AttributeName

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

◆ Options

enum class isobus::KeyGroup::Options : std::uint8_t

strong

Enumerates the options bits in the options bitfield of a KeyGroup.

Enumerator
Available	If 0 (FALSE) this object is not available for use at the present time, even though defined.
Transparent	If this bit is 1, the VT shall ignore the background colour attribute in all child Key objects.

Definition at line 842 of file isobus_virtual_terminal_objects.hpp.

Member Function Documentation

◆ get_attribute()

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

Here is the call graph for this function:

◆ get_is_valid()

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

Here is the call graph for this function:

◆ get_key_group_icon()

std::uint16_t isobus::KeyGroup::get_key_group_icon ( ) const

Returns the key group icon that represents this key group.

Returns: Object ID of the key group icon that represents this key group

Definition at line 1345 of file isobus_virtual_terminal_objects.cpp.

◆ get_minumum_object_length()

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

◆ get_name_object_id()

std::uint16_t isobus::KeyGroup::get_name_object_id ( ) const

Sets the Object ID of an Output String object or an Object Pointer object that points to an Output String object that contains a name for this object.

Returns: Object ID of an Output String object or an Object Pointer object that will represent the name of this key group

Definition at line 1377 of file isobus_virtual_terminal_objects.cpp.

◆ get_object_type()

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

◆ get_option()

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

◆ set_attribute()

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

◆ set_key_group_icon()

void isobus::KeyGroup::set_key_group_icon ( std::uint16_t value )

Sets the object ID of the icon to use when representing this key group.

Parameters

[in] value Object ID of a picture graphic to use as the key group icon

Definition at line 1350 of file isobus_virtual_terminal_objects.cpp.

◆ set_name_object_id()

void isobus::KeyGroup::set_name_object_id ( std::uint16_t value )

Sets the Object ID of an Output String object or an Object Pointer object that points to an Output String object that contains a name for this object.

Parameters

[in] value The object ID of the object that will represent the name of this key group, CANNOT BE the null object ID

Definition at line 1382 of file isobus_virtual_terminal_objects.cpp.

◆ set_option()

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

◆ set_options()

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

◆ validate_name()

bool isobus::KeyGroup::validate_name	(	std::uint16_t	nameIDToValidate,
		const std::map< std::uint16_t, std::shared_ptr< VTObject > > &	objectPool ) const

private

Validates that the specified name ID is valid for this object.

Parameters

[in]	nameIDToValidate	The name's object ID to validate
[in]	objectPool	The object pool to use when validating the name object

Returns: True if the name ID is valid for this object, otherwise false

Definition at line 1391 of file isobus_virtual_terminal_objects.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ keyGroupIcon

std::uint16_t isobus::KeyGroup::keyGroupIcon = NULL_OBJECT_ID

private

The VT may use this in the proprietary mapping screen to represent the key group.

Definition at line 928 of file isobus_virtual_terminal_objects.hpp.

◆ MAX_CHILD_KEYS

constexpr std::uint8_t isobus::KeyGroup::MAX_CHILD_KEYS = 4

staticconstexpr

There shall be a max of 4 keys per group according to the standard.

Definition at line 917 of file isobus_virtual_terminal_objects.hpp.

◆ MIN_OBJECT_LENGTH

constexpr std::uint32_t isobus::KeyGroup::MIN_OBJECT_LENGTH = 10

staticconstexprprivate

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

Definition at line 926 of file isobus_virtual_terminal_objects.hpp.

◆ nameID

std::uint16_t isobus::KeyGroup::nameID = NULL_OBJECT_ID

private

Object ID of a string variable that contains the name of the key group.

Definition at line 929 of file isobus_virtual_terminal_objects.hpp.

◆ optionsBitfield

std::uint8_t isobus::KeyGroup::optionsBitfield = 0

private

Bitfield of options defined in Options enum.

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

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ AttributeName

◆ Options

Member Function Documentation

◆ get_attribute()

◆ get_is_valid()

◆ get_key_group_icon()

◆ get_minumum_object_length()

◆ get_name_object_id()

◆ get_object_type()

◆ get_option()

◆ set_attribute()

◆ set_key_group_icon()

◆ set_name_object_id()

◆ set_option()

◆ set_options()

◆ validate_name()

Member Data Documentation

◆ keyGroupIcon

◆ MAX_CHILD_KEYS

◆ MIN_OBJECT_LENGTH

◆ nameID

◆ optionsBitfield