An object for storing information regarding an object pool upload. More...

#include <isobus_virtual_terminal_client.hpp>

Public Attributes
const std::uint8_t *	objectPoolDataPointer
	A pointer to an object pool.

const std::vector< std::uint8_t > *	objectPoolVectorPointer
	A pointer to an object pool (vector format)

std::vector< std::uint8_t >	scaledObjectPool
	Stores a copy of a pool to auto-scale in RAM before uploading it.

DataChunkCallback	dataCallback
	A callback used to get data in chunks as an alternative to loading the whole pool at once.

std::string	versionLabel
	An optional version label that will be used to load/store the pool to the VT. 7 character max!

std::uint32_t	objectPoolSize
	The size of the object pool.

std::uint32_t	autoScaleDataMaskOriginalDimension
	The original length or width of this object pool's data mask area (in pixels)

std::uint32_t	autoScaleSoftKeyDesignatorOriginalHeight
	The original height of a soft key designator as designed in the pool (in pixels)

bool	useDataCallback
	Determines if the client will use callbacks to get the data in chunks.

bool	uploaded
	The upload state of this pool.

Detailed Description

An object for storing information regarding an object pool upload.

Definition at line 1309 of file isobus_virtual_terminal_client.hpp.

Member Data Documentation

◆ autoScaleDataMaskOriginalDimension

std::uint32_t isobus::VirtualTerminalClient::ObjectPoolDataStruct::autoScaleDataMaskOriginalDimension

The original length or width of this object pool's data mask area (in pixels)

Definition at line 1317 of file isobus_virtual_terminal_client.hpp.

◆ autoScaleSoftKeyDesignatorOriginalHeight

std::uint32_t isobus::VirtualTerminalClient::ObjectPoolDataStruct::autoScaleSoftKeyDesignatorOriginalHeight

The original height of a soft key designator as designed in the pool (in pixels)

Definition at line 1318 of file isobus_virtual_terminal_client.hpp.

◆ dataCallback

DataChunkCallback isobus::VirtualTerminalClient::ObjectPoolDataStruct::dataCallback

A callback used to get data in chunks as an alternative to loading the whole pool at once.

Definition at line 1314 of file isobus_virtual_terminal_client.hpp.

◆ objectPoolDataPointer

const std::uint8_t* isobus::VirtualTerminalClient::ObjectPoolDataStruct::objectPoolDataPointer

A pointer to an object pool.

Definition at line 1311 of file isobus_virtual_terminal_client.hpp.

◆ objectPoolSize

std::uint32_t isobus::VirtualTerminalClient::ObjectPoolDataStruct::objectPoolSize

The size of the object pool.

Definition at line 1316 of file isobus_virtual_terminal_client.hpp.

◆ objectPoolVectorPointer

const std::vector<std::uint8_t>* isobus::VirtualTerminalClient::ObjectPoolDataStruct::objectPoolVectorPointer

A pointer to an object pool (vector format)

Definition at line 1312 of file isobus_virtual_terminal_client.hpp.

◆ scaledObjectPool

std::vector<std::uint8_t> isobus::VirtualTerminalClient::ObjectPoolDataStruct::scaledObjectPool

Stores a copy of a pool to auto-scale in RAM before uploading it.

Definition at line 1313 of file isobus_virtual_terminal_client.hpp.

◆ uploaded

bool isobus::VirtualTerminalClient::ObjectPoolDataStruct::uploaded

The upload state of this pool.

Definition at line 1320 of file isobus_virtual_terminal_client.hpp.

◆ useDataCallback

bool isobus::VirtualTerminalClient::ObjectPoolDataStruct::useDataCallback

Determines if the client will use callbacks to get the data in chunks.

Definition at line 1319 of file isobus_virtual_terminal_client.hpp.

◆ versionLabel

std::string isobus::VirtualTerminalClient::ObjectPoolDataStruct::versionLabel

An optional version label that will be used to load/store the pool to the VT. 7 character max!

Definition at line 1315 of file isobus_virtual_terminal_client.hpp.

The documentation for this struct was generated from the following file:

isobus/include/isobus/isobus/isobus_virtual_terminal_client.hpp

Public Attributes