#include <DigitalVideoSensorConfigurationRecord.h>

Inherits openjaus::model::fields::Record.

Public Member Functions
	DigitalVideoSensorConfigurationRecord ()

	DigitalVideoSensorConfigurationRecord (const DigitalVideoSensorConfigurationRecord &source)

	~DigitalVideoSensorConfigurationRecord ()

void	copy (DigitalVideoSensorConfigurationRecord &source)

virtual uint64	to (system::BufferWriter &dst) const
	Serializes the contents of this object into the Buffer connected to the provided BufferWriter. More...

virtual uint64	from (system::BufferReader &src)
	Deserializes the contents the Buffer connected to the provided BufferReader into this object. More...

virtual uint64	length (void) const
	Gets the serialized length of this object. More...

std::string	toXml (unsigned char ojIndentLevel=0) const

void	setPresenceVector (uint8_t value)

uint8_t	getPresenceVector (void) const

bool	isMinimumBitRateEnabled (void) const

void	enableMinimumBitRate (void)

void	disableMinimumBitRate (void)

bool	isMaximumBitRateEnabled (void) const

void	enableMaximumBitRate (void)

void	disableMaximumBitRate (void)

bool	isFrameRateEnabled (void) const

void	enableFrameRate (void)

void	disableFrameRate (void)

bool	isFrameSizeEnabled (void) const

void	enableFrameSize (void)

void	disableFrameSize (void)

bool	isDigitalFormatEnabled (void) const

void	enableDigitalFormat (void)

void	disableDigitalFormat (void)

uint16_t	getSensorID (void)

bool	setSensorID (uint16_t value)

uint16_t	getMinimumBitRate (void)

bool	setMinimumBitRate (uint16_t value)

uint16_t	getMaximumBitRate (void)

bool	setMaximumBitRate (uint16_t value)

uint8_t	getFrameRate (void)

bool	setFrameRate (uint8_t value)

FrameSizeRefEnumeration::FrameSizeRefEnum	getFrameSize (void)

bool	setFrameSize (FrameSizeRefEnumeration::FrameSizeRefEnum value)

std::string	getFrameSizeToString (void)

DigitalFormatEnumeration::DigitalFormatEnum	getDigitalFormat (void)

bool	setDigitalFormat (DigitalFormatEnumeration::DigitalFormatEnum value)

std::string	getDigitalFormatToString (void)

Public Member Functions inherited from openjaus::model::fields::Record
	Record ()

virtual	~Record ()

const std::vector< Field *> &	getFields () const
	Accessor to get the value of fields. More...

bool	setFields (const Field &fields)
	Accessor to set value of fields. More...

virtual std::string	toString () const

Public Member Functions inherited from openjaus::model::fields::ComplexField
virtual	~ComplexField ()

Public Member Functions inherited from openjaus::model::fields::Field
	Field ()

virtual	~Field ()

std::string	getName () const
	Accessor to get the value of name. More...

bool	setName (std::string name)
	Accessor to set value of name. More...

Public Member Functions inherited from openjaus::system::Transportable
	Transportable ()

virtual	~Transportable ()

Static Public Attributes
static const uint8_t	PV_NO_FIELDS = 0x0

static const uint8_t	PV_MINIMUMBITRATE = 0x1

static const uint8_t	PV_MAXIMUMBITRATE = 0x2

static const uint8_t	PV_FRAMERATE = 0x4

static const uint8_t	PV_FRAMESIZE = 0x8

static const uint8_t	PV_DIGITALFORMAT = 0x10

static const uint8_t	PV_ALL_FIELDS = PV_NO_FIELDS \| PV_MINIMUMBITRATE \| PV_MAXIMUMBITRATE \| PV_FRAMERATE \| PV_FRAMESIZE \| PV_DIGITALFORMAT

Protected Attributes
model::fields::UnsignedShort	sensorID

model::fields::UnsignedShort	minimumBitRate

model::fields::UnsignedShort	maximumBitRate

model::fields::UnsignedByte	frameRate

FrameSizeRefEnumeration	frameSize

DigitalFormatEnumeration	digitalFormat

uint8_t	presenceVector

Protected Attributes inherited from openjaus::model::fields::Record
std::vector< Field *>	fields

Protected Attributes inherited from openjaus::model::fields::Field
std::string	name

Constructor & Destructor Documentation

◆ DigitalVideoSensorConfigurationRecord() [1/2]

openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::DigitalVideoSensorConfigurationRecord ( )

◆ DigitalVideoSensorConfigurationRecord() [2/2]

openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::DigitalVideoSensorConfigurationRecord ( const DigitalVideoSensorConfigurationRecord & source )

◆ ~DigitalVideoSensorConfigurationRecord()

openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::~DigitalVideoSensorConfigurationRecord ( )

Member Function Documentation

◆ copy()

void openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::copy ( DigitalVideoSensorConfigurationRecord & source )

◆ disableDigitalFormat()

void openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::disableDigitalFormat ( void )

◆ disableFrameRate()

void openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::disableFrameRate ( void )

◆ disableFrameSize()

void openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::disableFrameSize ( void )

◆ disableMaximumBitRate()

void openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::disableMaximumBitRate ( void )

◆ disableMinimumBitRate()

void openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::disableMinimumBitRate ( void )

◆ enableDigitalFormat()

void openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::enableDigitalFormat ( void )

◆ enableFrameRate()

void openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::enableFrameRate ( void )

◆ enableFrameSize()

void openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::enableFrameSize ( void )

◆ enableMaximumBitRate()

void openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::enableMaximumBitRate ( void )

◆ enableMinimumBitRate()

void openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::enableMinimumBitRate ( void )

◆ from()

uint64 openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::from ( system::BufferReader & src )

virtual

Deserializes the contents the Buffer connected to the provided BufferReader into this object. The BufferReader position will be advanced inside this method such that calling from() again will attempt to read the next Transportable object from the Buffer.

Parameters

src

Reimplemented from openjaus::model::fields::Record.

◆ getDigitalFormat()

DigitalFormatEnumeration::DigitalFormatEnum openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::getDigitalFormat ( void )

◆ getDigitalFormatToString()

std::string openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::getDigitalFormatToString ( void )

◆ getFrameRate()

uint8_t openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::getFrameRate ( void )

◆ getFrameSize()

FrameSizeRefEnumeration::FrameSizeRefEnum openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::getFrameSize ( void )

◆ getFrameSizeToString()

std::string openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::getFrameSizeToString ( void )

◆ getMaximumBitRate()

uint16_t openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::getMaximumBitRate ( void )

◆ getMinimumBitRate()

uint16_t openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::getMinimumBitRate ( void )

◆ getPresenceVector()

uint8_t openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::getPresenceVector ( void ) const

◆ getSensorID()

uint16_t openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::getSensorID ( void )

◆ isDigitalFormatEnabled()

bool openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::isDigitalFormatEnabled ( void ) const

◆ isFrameRateEnabled()

bool openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::isFrameRateEnabled ( void ) const

◆ isFrameSizeEnabled()

bool openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::isFrameSizeEnabled ( void ) const

◆ isMaximumBitRateEnabled()

bool openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::isMaximumBitRateEnabled ( void ) const

◆ isMinimumBitRateEnabled()

bool openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::isMinimumBitRateEnabled ( void ) const

◆ length()

uint64 openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::length ( void ) const

virtual

Reimplemented from openjaus::model::fields::Record.

◆ setDigitalFormat()

bool openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::setDigitalFormat ( DigitalFormatEnumeration::DigitalFormatEnum value )

◆ setFrameRate()

bool openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::setFrameRate ( uint8_t value )

◆ setFrameSize()

bool openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::setFrameSize ( FrameSizeRefEnumeration::FrameSizeRefEnum value )

◆ setMaximumBitRate()

bool openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::setMaximumBitRate ( uint16_t value )

◆ setMinimumBitRate()

bool openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::setMinimumBitRate ( uint16_t value )

◆ setPresenceVector()

void openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::setPresenceVector ( uint8_t value )

◆ setSensorID()

bool openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::setSensorID ( uint16_t value )

◆ to()

uint64 openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::to ( system::BufferWriter & dst ) const

virtual

Serializes the contents of this object into the Buffer connected to the provided BufferWriter. The BufferWriter position will be advanced inside this method such that calling to() again will write the Transportable object into the Buffer a second time.

Parameters

dst

Reimplemented from openjaus::model::fields::Record.

◆ toXml()

std::string openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::toXml ( unsigned char ojIndentLevel = 0 ) const

Member Data Documentation

◆ digitalFormat

DigitalFormatEnumeration openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::digitalFormat

protected

◆ frameRate

model::fields::UnsignedByte openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::frameRate

protected

◆ frameSize

FrameSizeRefEnumeration openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::frameSize

protected

◆ maximumBitRate

model::fields::UnsignedShort openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::maximumBitRate

protected

◆ minimumBitRate

model::fields::UnsignedShort openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::minimumBitRate

protected

◆ presenceVector

uint8_t openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::presenceVector

protected

◆ PV_ALL_FIELDS

static

◆ PV_DIGITALFORMAT

const uint8_t openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::PV_DIGITALFORMAT = 0x10

static

◆ PV_FRAMERATE

const uint8_t openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::PV_FRAMERATE = 0x4

static

◆ PV_FRAMESIZE

const uint8_t openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::PV_FRAMESIZE = 0x8

static

◆ PV_MAXIMUMBITRATE

const uint8_t openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::PV_MAXIMUMBITRATE = 0x2

static

◆ PV_MINIMUMBITRATE

const uint8_t openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::PV_MINIMUMBITRATE = 0x1

static

◆ PV_NO_FIELDS

const uint8_t openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::PV_NO_FIELDS = 0x0

static

◆ sensorID

model::fields::UnsignedShort openjaus::environment_v1_0::DigitalVideoSensorConfigurationRecord::sensorID

protected

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

include/openjaus/environment_v1_0/Triggers/Fields/DigitalVideoSensorConfigurationRecord.h
src/openjaus/environment_v1_0/Triggers/Fields/DigitalVideoSensorConfigurationRecord.cpp

Public Member Functions

Static Public Attributes

Protected Attributes

Constructor & Destructor Documentation

◆ DigitalVideoSensorConfigurationRecord() [1/2]

◆ DigitalVideoSensorConfigurationRecord() [2/2]

◆ ~DigitalVideoSensorConfigurationRecord()

Member Function Documentation

◆ copy()

◆ disableDigitalFormat()

◆ disableFrameRate()

◆ disableFrameSize()

◆ disableMaximumBitRate()

◆ disableMinimumBitRate()

◆ enableDigitalFormat()

◆ enableFrameRate()

◆ enableFrameSize()

◆ enableMaximumBitRate()

◆ enableMinimumBitRate()

◆ from()

◆ getDigitalFormat()

◆ getDigitalFormatToString()

◆ getFrameRate()

◆ getFrameSize()

◆ getFrameSizeToString()

◆ getMaximumBitRate()

◆ getMinimumBitRate()

◆ getPresenceVector()

◆ getSensorID()

◆ isDigitalFormatEnabled()

◆ isFrameRateEnabled()

◆ isFrameSizeEnabled()

◆ isMaximumBitRateEnabled()

◆ isMinimumBitRateEnabled()

◆ length()

◆ setDigitalFormat()

◆ setFrameRate()

◆ setFrameSize()

◆ setMaximumBitRate()

◆ setMinimumBitRate()

◆ setPresenceVector()

◆ setSensorID()

◆ to()

◆ toXml()

Member Data Documentation

◆ digitalFormat

◆ frameRate

◆ frameSize

◆ maximumBitRate

◆ minimumBitRate

◆ presenceVector

◆ PV_ALL_FIELDS

◆ PV_DIGITALFORMAT

◆ PV_FRAMERATE

◆ PV_FRAMESIZE

◆ PV_MAXIMUMBITRATE

◆ PV_MINIMUMBITRATE

◆ PV_NO_FIELDS

◆ sensorID