Defines an auxiliary function type 2 object. More...

#include <isobus_virtual_terminal_objects.hpp>

Inheritance diagram for isobus::AuxiliaryFunctionType2:

Collaboration diagram for isobus::AuxiliaryFunctionType2:

Public Types
enum class	AttributeName : std::uint8_t { Type = 0 , BackgroundColour = 1 , FunctionAttributes = 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	FunctionType : std::uint8_t { BooleanLatchingOnOff = 0 , Analouge = 1 , BooleanNonLatchingIncreaseValue = 2 , AnalougeReturnTo50Percent = 3 , AnalougeReturnTo0PercentIncreaseValue = 4 , DualBooleanBothLatching = 5 , DualBooleanBothNonLatching = 6 , DualBooleanLatchingUp = 7 , DualBooleanLatchingDown = 8 , CombinedAnalougeReturnTo50PercentWithDualBooleanLatching = 9 , CombinedAnalougeMaintainsPositionWithDualBooleanLatching = 10 , QuadratureBooleanNonLatching = 11 , QuadratureAnalouge = 12 , QuadratureAnalougeReturnTo50Percent = 13 , BidirectionalEncoder = 14 , ReservedRangeStart = 15 , ReservedRangeEnd = 31 }
	Aux inputs must be one of these types, and the input and function types must match. More...

enum	FunctionAttribute { CriticalControl = 5 , AssignmentRestriction = 6 , SingleAssignment = 7 }
	Enumerates bit offsets of attributes of auxiliary functions to be assigned to an input control. 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
	AuxiliaryFunctionType2 ()=default
	Constructor for a auxiliary function type 2 object.

	~AuxiliaryFunctionType2 () override=default
	Virtual destructor for a auxiliary function type 2 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.

FunctionType	get_function_type () const
	Returns the function type.

void	set_function_type (FunctionType type)
	Sets the function type.

bool	get_function_attribute (FunctionAttribute attributeToCheck) const
	returns the value of a specified function attribute

void	set_function_attribute (FunctionAttribute attributeToSet, bool value)
	Sets the value of a specified function attribute.

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::uint8_t	functionAttributesBitfield = 0
	Bitfield of function attributes defined in `FunctionAttribute` enum plus the `FunctionType`

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

Defines an auxiliary function type 2 object.

The Auxiliary Function Type 2 object defines the function attributes and designator of an Auxiliary Function.

Definition at line 4463 of file isobus_virtual_terminal_objects.hpp.

Member Enumeration Documentation

◆ AttributeName

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

◆ FunctionAttribute

enum isobus::AuxiliaryFunctionType2::FunctionAttribute

Enumerates bit offsets of attributes of auxiliary functions to be assigned to an input control.

Enumerator
CriticalControl	If this bit is 1, This function can only be controlled by a critical Auxiliary Input (see ISO 15077)
AssignmentRestriction	If this bit is 1, This function, if assigned, can only be assigned as specified in the Preferred Assignment command.
SingleAssignment	If 1, Function shall not be assigned with other Auxiliary Functions to same input. Otherwise it can be assigned with other functions to the same input.

Definition at line 4501 of file isobus_virtual_terminal_objects.hpp.

◆ FunctionType

enum class isobus::AuxiliaryFunctionType2::FunctionType : std::uint8_t

strong

Aux inputs must be one of these types, and the input and function types must match.

This is table J.5 in ISO 11783-6 (2018)

Enumerator
BooleanLatchingOnOff	Two-position switch (maintains position) (Single Pole, Double Throw)
Analouge	Maintains position setting.
BooleanNonLatchingIncreaseValue	Two-position switch (return to off) (Momentary Single Pole, Double Throw)
AnalougeReturnTo50Percent	Two way analogue (return to centre position)
AnalougeReturnTo0PercentIncreaseValue	One way analogue input (returns to 0%)
DualBooleanBothLatching	Three-Position Switch (latching in all positions) (Single Pole, Three Position, Centre Off)
DualBooleanBothNonLatching	Three-Position Switch, (returning to centre position) (Momentary Single Pole, Three Position, Centre Off)
DualBooleanLatchingUp	Three-Position Switch, latching in up position, momentary down (Single Pole, Three Position, Centre Off)
DualBooleanLatchingDown	Three-Position Switch, latching in down position, momentary up (Single Pole, Three Position, Centre Off)
CombinedAnalougeReturnTo50PercentWithDualBooleanLatching	Two way analogue (return to centre position) with latching Boolean at 0% and 100% positions.
CombinedAnalougeMaintainsPositionWithDualBooleanLatching	Analogue maintains position setting with latching Boolean at 0% and 100% positions.
QuadratureBooleanNonLatching	Two quadrature mounted Three-Position Switches, (returning to centre position) (Momentary Single Pole, Three Position, Centre Off)
QuadratureAnalouge	Two quadrature mounted analogue maintain position setting. The centre position of each analogue axis is at 50 % value.
QuadratureAnalougeReturnTo50Percent	Two quadrature mounted analogue returns to centre position (The centre position of each analogue axis is at 50 %)
BidirectionalEncoder	Count increases when turning in the encoders "increase" direction and count decreases when turning in the opposite direction.
ReservedRangeStart	Reserved for future use.
ReservedRangeEnd	Used for Remove assignment command.

Definition at line 4479 of file isobus_virtual_terminal_objects.hpp.

Member Function Documentation

◆ get_attribute()

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

Here is the call graph for this function:

◆ get_function_attribute()

bool isobus::AuxiliaryFunctionType2::get_function_attribute ( FunctionAttribute attributeToCheck ) const

returns the value of a specified function attribute

Parameters

[in] attributeToCheck The function attribute to check

Returns: The value of a specified function attribute

Definition at line 8460 of file isobus_virtual_terminal_objects.cpp.

◆ get_function_type()

AuxiliaryFunctionType2::FunctionType isobus::AuxiliaryFunctionType2::get_function_type ( ) const

Returns the function type.

Returns: The function type

Definition at line 8449 of file isobus_virtual_terminal_objects.cpp.

◆ get_is_valid()

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

Here is the call graph for this function:

◆ get_minumum_object_length()

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

◆ get_object_type()

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

◆ set_attribute()

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

Here is the call graph for this function:

◆ set_function_attribute()

void isobus::AuxiliaryFunctionType2::set_function_attribute	(	FunctionAttribute	attributeToSet,
		bool	value )

Sets the value of a specified function attribute.

Parameters

[in]	attributeToSet	The function attribute to set
[in]	value	The value to set the function attribute to

Definition at line 8465 of file isobus_virtual_terminal_objects.cpp.

◆ set_function_type()

void isobus::AuxiliaryFunctionType2::set_function_type ( FunctionType type )

Sets the function type.

Parameters

[in] type The function type

Definition at line 8454 of file isobus_virtual_terminal_objects.cpp.

Member Data Documentation

◆ functionAttributesBitfield

std::uint8_t isobus::AuxiliaryFunctionType2::functionAttributesBitfield = 0

private

Bitfield of function attributes defined in FunctionAttribute enum plus the FunctionType

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

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ AttributeName

◆ FunctionAttribute

◆ FunctionType

Member Function Documentation

◆ get_attribute()

◆ get_function_attribute()

◆ get_function_type()

◆ get_is_valid()

◆ get_minumum_object_length()

◆ get_object_type()

◆ set_attribute()

◆ set_function_attribute()

◆ set_function_type()

Member Data Documentation

◆ functionAttributesBitfield