A DataAccessor that writes values to the Slate via its associated DataElement. More...

#include <UniversalDataWriter.h>

Inheritance diagram for UniversalDataWriter:

Collaboration diagram for UniversalDataWriter:

Public Member Functions
	UniversalDataWriter (Component owner, DataElement &element, UniversalDataElement universal, Logger::TimePrecisionType timePrecision)

virtual	~UniversalDataWriter ()

virtual bool	writeWithAccuracy (const Unit &unit, const unsigned char value, const float accuracy, const Timestamp &timestamp=Timestamp::NOT_SET_TIME)
	Sets the Component's DataValue, with precision and an optional timestamp. More...

virtual bool	writeWithAccuracy (const Unit &unit, const double value, const float accuracy, const Timestamp &timestamp=Timestamp::NOT_SET_TIME)

virtual bool	writeWithAccuracy (const Unit &unit, const int value, const float accuracy, const Timestamp &timestamp=Timestamp::NOT_SET_TIME)

virtual bool	writeWithAccuracy (const DataValue &value, const float accuracy, const Timestamp &timestamp=Timestamp::NOT_SET_TIME)

virtual bool	setAccuracy (const Unit &unit, const float value)
	Set accuracy function. More...

virtual float	getAccuracy (const Unit &unit)
	Get accuracy function For recalling the current accuracy... More...

bool	isAnyDataRequested ()
	Returns true if one of the registered readers is requesting data. More...

Public Member Functions inherited from DataWriter
	DataWriter (Component owner, DataElement &element, UniversalDataElement universal, Logger::TimePrecisionType timePrecisionType)

virtual	~DataWriter ()

bool	setUnavailable (bool unavailable=true)

bool	isUnavailable ()

bool	setInvalid (bool invalid=true)

bool	isInvalid ()

void	registerChange (void)

virtual bool	write (const Unit &unit, const unsigned char value, const Timestamp &timestamp=Timestamp::NOT_SET_TIME)
	Sets the Component's DataValue, with an optional timestamp. More...

virtual bool	write (const Unit &unit, const double value, const Timestamp &timestamp=Timestamp::NOT_SET_TIME)

virtual bool	write (const Unit &unit, const int value, const Timestamp &timestamp=Timestamp::NOT_SET_TIME)
	Set functions. More...

virtual bool	write (const DataValue &value, const Timestamp &timestamp=Timestamp::NOT_SET_TIME)

const Timestamp &	getTimestamp ()
	Returns the Timestamp of the last write. More...

bool	isDataRequested ()
	Returns true if one of the readers registered with this writer's dataElement is requesting data. More...

bool	isImplemented ()
	Returns true if there is a non-failed "implementor" reader of this writer. More...

void	componentRequestData (bool requestingData)

Public Member Functions inherited from DataAccessor
virtual	~DataAccessor ()

virtual DataElement &	getElement (void) const

virtual Component *	getOwner (void) const

virtual const ElementURI &	getUri (void) const

AccessorType	getAccessorType () const

DataAccess *	getDataAccess () const

Logger::TimePrecisionType	getTimePrecision () const

Additional Inherited Members
Public Types inherited from DataAccessor
enum	AccessorType { DATA_READER = 0, DATA_WRITER = 1 }

enum	RequestStrategy { NO_STRATEGY = -1, MIN_POWER, MIN_ERROR, MIN_LATENCY, MAX_FREQUENCY, ALL_DEVICES, STRATEGY_COUNT }

Static Public Member Functions inherited from DataAccessor
static RequestStrategy	Str2RequestStrategy (const char *const strategyStr)

static const char *	RequestStrategy2Str (DataAccessor::RequestStrategy strategy)

Static Public Attributes inherited from DataAccessor
static const char *const	REQUEST_STRATEGY_STRS [STRATEGY_COUNT]

Protected Member Functions inherited from DataAccessor
	DataAccessor (Component owner, DataElement &element, AccessorType accessorType, UniversalDataElement universal, Logger::TimePrecisionType timePrecision=Logger::TIME_PRECISION_MILLIS)
	Protected Constructor. More...

Protected Attributes inherited from DataWriter
bool	componentRequestingData_

Protected Attributes inherited from DataAccessor
Component *	owner_

DataElement &	element_

AccessorType	accessorType_

Logger::TimePrecisionType	timePrecision_

DataAccess *	dataAccess_

Detailed Description

A DataAccessor that writes values to the Slate via its associated DataElement.

Constructor & Destructor Documentation

UniversalDataWriter::UniversalDataWriter	(	Component *	owner,
		DataElement &	element,
		UniversalDataElement *	universal,
		Logger::TimePrecisionType	timePrecision
	)

UniversalDataWriter::~UniversalDataWriter ( )

virtual

Member Function Documentation

float UniversalDataWriter::getAccuracy ( const Unit & unit )

virtual

Get accuracy function For recalling the current accuracy...

References DataAccessor::element_, and DataElement::getAccuracy().

Referenced by YawRateCalculator::run(), PitchRateCalculator::run(), and DepthRateCalculator::run().

bool UniversalDataWriter::isAnyDataRequested ( )

Returns true if one of the registered readers is requesting data.

References DataAccessor::element_, DataElement::getUniversal(), and UniversalDataElement::isAnyDataRequested().

Referenced by LogSplitterComponent::run().

bool UniversalDataWriter::setAccuracy	(	const Unit &	unit,
		const float	value
	)

virtual

Set accuracy function.

References DataAccessor::element_, and DataElement::setAccuracy().

Referenced by BuoyancyServo::BuoyancyServo(), ElevatorServo::ElevatorServo(), HFRadarModelCalc::HFRadarModelCalc(), Slate::NewUniversalWriter(), PAR_Licor::PAR_Licor(), WetLabsBB2FL::readConfig(), YawRateCalculator::run(), PitchRateCalculator::run(), DepthRateCalculator::run(), Universal_Test::test1DUniversalBlobReadWrite(), Universal_Test::test3DUniversalBlobReadWrite(), Turner_Cyclops_rhodamine::Turner_Cyclops_rhodamine(), Rowe_600LCM::writeData(), and Rowe_600::writeData().

bool UniversalDataWriter::writeWithAccuracy	(	const Unit &	unit,
		const unsigned char	value,
		const float	accuracy,
		const Timestamp &	timestamp = `Timestamp::NOT_SET_TIME`
	)

virtual

Sets the Component's DataValue, with precision and an optional timestamp.

Meets reqiurement It must be possible to control (in code) how the time tag for a particular piece of data is selected.

References DataAccessor::element_, DataAccessor::owner_, DataElement::setWithAccuracy(), and Component::setWriteTimestamp().

Referenced by Navigator::evaluateAndRecordFixResidual(), HFRCMReconstructedInterpolator::publishSurfaceCurrentAtVehicleLocation(), HFRadarModelCalc::publishSurfaceCurrentAtVehicleLocation(), TempGradientCalculator::run(), SpeedCalculator::run(), HFRCMSurfaceCurrentAtVehicleLocation::run(), ValueDetect_Test::testRunDelta(), ValueDetect_Test::testRunNoDelta(), Rowe_600LCM::writeData(), Rowe_600::writeData(), and Navigator::writeVehiclePosition().

bool UniversalDataWriter::writeWithAccuracy	(	const Unit &	unit,
		const double	value,
		const float	accuracy,
		const Timestamp &	timestamp = `Timestamp::NOT_SET_TIME`
	)

virtual

References DataAccessor::element_, DataAccessor::owner_, DataElement::setWithAccuracy(), and Component::setWriteTimestamp().

bool UniversalDataWriter::writeWithAccuracy	(	const Unit &	unit,
		const int	value,
		const float	accuracy,
		const Timestamp &	timestamp = `Timestamp::NOT_SET_TIME`
	)

virtual

References DataAccessor::element_, DataAccessor::owner_, DataElement::setWithAccuracy(), and Component::setWriteTimestamp().

bool UniversalDataWriter::writeWithAccuracy	(	const DataValue &	value,
		const float	accuracy,
		const Timestamp &	timestamp = `Timestamp::NOT_SET_TIME`
	)

virtual

References DataAccessor::element_, DataAccessor::owner_, DataElement::setWithAccuracy(), and Component::setWriteTimestamp().

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

/Volumes/ubuntu_share/lrauv-application/Source/data/UniversalDataWriter.h
/Volumes/ubuntu_share/lrauv-application/Source/data/UniversalDataWriter.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation