Software interface to Neil Brown CTD. More...

#include <Turbulence_NPS.h>

Inheritance diagram for Turbulence_NPS:

Collaboration diagram for Turbulence_NPS:

Public Member Functions
	Turbulence_NPS (const Module *module)

virtual	~Turbulence_NPS ()

virtual void	run ()
	The actual "payload" of the component. More...

virtual RunState	start ()
	Do what needs to be done to run Similar to initialize, in old init/run/uninit sequence. More...

virtual RunState	starting ()
	Might follow a STOP...START sequence. More...

virtual RunState	pause ()
	Pause for a short period (indicated by pauseTime) More...

virtual RunState	paused ()
	Should eventually follow a PAUSE request: should set continueTime. More...

virtual RunState	resume ()
	Resume from PAUSE. More...

virtual RunState	resuming ()
	Might follow a PAUSE...RESUME sequence. More...

virtual RunState	runnable ()
	Should eventually follow a START request or RESETTING. More...

virtual RunState	resetting ()
	Might occur in case of Error. More...

virtual RunState	stop ()
	Initial state – can be later followed by START. More...

virtual RunState	stopping ()
	Might follow a STOP request. More...

virtual RunState	stopped ()
	Initial state – can be later followed by START. More...

void	uninitialize ()
	Provide a space for uninitialization. More...

virtual ConfigURI	getConfigURI (ConfigOption configOption) const
	Should return [myNamespace]::SIMULATE_HARDWARE, or [myNamespace]::POWER, etc. More...

Public Member Functions inherited from AsyncComponent
bool	isIdlePriority ()

Public Member Functions inherited from Component
virtual	~Component ()
	Destructor cleans up readers_ and writers_. More...

void	registerReader (DataReader *reader)

void	unregisterReader (DataReader *reader)

void	registerWriter (DataWriter *writer)

void	unregisterWriter (DataWriter *writer)

void	disableMetering (void)

FlexArray< DataReader * > &	getReaderList (void)

FlexArray< DataWriter * > &	getWriterList (void)

const Module *	getModule ()

virtual void	initialize ()
	Provide a space for initialization before being run. More...

virtual void	configure ()
	Read (or re-read!) configuration settings. More...

virtual void	execute (void)

bool	isActive () const
	Indicates if the component is active. More...

const CodedStr &	getName (void) const
	Returns the name. More...

const Timestamp &	getTimeOfLastRun (void) const

ComponentState	getState (void)
	Return the component's current state. More...

void	setState (ComponentState state)

RunState	getRunState (void)
	Return the component's run state. More...

bool	isUsingRunState ()
	Return true if using runState. More...

void	requestData (bool requestingData)
	Tell the component to start (or stop) sending data. More...

void	requestStart ()
	Tell the component to start runnning. More...

void	requestPause (const Timespan expectedPauseTime)
	Tell the component to pause runnning. More...

void	requestResume ()
	Tell the component resume from pause. More...

void	requestStop ()
	Tell the component to stop runnning. More...

virtual RunState	satisfied ()
	Possible return value of a Behavior. More...

virtual RunState	pausing ()
	Might follow a PAUSE request. More...

void	setCriticalFailureReported (bool boolVal)

void	setRecoveringFromCritical (bool boolVal)

void	setFailureReported (bool boolVal)

bool	isFailureUninitialized ()

void	setFailureUninitialized (bool boolVal)

void	setRetryTimeout (const Timespan &timeout)

virtual bool	isCompleted (void)
	Query if this component is completed. More...

void	setPeriod (const Timespan &period)
	Set the period of this component... used if it is periodic. More...

const Timespan &	getPeriod (void)
	Returns the component's period (regardless of whether it is periodic) More...

ComponentType	getComponentType ()
	Getter function for ComponentType. More...

virtual bool	isFailed (void) const

virtual FailureMode::FailType	getFailureType (void) const

virtual bool	getCriticalFailureReported (void) const

virtual bool	getFailureReported (void) const

virtual Timespan	getRetryTimeout (void) const

virtual FailureMode::FailType	setFailure (FailureMode::FailType failureType)

virtual int	getFailCount (void) const

virtual bool	isFailureMissionCritical ()

virtual int	getAllowableFailures (void) const

virtual void	setAllowableFailures (int fails)

Logger &	getLogger (void)

virtual int	incrementFailCount (void)

virtual void	resetFailCount (void)

virtual int	getSkippedRunsSinceFail (void) const

virtual int	incrementSkippedRunsSinceFail (void)

virtual void	logVoltage (float voltage, float averageVoltage)

virtual void	logCurrent (float current, float averageCurrent)

const Timestamp &	getWriteTimestamp (void)

void	setWriteTimestamp (const Timestamp &writeTimestamp)

BlobReader *	newBlobReader (const BlobURI &blobURI)

BlobReader *	newBlobReaderFromUniversal (const Str &componentName, const UniversalBlobURI &blobURI)

BlobWriter *	newBlobWriter (const BlobURI &blobURI, Logger::TimePrecisionType timePrecision=Logger::TIME_PRECISION_MILLIS)

ConfigReader *	newConfigReader (const ConfigURI &configURI)

DataReader *	newDataReader (const DataURI &dataURI)

DataReader *	newDataReaderFromUniversal (const Str &componentName, const UniversalURI &universalURI)

DataWriter *	newDataWriter (const DataURI &dataURI, Logger::TimePrecisionType timePrecision=Logger::TIME_PRECISION_MILLIS)

UniversalBlobReader *	newUniversalBlobReader (const UniversalBlobURI &universalURI)

UniversalBlobWriter *	newUniversalBlobWriter (const UniversalBlobURI &universalURI, const Unit &accuracyUnit=Units::NONE, const float accuracy=DataElement::NO_ACCURACY, Logger::TimePrecisionType timePrecision=Logger::TIME_PRECISION_MILLIS)

UniversalDataReader *	newUniversalReader (const UniversalURI &universalURI)

UniversalDataWriter *	newUniversalWriter (const UniversalURI &universalURI, const Unit &accuracyUnit=Units::NONE, const float accuracy=DataElement::NO_ACCURACY, Logger::TimePrecisionType timePrecision=Logger::TIME_PRECISION_MILLIS)

Private Member Functions
	Turbulence_NPS (const Turbulence_NPS &old)

bool	isDataRequested ()

void	writeData ()

void	receive ()

Private Attributes
DataReader *	gfScanActiveReader_

BlobWriter *	microTemp1Writer_

BlobWriter *	microCondWriter_

BlobWriter *	microTemp2Writer_

DataWriter *	numTCSamplesWriter_

BlobWriter *	acmPathWriter_

DataWriter *	rollWriter_

DataWriter *	pitchWriter_

DataWriter *	yawWriter_

DataWriter *	deltaXVelocityWriter_

DataWriter *	deltaYVelocityWriter_

DataWriter *	deltaZVelocityWriter_

BlobWriter *	fwdSigStrengthWriter_

DataWriter *	packetNumWriter_

short	shortBuffer_ [34]

bool	debug_

bool	firstPacket_

LoadControl	loadControl_

Timespan	sensorTimeout_

Timespan	pausePeriod_

Timestamp	startTime_

char	deviceResponse_ [512]

UartStream	uart_

Additional Inherited Members
Public Types inherited from Component
enum	ComponentState { BLOCK_CONTINUOUS, BLOCK_PERIODIC, BLOCK_NORMAL, BLOCK_COMPLETED, BLOCK_UNKNOWN }
	In this model, the component has basically two states: wanting to run, and completed (no longer needing to run). More...

enum	ComponentType { COMPONENT_ASYNC, COMPONENT_CONFIG, COMPONENT_BEHAVIOR, COMPONENT_SYNC }
	Components can indicate how they want to be handled by their type. More...

enum	RunState { NO_RUN_STATE = 0, START, STARTING, RUNNABLE, SATISFIED, PAUSE, PAUSING, PAUSED, RESUME, RESUMING, RESETTING, STOP, STOPPING, STOPPED }

Protected Types inherited from Component
enum	ConfigOption { CONFIG_SIMULATE_HARDWARE, CONFIG_POWER, CONFIG_FREQUENCY, CONFIG_LATENCY }

Protected Member Functions inherited from AsyncComponent
	AsyncComponent (const Str &name, const Module *module, const Timespan period, bool idlePriority=false)
	Protected constructor for components that run in periodic asynchronous threads. More...

	AsyncComponent (const Str &name, const Module *module, bool idlePriority=false)
	Protected constructor for components that run in continuous asynchronous threads. More...

Protected Member Functions inherited from Component
virtual ConfigURI	getConfigURI (ConfigOption configOption, ElementURI forElement) const
	Should return [myNamespace]::POWER_[forElement], [myNamespace]::LATENCY_[forElement], etc. More...

virtual void	setDurationOfLastRun (const Timespan &span)

virtual void	setTimeOfRun (const Timestamp &time)

virtual void	setTimeOfLastRun (const Timestamp &time)

virtual void	setDt (const Timespan &dt)

virtual bool	setEnabled (bool enabled=true)

void	setRunState (const RunState runState)

const Timespan	getPauseTime () const

virtual void	setFailureMissionCritical (bool failureMissionCritical)

bool	simulateHardware ()

Protected Attributes inherited from AsyncComponent
bool	idlePriority_

Protected Attributes inherited from Component
Logger	logger_

Syslog::Severity	debugLevel_

ComponentState	state_
	Keep track of whether the component has "completed" or should be run again. More...

Timespan	desiredPeriod_

CodedStr &	name_
	Store the component's name (used for logging purposes) More...

Timestamp	timeOfRun_

Timestamp	timeOfLastRun_

Timespan	durationOfLastRun_

Timespan	dt_

Timespan	retryTimeout_

bool	enabled_

bool	failureReported_
	Indicates if the failure has been reported – cuts down on syslog. More...

bool	criticalFailureReported_
	Indicates if a "Critical" failure has been reported – cuts down on syslog. More...

bool	recoveringFromCritical_
	Indicates that a component had a previous critical failure that has been cleared temporarily awaiting final word from the component itself. More...

bool	failureUninitialized_
	Indicates if the failure has resulted in an uninitialize call. More...

int	failCount_
	Number of failures logged by PCaller. More...

bool	failureMissionCritical_
	If true (default), complete failure ends mission. More...

int	allowableFailures_
	Number of failures allowed to occur. More...

int	skippedRunsSinceFail_
	Number of skipped runs since failureMode_ set by failCount_. More...

FailureMode::FailType	failureType_
	Failed status. If failCount_ > 0, then this may be reset. More...

Timestamp	timeOfFailure_
	Time of last failure. Relevant only if failed=true. More...

Timestamp	writeTimestamp_
	Time of last write. More...

FlexArray< DataReader * >	readers_

FlexArray< DataWriter * >	writers_

const Module *	module_

Timespan	pauseTime_

bool	meteringEnabled_
	If true, metering is enabled. More...

DataWriter *	durationOfLastRunWriter_
	Writer for durationOfLastRun. More...

DataWriter *	voltageWriter_

DataWriter *	avgVoltageWriter_

DataWriter *	currentWriter_

DataWriter *	avgCurrentWriter_

bool	persistentPause_
	True if data is persistent while component is paused. More...

Detailed Description

Software interface to Neil Brown CTD.

Also provides interface to SimSlate for providing simulated temperature, salinity, and depth.

Note: still needs to be coded for the actual Neil Brown CTD

Turbulence_NPS.h should only be included by Turbulence_NPS.cpp Other classes should include Turbulence_NPSIF.h

Constructor & Destructor Documentation

Turbulence_NPS::~Turbulence_NPS ( )

virtual

Turbulence_NPS::Turbulence_NPS ( const Turbulence_NPS & old )

private

Member Function Documentation

ConfigURI Turbulence_NPS::getConfigURI ( ConfigOption configOption ) const

virtual

Should return [myNamespace]::SIMULATE_HARDWARE, or [myNamespace]::POWER, etc.

Reimplemented from Component.

References Component::CONFIG_POWER, Component::CONFIG_SIMULATE_HARDWARE, and ConfigURI::NO_CONFIG_URI.

bool Turbulence_NPS::isDataRequested ( )

private

References DataWriter::isDataRequested(), microCondWriter_, microTemp1Writer_, and microTemp2Writer_.

Referenced by paused(), runnable(), and stopped().

Component::RunState Turbulence_NPS::pause ( )

virtual

Pause for a short period (indicated by pauseTime)

Reimplemented from Component.

References UartStream::close(), Syslog::FAULT, FailureMode::HARDWARE, Syslog::INFO, loadControl_, Component::logger_, Component::PAUSED, pitchWriter_, LoadControl::powerDown(), rollWriter_, Component::setFailure(), DataWriter::setInvalid(), Component::simulateHardware(), Component::STOP, Logger::syslog(), uart_, and yawWriter_.

Component::RunState Turbulence_NPS::paused ( )

virtual

Should eventually follow a PAUSE request: should set continueTime.

Reimplemented from Component.

References debug_, Syslog::INFO, isDataRequested(), Component::logger_, Component::PAUSED, pausePeriod_, resume(), Timespan::sleepFor(), and Logger::syslog().

void Turbulence_NPS::receive ( )

private

virtual RunState Turbulence_NPS::resetting ( )

inlinevirtual

Might occur in case of Error.

Reimplemented from Component.

References stop().

Component::RunState Turbulence_NPS::resume ( )

virtual

Resume from PAUSE.

Reimplemented from Component.

References FailureMode::COMMUNICATIONS, Syslog::ERROR, UartStream::errorString(), Syslog::FAULT, firstPacket_, FailureMode::HARDWARE, UartStream::hasError(), Syslog::INFO, loadControl_, Component::logger_, UartStream::open(), LoadControl::powerUp(), Component::RESUMING, Component::setFailure(), Component::simulateHardware(), Component::STOP, Logger::syslog(), and uart_.

Referenced by paused().

Component::RunState Turbulence_NPS::resuming ( )

virtual

Might follow a PAUSE...RESUME sequence.

Reimplemented from Component.

References debug_, Syslog::INFO, Component::logger_, Timestamp::Now(), Component::RUNNABLE, startTime_, and Logger::syslog().

void Turbulence_NPS::run ( void )

virtual

The actual "payload" of the component.

Reimplemented from Component.

Component::RunState Turbulence_NPS::runnable ( )

virtual

Should eventually follow a START request or RESETTING.

Reimplemented from Component.

References debug_, Syslog::INFO, isDataRequested(), Component::logger_, Component::PAUSE, receive(), Component::RUNNABLE, and Logger::syslog().

Component::RunState Turbulence_NPS::start ( )

virtual

Do what needs to be done to run Similar to initialize, in old init/run/uninit sequence.

Reimplemented from Component.

References FailureMode::COMMUNICATIONS, debug_, deviceResponse_, Syslog::ERROR, UartStream::errorString(), Syslog::FAULT, firstPacket_, FailureMode::HARDWARE, UartStream::hasError(), Syslog::INFO, loadControl_, Component::logger_, Timestamp::Now(), UartStream::open(), LoadControl::powerUp(), Component::setAllowableFailures(), Component::setFailure(), Component::setRetryTimeout(), Component::simulateHardware(), Component::START, Component::STARTING, startTime_, Component::STOP, Logger::syslog(), and uart_.

Referenced by stopped().

Component::RunState Turbulence_NPS::starting ( )

virtual

Might follow a STOP...START sequence.

Reimplemented from Component.

References debug_, Syslog::INFO, Component::logger_, Component::RUNNABLE, and Logger::syslog().

Component::RunState Turbulence_NPS::stop ( )

virtual

Initial state – can be later followed by START.

Reimplemented from Component.

References debug_, Syslog::INFO, Component::logger_, pausePeriod_, pitchWriter_, rollWriter_, DataWriter::setInvalid(), Component::simulateHardware(), Timespan::sleepFor(), Component::STOPPING, Logger::syslog(), uninitialize(), and yawWriter_.

Referenced by resetting(), and stopped().

Component::RunState Turbulence_NPS::stopped ( )

virtual

Initial state – can be later followed by START.

Reimplemented from Component.

References UartStream::close(), debug_, LoadControl::getPowerState(), Syslog::INFO, isDataRequested(), UartStream::isReadable(), loadControl_, Component::logger_, LoadControl::OFF, pausePeriod_, LoadControl::POWER_DOWN, Component::simulateHardware(), Timespan::sleepFor(), start(), stop(), Component::STOPPED, Logger::syslog(), and uart_.

Component::RunState Turbulence_NPS::stopping ( )

virtual

Might follow a STOP request.

Reimplemented from Component.

References debug_, LoadControl::errorString(), Syslog::FAULT, FailureMode::HARDWARE, LoadControl::hasError(), Syslog::INFO, loadControl_, Component::logger_, LoadControl::readFaults(), Component::setFailure(), Component::simulateHardware(), Component::STOPPED, and Logger::syslog().

void Turbulence_NPS::uninitialize ( void )

virtual

Provide a space for uninitialization.

Reimplemented from Component.

References UartStream::close(), Syslog::FAULT, FailureMode::HARDWARE, Syslog::INFO, loadControl_, Component::logger_, LoadControl::powerDown(), Component::setFailure(), Component::simulateHardware(), Logger::syslog(), and uart_.

Referenced by stop().

void Turbulence_NPS::writeData ( void )

private

Member Data Documentation

BlobWriter* Turbulence_NPS::acmPathWriter_

private

Referenced by Turbulence_NPS(), and writeData().

bool Turbulence_NPS::debug_

private

Referenced by paused(), resuming(), runnable(), start(), starting(), stop(), stopped(), and stopping().

DataWriter* Turbulence_NPS::deltaXVelocityWriter_

private

Referenced by Turbulence_NPS(), and writeData().

DataWriter* Turbulence_NPS::deltaYVelocityWriter_

private

Referenced by Turbulence_NPS(), and writeData().

DataWriter* Turbulence_NPS::deltaZVelocityWriter_

private

Referenced by Turbulence_NPS(), and writeData().

char Turbulence_NPS::deviceResponse_[512]

private

Referenced by receive(), start(), and writeData().

bool Turbulence_NPS::firstPacket_

private

Referenced by receive(), resume(), and start().

BlobWriter* Turbulence_NPS::fwdSigStrengthWriter_

private

Referenced by Turbulence_NPS(), and writeData().

DataReader* Turbulence_NPS::gfScanActiveReader_

private

Referenced by Turbulence_NPS(), and writeData().

LoadControl Turbulence_NPS::loadControl_

private

Referenced by pause(), receive(), resume(), start(), stopped(), stopping(), and uninitialize().

BlobWriter* Turbulence_NPS::microCondWriter_

private

Referenced by isDataRequested(), Turbulence_NPS(), and writeData().

BlobWriter* Turbulence_NPS::microTemp1Writer_

private

Referenced by isDataRequested(), Turbulence_NPS(), and writeData().

BlobWriter* Turbulence_NPS::microTemp2Writer_

private

Referenced by isDataRequested(), Turbulence_NPS(), and writeData().

DataWriter* Turbulence_NPS::numTCSamplesWriter_

private

Referenced by Turbulence_NPS(), and writeData().

DataWriter* Turbulence_NPS::packetNumWriter_

private

Referenced by Turbulence_NPS(), and writeData().

Timespan Turbulence_NPS::pausePeriod_

private

Referenced by paused(), receive(), stop(), and stopped().

DataWriter* Turbulence_NPS::pitchWriter_

private

Referenced by pause(), stop(), Turbulence_NPS(), and writeData().

DataWriter* Turbulence_NPS::rollWriter_

private

Referenced by pause(), stop(), Turbulence_NPS(), and writeData().

Timespan Turbulence_NPS::sensorTimeout_

private

Referenced by receive().

short Turbulence_NPS::shortBuffer_[34]

private

Referenced by writeData().

Timestamp Turbulence_NPS::startTime_

private

Referenced by receive(), resuming(), start(), and writeData().

UartStream Turbulence_NPS::uart_

private

Referenced by pause(), receive(), resume(), start(), stopped(), and uninitialize().

DataWriter* Turbulence_NPS::yawWriter_

private

Referenced by pause(), stop(), Turbulence_NPS(), and writeData().

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

/Volumes/ubuntu_share/lrauv-application/Source/scienceModule/Turbulence_NPS.h
/Volumes/ubuntu_share/lrauv-application/Source/scienceModule/Turbulence_NPS.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation