Similar to a data mask, but takes priority and will be shown over data masks. More...

#include <isobus_virtual_terminal_objects.hpp>

Inheritance diagram for isobus::AlarmMask:

Collaboration diagram for isobus::AlarmMask:

Public Types
enum class	AttributeName : std::uint8_t { Type = 0 , BackgroundColour = 1 , SoftKeyMask = 2 , Priority = 3 , AcousticSignal = 4 , NumberOfAttributes = 5 }
	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	Priority : std::uint8_t { High = 0 , Medium = 1 , Low = 2 }
	Enumerates the different mask priorities. Higher priority masks will be shown over lower priority ones across all working sets. More...

enum class	AcousticSignal : std::uint8_t { Highest = 0 , Medium = 1 , Lowest = 3 , None = 4 }
	Enumerates the acoustic signal values for the alarm mask. Works only if your VT has a way to make sounds. 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
	AlarmMask ()=default
	Constructor for a alarm mask object.

	~AlarmMask () override=default
	Virtual destructor for a alarm mask 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.

Priority	get_mask_priority () const
	Returns the priority of the alarm mask.

void	set_mask_priority (Priority value)
	Sets the priority of the alarm mask.

AcousticSignal	get_signal_priority () const
	Returns the acoustic signal priority for the alarm mask.

void	set_signal_priority (AcousticSignal value)
	Sets the acoustic signal priority for the alarm mask.

bool	change_soft_key_mask (std::uint16_t newMaskID, const std::map< std::uint16_t, std::shared_ptr< VTObject > > &objectPool)
	Changes the soft key mask associated to this alarm mask to a new object ID. Performs error checking on the type of the assigned object to ensure it is a soft key mask.

void	set_soft_key_mask (std::uint16_t newMaskID)
	Changes the soft key mask associated to this alarm mask to a new object ID, but does no checking on the validity of the new object ID.

std::uint16_t	get_soft_key_mask () const
	Returns the object ID of the soft key mask associated with this alarm mask.

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	softKeyMask = NULL_OBJECT_ID
	Object ID of a soft key mask for this alarm mask, or the null ID.

Priority	maskPriority = Priority::High
	The priority of this mask.

AcousticSignal	signalPriority = AcousticSignal::Highest
	The acoustic signal priority for this mask.

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

Similar to a data mask, but takes priority and will be shown over data masks.

Definition at line 517 of file isobus_virtual_terminal_objects.hpp.

Member Enumeration Documentation

◆ AcousticSignal

enum class isobus::AlarmMask::AcousticSignal : std::uint8_t

strong

Enumerates the acoustic signal values for the alarm mask. Works only if your VT has a way to make sounds.

The result of this setting is somewhat proprietary depending on your VT

Enumerator
Highest	Most aggressive beeping.
Medium	Medium beeping.
Lowest	Low beeping.
None	No beeping.

Definition at line 543 of file isobus_virtual_terminal_objects.hpp.

◆ AttributeName

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

◆ Priority

enum class isobus::AlarmMask::Priority : std::uint8_t

strong

Enumerates the different mask priorities. Higher priority masks will be shown over lower priority ones across all working sets.

Enumerator
High	High, operator is in danger or urgent machine malfunction.
Medium	Medium, normal alarm, machine is malfunctioning.
Low	Low, information only.

Definition at line 534 of file isobus_virtual_terminal_objects.hpp.

Member Function Documentation

◆ change_soft_key_mask()

bool isobus::AlarmMask::change_soft_key_mask	(	std::uint16_t	newMaskID,
		const std::map< std::uint16_t, std::shared_ptr< VTObject > > &	objectPool )

Changes the soft key mask associated to this alarm mask to a new object ID. Performs error checking on the type of the assigned object to ensure it is a soft key mask.

Parameters

[in]	newMaskID	The object ID of the new soft key mask to associate with this data mask
[in]	objectPool	The object pool to use when validating the objects affected by setting this attribute

Returns: True if the mask was changed, false if the new ID was not valid and the mask was not changed

Definition at line 785 of file isobus_virtual_terminal_objects.cpp.

◆ get_attribute()

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

Here is the call graph for this function:

◆ get_is_valid()

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

Here is the call graph for this function:

◆ get_mask_priority()

AlarmMask::Priority isobus::AlarmMask::get_mask_priority ( ) const

Returns the priority of the alarm mask.

Higher priority masks will be shown over lower priority ones.

Returns: The priority of the alarm mask

Definition at line 765 of file isobus_virtual_terminal_objects.cpp.

◆ get_minumum_object_length()

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

◆ get_object_type()

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

◆ get_signal_priority()

AlarmMask::AcousticSignal isobus::AlarmMask::get_signal_priority ( ) const

Returns the acoustic signal priority for the alarm mask.

Controls how aggressive the beep is on VTs with a speaker or whistle chip.

Returns: The acoustic signal priority of the alarm mask

Definition at line 775 of file isobus_virtual_terminal_objects.cpp.

◆ get_soft_key_mask()

std::uint16_t isobus::AlarmMask::get_soft_key_mask ( ) const

Returns the object ID of the soft key mask associated with this alarm mask.

Returns: The object ID of the soft key mask associated with this alarm mask

Definition at line 808 of file isobus_virtual_terminal_objects.cpp.

◆ set_attribute()

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

Here is the call graph for this function:

◆ set_mask_priority()

void isobus::AlarmMask::set_mask_priority ( Priority value )

Sets the priority of the alarm mask.

Higher priority masks will be shown over lower priority ones.

Parameters

[in] value The priority to set

Definition at line 770 of file isobus_virtual_terminal_objects.cpp.

◆ set_signal_priority()

void isobus::AlarmMask::set_signal_priority ( AcousticSignal value )

Sets the acoustic signal priority for the alarm mask.

Controls how aggressive the beep is on VTs with a speaker or whistle chip.

Parameters

value The acoustic signal priority to set

Definition at line 780 of file isobus_virtual_terminal_objects.cpp.

◆ set_soft_key_mask()

void isobus::AlarmMask::set_soft_key_mask ( std::uint16_t newMaskID )

Changes the soft key mask associated to this alarm mask to a new object ID, but does no checking on the validity of the new object ID.

Parameters

[in] newMaskID The object ID of the new soft key mask to associate with this alarm mask

Definition at line 803 of file isobus_virtual_terminal_objects.cpp.

Member Data Documentation

◆ maskPriority

Priority isobus::AlarmMask::maskPriority = Priority::High

private

The priority of this mask.

Definition at line 628 of file isobus_virtual_terminal_objects.hpp.

◆ MIN_OBJECT_LENGTH

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

staticconstexprprivate

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

Definition at line 625 of file isobus_virtual_terminal_objects.hpp.

◆ signalPriority

AcousticSignal isobus::AlarmMask::signalPriority = AcousticSignal::Highest

private

The acoustic signal priority for this mask.

Definition at line 629 of file isobus_virtual_terminal_objects.hpp.

◆ softKeyMask

std::uint16_t isobus::AlarmMask::softKeyMask = NULL_OBJECT_ID

private

Object ID of a soft key mask for this alarm mask, or the null ID.

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

◆ AcousticSignal

◆ AttributeName

◆ Priority

Member Function Documentation

◆ change_soft_key_mask()

◆ get_attribute()

◆ get_is_valid()

◆ get_mask_priority()

◆ get_minumum_object_length()

◆ get_object_type()

◆ get_signal_priority()

◆ get_soft_key_mask()

◆ set_attribute()

◆ set_mask_priority()

◆ set_signal_priority()

◆ set_soft_key_mask()

Member Data Documentation

◆ maskPriority

◆ MIN_OBJECT_LENGTH

◆ signalPriority

◆ softKeyMask