This object displays a picture graphic (bitmap) More...

#include <isobus_virtual_terminal_objects.hpp>

Inheritance diagram for isobus::PictureGraphic:

Collaboration diagram for isobus::PictureGraphic:

Public Types
enum class	AttributeName : std::uint8_t { Type = 0 , Width = 1 , Options = 2 , TransparencyColour = 3 , ActualWidth = 4 , ActualHeight = 5 , Format = 6 , NumberOfAttributes = 7 }
	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	Format { Monochrome = 0 , FourBitColour = 1 , EightBitColour = 2 }
	Enumerates the different colour formats a picture graphic can have (mutually exclusive) More...

enum class	Options { Transparent = 0 , Flashing = 1 , RunLengthEncoded = 2 }
	Enumerates the different options bits in the options bitfield. 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
	PictureGraphic ()=default
	Constructor for a picture graphic (bitmap) object.

	~PictureGraphic () override=default
	Virtual destructor for a picture graphic (bitmap) 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::vector< std::uint8_t > &	get_raw_data ()
	Returns a reference to the underlying bitmap data.

void	set_raw_data (const std::uint8_t *data, std::uint32_t size)
	Sets a large chunk of data to the underlying bitmap.

void	add_raw_data (std::uint8_t dataByte)
	Sets one byte of raw data to the underlying bitmap.

std::uint32_t	get_number_of_bytes_in_raw_data () const
	Returns the number of bytes in the raw data that comprises the underlying bitmap.

void	set_number_of_bytes_in_raw_data (std::uint32_t value)
	Sets the number of bytes in the raw data that comprises the underlying bitmap.

std::uint16_t	get_actual_width () const
	Returns the actual width of the underlying bitmap.

void	set_actual_width (std::uint16_t value)
	Sets the actual width of the underlying bitmap.

std::uint16_t	get_actual_height () const
	Returns the actual height of the underlying bitmap.

void	set_actual_height (std::uint16_t value)
	Sets the actual height of the underlying bitmap.

Format	get_format () const
	Returns the picture's colour format.

void	set_format (Format value)
	Sets the picture's colour format.

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::uint8_t	get_transparency_colour () const
	Returns the transparency colour to use when rendering the object as an index into the VT colour table.

void	set_transparency_colour (std::uint8_t value)
	Sets the transparency colour to use when rendering the object as an index into the VT colour table.

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::vector< std::uint8_t >	rawData
	The raw picture data. Not a standard bitmap, but rather indicies into the VT colour table.

std::uint32_t	numberOfBytesInRawData = 0
	Number of bytes of raw data.

std::uint16_t	actualWidth = 0
	The actual width of the bitmap.

std::uint16_t	actualHeight = 0
	The actual height of the bitmap.

std::uint8_t	formatByte = 0
	The format option byte.

std::uint8_t	optionsBitfield = 0
	Options bitfield, see the `options` enum.

std::uint8_t	transparencyColour = 0
	The colour to render as transparent if so set in the options.

Static Private Attributes
static constexpr std::uint32_t	MIN_OBJECT_LENGTH = 17
	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 displays a picture graphic (bitmap)

Definition at line 3119 of file isobus_virtual_terminal_objects.hpp.

Member Enumeration Documentation

◆ AttributeName

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

◆ Format

enum class isobus::PictureGraphic::Format

strong

Enumerates the different colour formats a picture graphic can have (mutually exclusive)

Enumerator
Monochrome	Monochrome; 8 pixels per byte. Each bit represents a colour palette index of 0 or 1.
FourBitColour	2 colour pixels per byte. Each nibble(4 bits) represents a colour palette index of 0 through 15.
EightBitColour	colour pixel per byte. Each byte represents a colour palette index of 0 through 255

Definition at line 3138 of file isobus_virtual_terminal_objects.hpp.

◆ Options

enum class isobus::PictureGraphic::Options

strong

Enumerates the different options bits in the options bitfield.

Enumerator
Transparent	0 = Opaque, 1 = Transparent
Flashing	0 = Normal, 1 = Flashing
RunLengthEncoded	Data is RLE See Clause B.12.2 Picture Graphic object raw data format and compression.

Definition at line 3146 of file isobus_virtual_terminal_objects.hpp.

Member Function Documentation

◆ add_raw_data()

void isobus::PictureGraphic::add_raw_data ( std::uint8_t dataByte )

Sets one byte of raw data to the underlying bitmap.

Parameters

[in] dataByte One byte of bitmap data

Definition at line 6339 of file isobus_virtual_terminal_objects.cpp.

◆ get_actual_height()

std::uint16_t isobus::PictureGraphic::get_actual_height ( ) const

Returns the actual height of the underlying bitmap.

Returns: The actual height of the underlying bitmap (px)

Definition at line 6365 of file isobus_virtual_terminal_objects.cpp.

◆ get_actual_width()

std::uint16_t isobus::PictureGraphic::get_actual_width ( ) const

Returns the actual width of the underlying bitmap.

Returns: The actual width of the underlying bitmap (px)

Definition at line 6355 of file isobus_virtual_terminal_objects.cpp.

◆ get_attribute()

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

Here is the call graph for this function:

◆ get_format()

PictureGraphic::Format isobus::PictureGraphic::get_format ( ) const

Returns the picture's colour format.

Returns: The picture colour format

Definition at line 6375 of file isobus_virtual_terminal_objects.cpp.

◆ get_is_valid()

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

◆ get_minumum_object_length()

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

◆ get_number_of_bytes_in_raw_data()

std::uint32_t isobus::PictureGraphic::get_number_of_bytes_in_raw_data ( ) const

Returns the number of bytes in the raw data that comprises the underlying bitmap.

Returns: The number of bytes in the raw data that comprises the underlying bitmap

Definition at line 6344 of file isobus_virtual_terminal_objects.cpp.

◆ get_object_type()

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

◆ get_option()

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

◆ get_raw_data()

std::vector< std::uint8_t > & isobus::PictureGraphic::get_raw_data ( )

Returns a reference to the underlying bitmap data.

Returns: A reference to the underlying bitmap data

Definition at line 6323 of file isobus_virtual_terminal_objects.cpp.

◆ get_transparency_colour()

std::uint8_t isobus::PictureGraphic::get_transparency_colour ( ) const

Returns the transparency colour to use when rendering the object as an index into the VT colour table.

Returns: Transparency colour to use when rendering the object as an index into the VT colour table

Definition at line 6407 of file isobus_virtual_terminal_objects.cpp.

◆ set_actual_height()

void isobus::PictureGraphic::set_actual_height ( std::uint16_t value )

Sets the actual height of the underlying bitmap.

Parameters

[in] value Actual height to set for the underlying bitmap (px)

Definition at line 6370 of file isobus_virtual_terminal_objects.cpp.

◆ set_actual_width()

void isobus::PictureGraphic::set_actual_width ( std::uint16_t value )

Sets the actual width of the underlying bitmap.

Parameters

[in] value Actual width to set for the underlying bitmap (px)

Definition at line 6360 of file isobus_virtual_terminal_objects.cpp.

◆ set_attribute()

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

Here is the call graph for this function:

◆ set_format()

void isobus::PictureGraphic::set_format ( Format value )

Sets the picture's colour format.

Parameters

[in] value The colour format to use for this picture graphic

Definition at line 6380 of file isobus_virtual_terminal_objects.cpp.

◆ set_number_of_bytes_in_raw_data()

void isobus::PictureGraphic::set_number_of_bytes_in_raw_data ( std::uint32_t value )

Sets the number of bytes in the raw data that comprises the underlying bitmap.

Parameters

[in] value The number of bytes in the raw data that comprises the underlying bitmap

Definition at line 6349 of file isobus_virtual_terminal_objects.cpp.

◆ set_option()

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

◆ set_options()

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

◆ set_raw_data()

void isobus::PictureGraphic::set_raw_data	(	const std::uint8_t *	data,
		std::uint32_t	size )

Sets a large chunk of data to the underlying bitmap.

Parameters

[in]	data	Pointer to a buffer of data
[in]	size	The length of the data buffer to add to the underlying bitmap

Definition at line 6328 of file isobus_virtual_terminal_objects.cpp.

◆ set_transparency_colour()

void isobus::PictureGraphic::set_transparency_colour ( std::uint8_t value )

Sets the transparency colour to use when rendering the object as an index into the VT colour table.

Parameters

[in] value The colour to use when rendering the object as an index into the VT colour table

Definition at line 6412 of file isobus_virtual_terminal_objects.cpp.

Member Data Documentation

◆ actualHeight

std::uint16_t isobus::PictureGraphic::actualHeight = 0

private

The actual height of the bitmap.

Definition at line 3263 of file isobus_virtual_terminal_objects.hpp.

◆ actualWidth

std::uint16_t isobus::PictureGraphic::actualWidth = 0

private

The actual width of the bitmap.

Definition at line 3262 of file isobus_virtual_terminal_objects.hpp.

◆ formatByte

std::uint8_t isobus::PictureGraphic::formatByte = 0

private

The format option byte.

Definition at line 3264 of file isobus_virtual_terminal_objects.hpp.

◆ MIN_OBJECT_LENGTH

constexpr std::uint32_t isobus::PictureGraphic::MIN_OBJECT_LENGTH = 17

staticconstexprprivate

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

Definition at line 3258 of file isobus_virtual_terminal_objects.hpp.

◆ numberOfBytesInRawData

std::uint32_t isobus::PictureGraphic::numberOfBytesInRawData = 0

private

Number of bytes of raw data.

Definition at line 3261 of file isobus_virtual_terminal_objects.hpp.

◆ optionsBitfield

std::uint8_t isobus::PictureGraphic::optionsBitfield = 0

private

Options bitfield, see the options enum.

Definition at line 3265 of file isobus_virtual_terminal_objects.hpp.

◆ rawData

std::vector<std::uint8_t> isobus::PictureGraphic::rawData

private

The raw picture data. Not a standard bitmap, but rather indicies into the VT colour table.

Definition at line 3260 of file isobus_virtual_terminal_objects.hpp.

◆ transparencyColour

std::uint8_t isobus::PictureGraphic::transparencyColour = 0

private

The colour to render as transparent if so set in the options.

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

◆ Format

◆ Options

Member Function Documentation

◆ add_raw_data()

◆ get_actual_height()

◆ get_actual_width()

◆ get_attribute()

◆ get_format()

◆ get_is_valid()

◆ get_minumum_object_length()

◆ get_number_of_bytes_in_raw_data()

◆ get_object_type()

◆ get_option()

◆ get_raw_data()

◆ get_transparency_colour()

◆ set_actual_height()

◆ set_actual_width()

◆ set_attribute()

◆ set_format()

◆ set_number_of_bytes_in_raw_data()

◆ set_option()

◆ set_options()

◆ set_raw_data()

◆ set_transparency_colour()

Member Data Documentation

◆ actualHeight

◆ actualWidth

◆ formatByte

◆ MIN_OBJECT_LENGTH

◆ numberOfBytesInRawData

◆ optionsBitfield

◆ rawData

◆ transparencyColour