kdrive::baos::bindings::BaosDatapointDescription Class Reference

A BaosDatapointDescription contains information about a Datapoint Value More...

#include <BaosDatapointDescriptions.h>

Public Types
enum	TransmitPriority { TransmitPriority::System = unmanaged::BaosDatapointDescription::System, TransmitPriority::Alarm = unmanaged::BaosDatapointDescription::Alarm, TransmitPriority::High = unmanaged::BaosDatapointDescription::High, TransmitPriority::Low = unmanaged::BaosDatapointDescription::Low }
	Transmit priority More...
enum	ValueTypes {   ValueTypes::Bit1 = unmanaged::BaosDatapointDescription::Bit1, ValueTypes::Bit2 = unmanaged::BaosDatapointDescription::Bit2, ValueTypes::Bit3 = unmanaged::BaosDatapointDescription::Bit3, ValueTypes::Bit4 = unmanaged::BaosDatapointDescription::Bit4,   ValueTypes::Bit5 = unmanaged::BaosDatapointDescription::Bit5, ValueTypes::Bit6 = unmanaged::BaosDatapointDescription::Bit6, ValueTypes::Bit7 = unmanaged::BaosDatapointDescription::Bit7, ValueTypes::Byte1 = unmanaged::BaosDatapointDescription::Byte1,   ValueTypes::Byte2 = unmanaged::BaosDatapointDescription::Byte2, ValueTypes::Byte3 = unmanaged::BaosDatapointDescription::Byte3, ValueTypes::Byte4 = unmanaged::BaosDatapointDescription::Byte4, ValueTypes::Byte6 = unmanaged::BaosDatapointDescription::Byte6,   ValueTypes::Byte8 = unmanaged::BaosDatapointDescription::Byte8, ValueTypes::Byte10 = unmanaged::BaosDatapointDescription::Byte10, ValueTypes::Byte14 = unmanaged::BaosDatapointDescription::Byte14 }
	BAOS data point value types More...

Public Member Functions
	BaosDatapointDescription ()
	Default Constructor. More...
	BaosDatapointDescription (unsigned short id, unsigned char valueType, unsigned char configFlags, unsigned char datapointType)
	Constructor. More...
	~BaosDatapointDescription ()
	Destroys the BaosDatapointDescription. More...
unsigned short	getId ()
	Gets the data point id. More...
unsigned char	getConfigFlags ()
	Gets the config flags More...
unsigned char	getTransmitPriority ()
	Gets the transmit priority More...
bool	isCommunication ()
	Returns true if the communication flag is set. More...
bool	isReadFromBus ()
	Returns true if the read from bus flag is set. More...
bool	isWriteFromBus ()
	Returns true if the write from bus flag is set. More...
bool	isClientTransmitRequest ()
	Returns true if the transmit to bus flag is set. More...
bool	isUpdateOnResponse ()
	Returns true if the update on response flag is set. More...
unsigned char	getValueType ()
	Gets the value type. More...
unsigned char	getValueTypeSizeBits ()
	Gets the value type in size in bits More...
unsigned char	getValueTypeSizeBytes ()
	Gets the value type in size in bytes. More...
bool	isBitType ()
	Returns true if the value type is samller than 1 byte. More...
bool	isByteType ()
	Returns true if the value type is greater than 1 byte. More...
unsigned char	getDatapointType ()
	Gets the datapoint type. More...

Protected Member Functions
	!BaosDatapointDescription ()
	Finalizer (non-deterministic destructor) cleans up unmanaged resources. More...

Detailed Description

A BaosDatapointDescription contains information about a Datapoint Value

Interprets the data point description data. You can read a BaosDatapointDescription using the BaosDatapointDescriptions class.

A Datapoint Description has four attributes:

• data point id
• data point value type : indicates the data point value size
• data point config flags : indicate the communication flags set in the ETS project
• data point type : Protocol Version 1.2 does not support data point type (it will always be 0)

Member Enumeration Documentation

enum kdrive::baos::bindings::BaosDatapointDescription::TransmitPriority

strong

Transmit priority

Enumerator
System
Alarm
High
Low

enum kdrive::baos::bindings::BaosDatapointDescription::ValueTypes

strong

BAOS data point value types

Enumerator
Bit1	1 bit
Bit2	2 bits
Bit3	3 bits
Bit4	4 bits
Bit5	5 bits
Bit6	6 bits
Bit7	7 bits
Byte1	1 byte
Byte2	2 bytes
Byte3	3 bytes
Byte4	4 bytes
Byte6	6 bytes
Byte8	8 bytes
Byte10	10 bytes
Byte14	14 bytes

Constructor & Destructor Documentation

kdrive::baos::bindings::BaosDatapointDescription::BaosDatapointDescription

(

)

Default Constructor.

kdrive::baos::bindings::BaosDatapointDescription::BaosDatapointDescription	(	unsigned short	id,
		unsigned char	valueType,
		unsigned char	configFlags,
		unsigned char	datapointType
	)

Constructor.

kdrive::baos::bindings::BaosDatapointDescription::~BaosDatapointDescription

(

)

Destroys the BaosDatapointDescription.

Destructor cleans up unmanaged and managed resources.

kdrive::baos::bindings::BaosDatapointDescription::!BaosDatapointDescription ( )

protected

Finalizer (non-deterministic destructor) cleans up unmanaged resources.

Member Function Documentation

unsigned char kdrive::baos::bindings::BaosDatapointDescription::getConfigFlags

(

)

Gets the config flags

See also

getTransmitPriority, isCommunication, isReadFromBus, isWriteFromBus, isClientTransmitRequest, isUpdateOnResponse

unsigned char kdrive::baos::bindings::BaosDatapointDescription::getDatapointType

(

)

Gets the datapoint type.

See also

BaosDatapointTypes

unsigned short kdrive::baos::bindings::BaosDatapointDescription::getId

(

)

Gets the data point id.

unsigned char kdrive::baos::bindings::BaosDatapointDescription::getTransmitPriority

(

)

Gets the transmit priority

See also

TransmitPriority

unsigned char kdrive::baos::bindings::BaosDatapointDescription::getValueType

(

)

Gets the value type.

See also

ValueTypes

unsigned char kdrive::baos::bindings::BaosDatapointDescription::getValueTypeSizeBits

(

)

Gets the value type in size in bits

See also

getValueType

unsigned char kdrive::baos::bindings::BaosDatapointDescription::getValueTypeSizeBytes

(

)

Gets the value type in size in bytes.

Values which are smaller than 1 byte e.g. 2 bits returns 1.

See also

getValueType

bool kdrive::baos::bindings::BaosDatapointDescription::isBitType

(

)

Returns true if the value type is samller than 1 byte.

Otherwise returns false.

See also

getValueType

bool kdrive::baos::bindings::BaosDatapointDescription::isByteType

(

)

Returns true if the value type is greater than 1 byte.

Otherwise returns false.

See also

getValueType

bool kdrive::baos::bindings::BaosDatapointDescription::isClientTransmitRequest

(

)

Returns true if the transmit to bus flag is set.

Otherwise returns false.

bool kdrive::baos::bindings::BaosDatapointDescription::isCommunication

(

)

Returns true if the communication flag is set.

Otherwise returns false.

bool kdrive::baos::bindings::BaosDatapointDescription::isReadFromBus

(

)

Returns true if the read from bus flag is set.

Otherwise returns false.

bool kdrive::baos::bindings::BaosDatapointDescription::isUpdateOnResponse

(

)

Returns true if the update on response flag is set.

Otherwise returns false.

bool kdrive::baos::bindings::BaosDatapointDescription::isWriteFromBus

(

)

Returns true if the write from bus flag is set.

Otherwise returns false.

---

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

• BaosDatapointDescriptions.h