openjaus::environment::DigitalVideoSensorCapabilitiesRecord Class Reference

#include <DigitalVideoSensorCapabilitiesRecord.h>

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

Public Member Functions
	DigitalVideoSensorCapabilitiesRecord ()
	DigitalVideoSensorCapabilitiesRecord (const DigitalVideoSensorCapabilitiesRecord &source)
	~DigitalVideoSensorCapabilitiesRecord ()
void	copy (DigitalVideoSensorCapabilitiesRecord &source)
virtual int	to (system::Buffer *dst)
	Operation to. More...
virtual int	from (system::Buffer *src)
	Operation from. More...
virtual int	length (void)
	Serializes object to internal transport buffer. 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	isMinimumFrameRateEnabled (void) const
void	enableMinimumFrameRate (void)
void	disableMinimumFrameRate (void)
bool	isMaximumFrameRateEnabled (void) const
void	enableMaximumFrameRate (void)
void	disableMaximumFrameRate (void)
bool	isSupportedFrameSizesEnabled (void) const
void	enableSupportedFrameSizes (void)
void	disableSupportedFrameSizes (void)
bool	isSupportedDigitalFormatsEnabled (void) const
void	enableSupportedDigitalFormats (void)
void	disableSupportedDigitalFormats (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	getMinimumFrameRate (void)
bool	setMinimumFrameRate (uint8_t value)
uint8_t	getMaximumFrameRate (void)
bool	setMaximumFrameRate (uint8_t value)
SupportedFrameSizesBitField &	getSupportedFrameSizes (void)
SupportedDigitalFormatsBitField &	getSupportedDigitalFormats (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
virtual	~Transportable ()
	Transportable ()

Static Public Attributes
static const uint8_t	PV_ALL_FIELDS = 0xFF
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_MINIMUMFRAMERATE = 0x4
static const uint8_t	PV_MAXIMUMFRAMERATE = 0x8
static const uint8_t	PV_SUPPORTEDFRAMESIZES = 0x10
static const uint8_t	PV_SUPPORTEDDIGITALFORMATS = 0x20

Protected Attributes
model::fields::UnsignedShort	sensorID
model::fields::UnsignedShort	minimumBitRate
model::fields::UnsignedShort	maximumBitRate
model::fields::UnsignedByte	minimumFrameRate
model::fields::UnsignedByte	maximumFrameRate
SupportedFrameSizesBitField	supportedFrameSizes
SupportedDigitalFormatsBitField	supportedDigitalFormats
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

DigitalVideoSensorCapabilitiesRecord() [1/2]

openjaus::environment::DigitalVideoSensorCapabilitiesRecord::DigitalVideoSensorCapabilitiesRecord

(

)

DigitalVideoSensorCapabilitiesRecord() [2/2]

openjaus::environment::DigitalVideoSensorCapabilitiesRecord::DigitalVideoSensorCapabilitiesRecord

(

const DigitalVideoSensorCapabilitiesRecord &

source

)

~DigitalVideoSensorCapabilitiesRecord()

openjaus::environment::DigitalVideoSensorCapabilitiesRecord::~DigitalVideoSensorCapabilitiesRecord

(

)

Member Function Documentation

copy()

void openjaus::environment::DigitalVideoSensorCapabilitiesRecord::copy

(

DigitalVideoSensorCapabilitiesRecord &

source

)

disableMaximumBitRate()

void openjaus::environment::DigitalVideoSensorCapabilitiesRecord::disableMaximumBitRate

(

void

)

disableMaximumFrameRate()

void openjaus::environment::DigitalVideoSensorCapabilitiesRecord::disableMaximumFrameRate

(

void

)

disableMinimumBitRate()

void openjaus::environment::DigitalVideoSensorCapabilitiesRecord::disableMinimumBitRate

(

void

)

disableMinimumFrameRate()

void openjaus::environment::DigitalVideoSensorCapabilitiesRecord::disableMinimumFrameRate

(

void

)

disableSupportedDigitalFormats()

void openjaus::environment::DigitalVideoSensorCapabilitiesRecord::disableSupportedDigitalFormats

(

void

)

disableSupportedFrameSizes()

void openjaus::environment::DigitalVideoSensorCapabilitiesRecord::disableSupportedFrameSizes

(

void

)

enableMaximumBitRate()

void openjaus::environment::DigitalVideoSensorCapabilitiesRecord::enableMaximumBitRate

(

void

)

enableMaximumFrameRate()

void openjaus::environment::DigitalVideoSensorCapabilitiesRecord::enableMaximumFrameRate

(

void

)

enableMinimumBitRate()

void openjaus::environment::DigitalVideoSensorCapabilitiesRecord::enableMinimumBitRate

(

void

)

enableMinimumFrameRate()

void openjaus::environment::DigitalVideoSensorCapabilitiesRecord::enableMinimumFrameRate

(

void

)

enableSupportedDigitalFormats()

void openjaus::environment::DigitalVideoSensorCapabilitiesRecord::enableSupportedDigitalFormats

(

void

)

enableSupportedFrameSizes()

void openjaus::environment::DigitalVideoSensorCapabilitiesRecord::enableSupportedFrameSizes

(

void

)

from()

int openjaus::environment::DigitalVideoSensorCapabilitiesRecord::from ( system::Buffer *  src )

virtual

Parameters

src

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

getMaximumBitRate()

uint16_t openjaus::environment::DigitalVideoSensorCapabilitiesRecord::getMaximumBitRate

(

void

)

getMaximumFrameRate()

uint8_t openjaus::environment::DigitalVideoSensorCapabilitiesRecord::getMaximumFrameRate

(

void

)

getMinimumBitRate()

uint16_t openjaus::environment::DigitalVideoSensorCapabilitiesRecord::getMinimumBitRate

(

void

)

getMinimumFrameRate()

uint8_t openjaus::environment::DigitalVideoSensorCapabilitiesRecord::getMinimumFrameRate

(

void

)

getPresenceVector()

uint8_t openjaus::environment::DigitalVideoSensorCapabilitiesRecord::getPresenceVector

(

void

)

const

getSensorID()

uint16_t openjaus::environment::DigitalVideoSensorCapabilitiesRecord::getSensorID

(

void

)

getSupportedDigitalFormats()

SupportedDigitalFormatsBitField & openjaus::environment::DigitalVideoSensorCapabilitiesRecord::getSupportedDigitalFormats

(

void

)

getSupportedFrameSizes()

SupportedFrameSizesBitField & openjaus::environment::DigitalVideoSensorCapabilitiesRecord::getSupportedFrameSizes

(

void

)

isMaximumBitRateEnabled()

bool openjaus::environment::DigitalVideoSensorCapabilitiesRecord::isMaximumBitRateEnabled

(

void

)

const

isMaximumFrameRateEnabled()

bool openjaus::environment::DigitalVideoSensorCapabilitiesRecord::isMaximumFrameRateEnabled

(

void

)

const

isMinimumBitRateEnabled()

bool openjaus::environment::DigitalVideoSensorCapabilitiesRecord::isMinimumBitRateEnabled

(

void

)

const

isMinimumFrameRateEnabled()

bool openjaus::environment::DigitalVideoSensorCapabilitiesRecord::isMinimumFrameRateEnabled

(

void

)

const

isSupportedDigitalFormatsEnabled()

bool openjaus::environment::DigitalVideoSensorCapabilitiesRecord::isSupportedDigitalFormatsEnabled

(

void

)

const

isSupportedFrameSizesEnabled()

bool openjaus::environment::DigitalVideoSensorCapabilitiesRecord::isSupportedFrameSizesEnabled

(

void

)

const

length()

int openjaus::environment::DigitalVideoSensorCapabilitiesRecord::length ( void  )

virtual

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

setMaximumBitRate()

bool openjaus::environment::DigitalVideoSensorCapabilitiesRecord::setMaximumBitRate

(

uint16_t

value

)

setMaximumFrameRate()

bool openjaus::environment::DigitalVideoSensorCapabilitiesRecord::setMaximumFrameRate

(

uint8_t

value

)

setMinimumBitRate()

bool openjaus::environment::DigitalVideoSensorCapabilitiesRecord::setMinimumBitRate

(

uint16_t

value

)

setMinimumFrameRate()

bool openjaus::environment::DigitalVideoSensorCapabilitiesRecord::setMinimumFrameRate

(

uint8_t

value

)

setPresenceVector()

void openjaus::environment::DigitalVideoSensorCapabilitiesRecord::setPresenceVector

(

uint8_t

value

)

setSensorID()

bool openjaus::environment::DigitalVideoSensorCapabilitiesRecord::setSensorID

(

uint16_t

value

)

to()

int openjaus::environment::DigitalVideoSensorCapabilitiesRecord::to ( system::Buffer *  dst )

virtual

Parameters

dst

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

toXml()

std::string openjaus::environment::DigitalVideoSensorCapabilitiesRecord::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

maximumBitRate

model::fields::UnsignedShort openjaus::environment::DigitalVideoSensorCapabilitiesRecord::maximumBitRate

protected

maximumFrameRate

model::fields::UnsignedByte openjaus::environment::DigitalVideoSensorCapabilitiesRecord::maximumFrameRate

protected

minimumBitRate

model::fields::UnsignedShort openjaus::environment::DigitalVideoSensorCapabilitiesRecord::minimumBitRate

protected

minimumFrameRate

model::fields::UnsignedByte openjaus::environment::DigitalVideoSensorCapabilitiesRecord::minimumFrameRate

protected

presenceVector

uint8_t openjaus::environment::DigitalVideoSensorCapabilitiesRecord::presenceVector

protected

PV_ALL_FIELDS

const uint8_t openjaus::environment::DigitalVideoSensorCapabilitiesRecord::PV_ALL_FIELDS = 0xFF

static

PV_MAXIMUMBITRATE

const uint8_t openjaus::environment::DigitalVideoSensorCapabilitiesRecord::PV_MAXIMUMBITRATE = 0x2

static

PV_MAXIMUMFRAMERATE

const uint8_t openjaus::environment::DigitalVideoSensorCapabilitiesRecord::PV_MAXIMUMFRAMERATE = 0x8

static

PV_MINIMUMBITRATE

const uint8_t openjaus::environment::DigitalVideoSensorCapabilitiesRecord::PV_MINIMUMBITRATE = 0x1

static

PV_MINIMUMFRAMERATE

const uint8_t openjaus::environment::DigitalVideoSensorCapabilitiesRecord::PV_MINIMUMFRAMERATE = 0x4

static

PV_NO_FIELDS

const uint8_t openjaus::environment::DigitalVideoSensorCapabilitiesRecord::PV_NO_FIELDS = 0x0

static

PV_SUPPORTEDDIGITALFORMATS

const uint8_t openjaus::environment::DigitalVideoSensorCapabilitiesRecord::PV_SUPPORTEDDIGITALFORMATS = 0x20

static

PV_SUPPORTEDFRAMESIZES

const uint8_t openjaus::environment::DigitalVideoSensorCapabilitiesRecord::PV_SUPPORTEDFRAMESIZES = 0x10

static

sensorID

model::fields::UnsignedShort openjaus::environment::DigitalVideoSensorCapabilitiesRecord::sensorID

protected

supportedDigitalFormats

SupportedDigitalFormatsBitField openjaus::environment::DigitalVideoSensorCapabilitiesRecord::supportedDigitalFormats

protected

supportedFrameSizes

SupportedFrameSizesBitField openjaus::environment::DigitalVideoSensorCapabilitiesRecord::supportedFrameSizes

protected

---

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

• include/openjaus/environment/Triggers/Fields/DigitalVideoSensorCapabilitiesRecord.h
• src/openjaus/environment/Triggers/Fields/DigitalVideoSensorCapabilitiesRecord.cpp