This object holds attributes related to fonts. More...

#include <isobus_virtual_terminal_objects.hpp>

Inheritance diagram for isobus::FontAttributes:

Collaboration diagram for isobus::FontAttributes:

Public Types
enum class	AttributeName : std::uint8_t { Type = 0 , FontColour = 1 , FontSize = 2 , FontType = 3 , FontStyle = 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	FontSize : std::uint8_t { Size6x8 = 0 , Size8x8 = 1 , Size8x12 = 2 , Size12x16 = 3 , Size16x16 = 4 , Size16x24 = 5 , Size24x32 = 6 , Size32x32 = 7 , Size32x48 = 8 , Size48x64 = 9 , Size64x64 = 10 , Size64x96 = 11 , Size96x128 = 12 , Size128x128 = 13 , Size128x192 = 14 }
	Enumerates the different font sizes. More...

enum class	FontStyleBits : std::uint8_t { Bold = 0 , CrossedOut = 1 , Underlined = 2 , Italic = 3 , Inverted = 4 , Flashing = 5 , FlashingHidden = 6 , ProportionalFontRendering = 7 }
	Enumerates the font style options that can be encoded in a font style bitfield. More...

enum class	FontType : std::uint8_t { ISO8859_1 = 0 , ISO8859_15 = 1 , ISO8859_2 = 2 , Reserved_1 = 3 , ISO8859_4 = 4 , ISO8859_5 = 5 , Reserved_2 = 6 , ISO8859_7 = 7 , ReservedEnd = 239 , ProprietaryBegin = 240 , ProprietaryEnd = 255 }
	Enumerates the different font types. 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
	FontAttributes ()=default
	Constructor for a font attributes object.

	~FontAttributes () override=default
	Virtual destructor for a font attributes 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.

FontType	get_type () const
	Returns the font type associated to this font attributes object.

void	set_type (FontType value)
	Sets the font type.

std::uint8_t	get_style () const
	Returns the font style bitfield.

bool	get_style (FontStyleBits styleSetting) const
	Returns a specific font style bit's state.

void	set_style (FontStyleBits bit, bool value)
	Sets a specific font style bit to a new value.

void	set_style (std::uint8_t value)
	Sets the font style bitfield to a new value.

FontSize	get_size () const
	Returns the font size.

void	set_size (FontSize value)
	Sets the font size to a new value.

std::uint8_t	get_colour () const
	Returns the font colour as an index into the VT colour table.

void	set_colour (std::uint8_t value)
	Sets the colour of the font to a new VT colour.

std::uint8_t	get_font_width_pixels () const
	Returns the width of the associated font size in pixels.

std::uint8_t	get_font_height_pixels () const
	Returns the height of the associated font size in pixels.

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	colour = 0
	Text colour.

std::uint8_t	size = 0
	Font size.

std::uint8_t	type = 0
	Encoding type.

std::uint8_t	style = 0
	Font style.

Static Private Attributes
static constexpr std::uint32_t	MIN_OBJECT_LENGTH = 8
	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 holds attributes related to fonts.

Definition at line 3399 of file isobus_virtual_terminal_objects.hpp.

Member Enumeration Documentation

◆ AttributeName

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

◆ FontSize

enum class isobus::FontAttributes::FontSize : std::uint8_t

strong

Enumerates the different font sizes.

Enumerator
Size6x8	6x8 Font size
Size8x8	8x8 Font size
Size8x12	8x12 Font size
Size12x16	12x16 Font size
Size16x16	16x16 Font size
Size16x24	16x24 Font size
Size24x32	24x32 Font size
Size32x32	32x32 Font size
Size32x48	32x48 Font size
Size48x64	48x64 Font size
Size64x64	64x64 Font size
Size64x96	64x96 Font size
Size96x128	96x128 Font size
Size128x128	128x128 Font size
Size128x192	128x192 Font size

Definition at line 3416 of file isobus_virtual_terminal_objects.hpp.

◆ FontStyleBits

enum class isobus::FontAttributes::FontStyleBits : std::uint8_t

strong

Enumerates the font style options that can be encoded in a font style bitfield.

Enumerator
Bold	Bold font style.
CrossedOut	Crossed-out font style (strikethrough)
Underlined	Underlined font style.
Italic	Italic font style.
Inverted	Inverted font style (upside down)
Flashing	Flashing font style.
FlashingHidden	Flashing between hidden and shown font style.
ProportionalFontRendering	Enables proportional font rendering if supported by the server.

Definition at line 3436 of file isobus_virtual_terminal_objects.hpp.

◆ FontType

enum class isobus::FontAttributes::FontType : std::uint8_t

strong

Enumerates the different font types.

Enumerator
ISO8859_1	ISO Latin 1.
ISO8859_15	ISO Latin 9.
ISO8859_2	ISO Latin 2.
Reserved_1	Reserved.
ISO8859_4	ISO Latin 4.
ISO8859_5	Cyrillic.
Reserved_2	Reserved.
ISO8859_7	Greek.
ReservedEnd	Reserved from ISO8859_7 to this value.
ProprietaryBegin	The beginning of the proprietary range.
ProprietaryEnd	The end of the proprietary region.

Definition at line 3449 of file isobus_virtual_terminal_objects.hpp.

Member Function Documentation

◆ get_attribute()

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

Here is the call graph for this function:

◆ get_colour()

std::uint8_t isobus::FontAttributes::get_colour ( ) const

Returns the font colour as an index into the VT colour table.

Returns: The font colour as an index into the VT colour table

Definition at line 6701 of file isobus_virtual_terminal_objects.cpp.

◆ get_font_height_pixels()

std::uint8_t isobus::FontAttributes::get_font_height_pixels ( ) const

Returns the height of the associated font size in pixels.

Returns: The height of the associated font size in pixels

Definition at line 6788 of file isobus_virtual_terminal_objects.cpp.

◆ get_font_width_pixels()

std::uint8_t isobus::FontAttributes::get_font_width_pixels ( ) const

Returns the width of the associated font size in pixels.

Returns: The width of the associated font size in pixels

Definition at line 6711 of file isobus_virtual_terminal_objects.cpp.

◆ get_is_valid()

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

◆ get_minumum_object_length()

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

◆ get_object_type()

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

◆ get_size()

FontAttributes::FontSize isobus::FontAttributes::get_size ( ) const

Returns the font size.

Returns: The font size

Definition at line 6691 of file isobus_virtual_terminal_objects.cpp.

◆ get_style() [1/2]

std::uint8_t isobus::FontAttributes::get_style ( ) const

Returns the font style bitfield.

Returns: The style bitfield, which is comprised of FontStyleBits

Definition at line 6671 of file isobus_virtual_terminal_objects.cpp.

◆ get_style() [2/2]

bool isobus::FontAttributes::get_style ( FontStyleBits styleSetting ) const

Returns a specific font style bit's state.

Parameters

[in] styleSetting The font style bit to check

Returns: The state of the selected style bit

Definition at line 6676 of file isobus_virtual_terminal_objects.cpp.

◆ get_type()

FontAttributes::FontType isobus::FontAttributes::get_type ( ) const

Returns the font type associated to this font attributes object.

Returns: The font type associated to this font attributes object

Definition at line 6661 of file isobus_virtual_terminal_objects.cpp.

◆ set_attribute()

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

◆ set_colour()

void isobus::FontAttributes::set_colour ( std::uint8_t value )

Sets the colour of the font to a new VT colour.

Parameters

[in] value An index into the VT colour table associated to the desired colour

Definition at line 6706 of file isobus_virtual_terminal_objects.cpp.

◆ set_size()

void isobus::FontAttributes::set_size ( FontSize value )

Sets the font size to a new value.

Parameters

[in] value The new font size

Definition at line 6696 of file isobus_virtual_terminal_objects.cpp.

◆ set_style() [1/2]

void isobus::FontAttributes::set_style	(	FontStyleBits	bit,
		bool	value )

Sets a specific font style bit to a new value.

Parameters

[in]	bit	The style bit to change
[in]	value	The state to set for the selected style bit

Definition at line 6681 of file isobus_virtual_terminal_objects.cpp.

◆ set_style() [2/2]

void isobus::FontAttributes::set_style ( std::uint8_t value )

Sets the font style bitfield to a new value.

Parameters

[in] value The value to set to the font style bitfield

Definition at line 6686 of file isobus_virtual_terminal_objects.cpp.

◆ set_type()

void isobus::FontAttributes::set_type ( FontType value )

Sets the font type.

Parameters

[in] value The font type to set

Definition at line 6666 of file isobus_virtual_terminal_objects.cpp.

Member Data Documentation

◆ colour

std::uint8_t isobus::FontAttributes::colour = 0

private

Text colour.

Definition at line 3554 of file isobus_virtual_terminal_objects.hpp.

◆ MIN_OBJECT_LENGTH

constexpr std::uint32_t isobus::FontAttributes::MIN_OBJECT_LENGTH = 8

staticconstexprprivate

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

Definition at line 3552 of file isobus_virtual_terminal_objects.hpp.

◆ size

std::uint8_t isobus::FontAttributes::size = 0

private

Font size.

Definition at line 3555 of file isobus_virtual_terminal_objects.hpp.

◆ style

std::uint8_t isobus::FontAttributes::style = 0

private

Font style.

Definition at line 3557 of file isobus_virtual_terminal_objects.hpp.

◆ type

std::uint8_t isobus::FontAttributes::type = 0

private

Encoding type.

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

◆ FontSize

◆ FontStyleBits

◆ FontType

Member Function Documentation

◆ get_attribute()

◆ get_colour()

◆ get_font_height_pixels()

◆ get_font_width_pixels()

◆ get_is_valid()

◆ get_minumum_object_length()

◆ get_object_type()

◆ get_size()

◆ get_style() [1/2]

◆ get_style() [2/2]

◆ get_type()

◆ set_attribute()

◆ set_colour()

◆ set_size()

◆ set_style() [1/2]

◆ set_style() [2/2]

◆ set_type()

Member Data Documentation

◆ colour

◆ MIN_OBJECT_LENGTH

◆ size

◆ style

◆ type