AgIsoStack++
A control-function-focused implementation of the major ISOBUS and J1939 protocols
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Attributes | Static Private Attributes | List of all members
isobus::DataMask Class Reference

The Data Mask describes the objects that will appear in the Data Mask area of the physical display. More...

#include <isobus_virtual_terminal_objects.hpp>

Inheritance diagram for isobus::DataMask:
[legend]
Collaboration diagram for isobus::DataMask:
[legend]

Public Types

enum class  AttributeName : std::uint8_t { Type = 0 , BackgroundColour = 1 , SoftKeyMask = 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...
 
- 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

 DataMask ()=default
 Constructor for a data mask object.
 
 ~DataMask () override=default
 Virtual destructor for a data 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.
 
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 data 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 data 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 data 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 softKeyMaskObjectID = NULL_OBJECT_ID
 The object ID of the soft key mask associated with this data mask.
 

Static Private Attributes

static constexpr std::uint32_t MIN_OBJECT_LENGTH = 12
 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< VTObjectget_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< ChildObjectDatachildren
 List of child objects.
 
std::vector< MacroMetadatamacros
 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 Data Mask describes the objects that will appear in the Data Mask area of the physical display.

Definition at line 444 of file isobus_virtual_terminal_objects.hpp.

Member Enumeration Documentation

◆ AttributeName

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

Member Function Documentation

◆ change_soft_key_mask()

bool isobus::DataMask::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 data 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]newMaskIDThe object ID of the new soft key mask to associate with this data mask
[in]objectPoolThe 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 555 of file isobus_virtual_terminal_objects.cpp.

◆ get_attribute()

bool isobus::DataMask::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]attributeIDThe ID of the attribute to get
[out]returnedAttributeDataThe 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 516 of file isobus_virtual_terminal_objects.cpp.

Here is the call graph for this function:

◆ get_is_valid()

bool isobus::DataMask::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]objectPoolThe object pool to use when validating the object
Returns
true if the object passed basic error checks

Implements isobus::VTObject.

Definition at line 413 of file isobus_virtual_terminal_objects.cpp.

Here is the call graph for this function:

◆ get_minumum_object_length()

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

◆ get_object_type()

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

◆ get_soft_key_mask()

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

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

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

Definition at line 579 of file isobus_virtual_terminal_objects.cpp.

◆ set_attribute()

bool isobus::DataMask::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]attributeIDThe ID of the attribute to change
[in]rawAttributeDataThe raw data to change the attribute to, as decoded in little endian format with unused bytes/bits set to zero.
[in]objectPoolThe object pool to use when validating the objects affected by setting this attribute
[out]returnedErrorIf 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 480 of file isobus_virtual_terminal_objects.cpp.

Here is the call graph for this function:

◆ set_soft_key_mask()

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

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

Parameters
[in]newMaskIDThe object ID of the new soft key mask to associate with this data mask

Definition at line 574 of file isobus_virtual_terminal_objects.cpp.

Member Data Documentation

◆ MIN_OBJECT_LENGTH

constexpr std::uint32_t isobus::DataMask::MIN_OBJECT_LENGTH = 12
staticconstexprprivate

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

Definition at line 512 of file isobus_virtual_terminal_objects.hpp.

◆ softKeyMaskObjectID

std::uint16_t isobus::DataMask::softKeyMaskObjectID = NULL_OBJECT_ID
private

The object ID of the soft key mask associated with this data mask.

Definition at line 513 of file isobus_virtual_terminal_objects.hpp.


The documentation for this class was generated from the following files: