SettingReader Class Reference

Reads values from mission settings. More...

#include <SettingReader.h>

Collaboration diagram for SettingReader:

Public Member Functions
	SettingReader (const SettingURI &settingURI, ValueClause *valueClause)
virtual	~SettingReader ()
bool	isActive ()
	Status and state functions. More...
bool	read (const Unit &unit, unsigned char &readTo)
	Get functions. More...
bool	read (const Unit &unit, double &readTo)
bool	read (const Unit &unit, float &readTo)
bool	read (const Unit &unit, int &readTo)
bool	read (bool &readTo)
bool	read (Timespan &readTo)
bool	read (DataValue &readTo)
int	asInt (const Unit &unit)
double	asDouble (const Unit &unit) __attribute__((deprecated))
Str	asString (const Unit &unit)
const SettingURI &	getSettingURI ()
const DataValue *	getDefaultValue ()
const Unit *	getDefaultUnit ()

Protected Member Functions
bool	evalValueClause ()

Protected Attributes
const SettingURI	settingURI_
const DataValue *	defaultValue_
bool	deleteDefaultValue_
ValueClause *	valueClause_

Private Member Functions
	SettingReader (const SettingReader &old)
	SettingReader (const SettingURI &settingURI, const DataValue *defaultValue, bool deleteDefaultValue=true)
void	setDefaultValue (const DataValue *defaultValue, bool deleteDefaultValue=true)
void	setValueClause (ValueClause *valueClause)

Friends
class	Behavior

Detailed Description

Reads values from mission settings.

Constructor & Destructor Documentation

SettingReader::SettingReader	(	const SettingURI &	settingURI,
		ValueClause *	valueClause
	)

SettingReader::~SettingReader ( )

virtual

References defaultValue_, deleteDefaultValue_, and valueClause_.

SettingReader::SettingReader ( const SettingReader &  old )

private

SettingReader::SettingReader ( const SettingURI &  settingURI, const DataValue *  defaultValue, bool  deleteDefaultValue = true  )

private

Member Function Documentation

double SettingReader::asDouble

(

const Unit &

unit

)

References read().

int SettingReader::asInt

(

const Unit &

unit

)

References read().

Str SettingReader::asString

(

const Unit &

unit

)

References Str::EMPTY_STR, evalValueClause(), ValueClause::getDataValue(), DataValue::toString(), and valueClause_.

Referenced by Execute::initialize(), PeakDetectHorizontal::initialize(), PeakDetectVsDepth::initialize(), and ValueDetect::initialize().

bool SettingReader::evalValueClause ( )

protected

References defaultValue_, ValueClause::eval(), ValueClause::evalStr(), DataValue::getBinaryType(), isActive(), MULTIVALUE, and valueClause_.

Referenced by asString(), and read().

const Unit * SettingReader::getDefaultUnit

(

)

References defaultValue_, and DataValue::getUnit().

Referenced by LuaAPI::Exec(), ValueDetect::initialize(), and DepthEnvelope::readParams().

const DataValue* SettingReader::getDefaultValue ( )

inline

References defaultValue_.

const SettingURI& SettingReader::getSettingURI ( )

inline

References settingURI_.

Referenced by MissionItem::initializeFromScript().

bool SettingReader::isActive

(

void

)

Status and state functions.

References ValueClause::getDataValue(), and valueClause_.

Referenced by evalValueClause(), Circle::initialize(), Waypoint::initialize(), PeakDetectHorizontal::initialize(), PeakDetectVsDepth::initialize(), HFRadarModelPoint::initialize(), ValueDetect::initialize(), DepthEnvelope::initialize(), ZigZag::initialize(), Lane::initialize(), DepthEnvelope::projectDepth(), ValueDetect::readParams(), DepthEnvelope::readParams(), ZigZag::readSettings(), AltitudeEnvelope::readSettings(), YoYo::readSettings(), DepthEnvelope::readSettings(), ReinitializeHFRCMVirtualSurfaceDrifter::run(), Circle::run(), Wait::runIfUnsatisfied(), AltitudeEnvelope::runIfUnsatisfied(), DepthEnvelope::runIfUnsatisfied(), and DepthEnvelope::uninitialize().

bool SettingReader::read	(	const Unit &	unit,
		unsigned char &	readTo
	)

Get functions.

References DataValue::copyTo(), evalValueClause(), ValueClause::getDataValue(), and valueClause_.

Referenced by asDouble(), asInt(), PeakDetectVsDepth::calcSatisfied(), Buoyancy::calcSatisfied(), LuaAPI::Exec(), SetSpeed::initialize(), Point::initialize(), Circle::initialize(), Waypoint::initialize(), PeakDetectHorizontal::initialize(), PeakDetectVsDepth::initialize(), ValueDetect::initialize(), HFRadarModelPoint::initialize(), GoToSurface::loadParams(), HFRadarModelPoint::makeFine(), ValueDetect::readParams(), OffshoreEnvelope::readParams(), WaterDepthEnvelope::readParams(), DepthEnvelope::readParams(), Pitch::readSettings(), KeepStation::readSettings(), Lane::readSettings(), DepthServo::readSettings(), PitchServo::readSettings(), ZigZag::readSettings(), Tracking::readSettings(), AltitudeEnvelope::readSettings(), DepthEnvelope::readSettings(), YoYo::readSettings(), Buoyancy::run(), ReinitializeHFRCMVirtualSurfaceDrifter::run(), Circle::run(), and Wait::runIfUnsatisfied().

bool SettingReader::read	(	const Unit &	unit,
		double &	readTo
	)

References DataValue::copyTo(), evalValueClause(), ValueClause::getDataValue(), and valueClause_.

bool SettingReader::read	(	const Unit &	unit,
		float &	readTo
	)

References DataValue::copyTo(), evalValueClause(), ValueClause::getDataValue(), and valueClause_.

bool SettingReader::read	(	const Unit &	unit,
		int &	readTo
	)

References DataValue::copyTo(), evalValueClause(), ValueClause::getDataValue(), and valueClause_.

bool SettingReader::read

(

bool &

readTo

)

References Units::BOOL, DataValue::copyTo(), evalValueClause(), ValueClause::getDataValue(), and valueClause_.

bool SettingReader::read

(

Timespan &

readTo

)

References DataValue::copyTo(), ValueClause::getDataValue(), Units::SECOND, Timespan::Seconds(), and valueClause_.

bool SettingReader::read

(

DataValue &

readTo

)

References DataValue::copyTo(), evalValueClause(), ValueClause::getDataValue(), and valueClause_.

void SettingReader::setDefaultValue ( const DataValue *  defaultValue, bool  deleteDefaultValue = true  )

inlineprivate

Referenced by Behavior::newSettingReader().

void SettingReader::setValueClause ( ValueClause *  valueClause )

inlineprivate

Referenced by Behavior::addValueClause().

Friends And Related Function Documentation

friend class Behavior

friend

Member Data Documentation

const DataValue* SettingReader::defaultValue_

protected

Referenced by evalValueClause(), getDefaultUnit(), getDefaultValue(), and ~SettingReader().

bool SettingReader::deleteDefaultValue_

protected

Referenced by ~SettingReader().

const SettingURI SettingReader::settingURI_

protected

Referenced by getSettingURI().

ValueClause* SettingReader::valueClause_

protected

Referenced by asString(), evalValueClause(), isActive(), read(), and ~SettingReader().

---

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

• /Volumes/ubuntu_share/lrauv-application/Source/missionScript/SettingReader.h
• /Volumes/ubuntu_share/lrauv-application/Source/missionScript/SettingReader.cpp