Abstract Base class for software components. More...

#include <Component.h>

Inheritance diagram for Component:

Collaboration diagram for Component:

Public Types
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 }

Public Member Functions
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)

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

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

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	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 Subseqent. More...

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

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

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

virtual RunState	pausing ()
	Might follow a PAUSE request. 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	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 ()
	Should eventually follow a STOP 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)

Protected Types
enum	ConfigOption { CONFIG_SIMULATE_HARDWARE, CONFIG_POWER, CONFIG_FREQUENCY, CONFIG_LATENCY }

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

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
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...

Private Member Functions
	Component (const Component &old)

	Component (const Str &name, ComponentType componentType, const Module *module)
	Private constructor for use only by AsynComponent and SyncComponent. More...

const Timestamp &	getTimeOfFailure (void) const

virtual void	setFailTime (Timestamp t)

void	segfault ()

void	segfaultImpl ()

Private Attributes
ComponentType	componentType_
	This is private, since it should not change. More...

RunState	runState_

ConfigReader *	simulateHardwareReader_

int	simulateHardware_

bool	startRequested_

bool	segfaultRequested_

Friends
class	AsyncComponent

class	Config

class	Behavior

class	ScriptComponent

class	SyncComponent

class	ThreadHandler

class	Handler

class	CBIT

class	CommandLine

Detailed Description

Abstract Base class for software components.

A Component is a chunk of code that will be run at a set time or interval, or in response to a set of conditions is considered a Component. Components are also capable of reading from and writing to the Slate. Loadable modules (see Module) are made up of a collection of Components.

In most instances, this class should not be extended – hence the private constructor. Instead, one of the SyncComponent daughter classes or the SyncComponent class should be used.

Constructor & Destructor Documentation

Component::~Component ( void )

virtual

Destructor cleans up readers_ and writers_.

References FlexArrayBase::isEmpty(), FlexArray< T >::pop(), readers_, and writers_.

Component::Component ( const Component & old )

private

Component::Component	(	const Str &	name,
		ComponentType	componentType,
		const Module *	module
	)

private

Private constructor for use only by AsynComponent and SyncComponent.

Constructor.

Member Function Documentation

virtual void Component::configure ( )

inlinevirtual

Read (or re-read!) configuration settings.

Referenced by Supervisor::configure().

void Component::disableMetering ( void )

inline

References meteringEnabled_.

void Component::execute ( void )

virtual

Reimplemented in Aggregate.

References dt, enabled_, Timespan::INVALID_TIMESPAN, NO_RUN_STATE, Timestamp::NOT_SET_TIME, Timestamp::Now(), PAUSE, pause(), PAUSED, paused(), PAUSING, pausing(), RESETTING, resetting(), RESUME, resume(), RESUMING, resuming(), run(), RUNNABLE, runnable(), runState_, SATISFIED, satisfied(), segfaultImpl(), segfaultRequested_, setDt(), setDurationOfLastRun(), setRunState(), setTimeOfLastRun(), setTimeOfRun(), START, start(), STARTING, starting(), startRequested_, STOP, stop(), STOPPED, stopped(), STOPPING, stopping(), and timeOfLastRun_.

Referenced by PCaller::PThreadRun(), Aggregate::run(), MissionItem::run(), MissionItem::runIfUnsatisfied(), and OffshoreEnvelope_Test::testRun().

virtual int Component::getAllowableFailures ( void ) const

inlinevirtual

References allowableFailures_.

Referenced by CBIT::handleComponentFaults().

ComponentType Component::getComponentType ( )

inline

Getter function for ComponentType.

References componentType_.

Referenced by ComponentRegistry::Insert().

virtual ConfigURI Component::getConfigURI ( ConfigOption configOption ) const

inlineprotectedvirtual

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

Reimplemented in NAL9602, Rowe_600, AHRS_sp3003D, BPC1, Rowe_600LCM, CTD_NeilBrown, ThrusterServo, AHRS_3DMGX3, PNI_TCM, ESPComponent, Turbulence_NPS, DAT, WetLabsBB2FL, AcousticModem_Benthos_ATM900, BuoyancyServo, RudderServo, Aanderaa_O2, CANONSampler, ISUS, VemcoVR2C, ElevatorServo, MassServo, Turner_Cyclops_rhodamine, Radio_Surface, SCPI, DVL_micro, CBIT, DataOverHttps, SBIT, PAR_Licor, Depth_Keller, DropWeight, and Onboard.

References ConfigURI::NO_CONFIG_URI.

Referenced by simulateHardware().

virtual ConfigURI Component::getConfigURI	(	ConfigOption	configOption,
		ElementURI	forElement
	)		const

inlineprotectedvirtual

Should return [myNamespace]::POWER_[forElement], [myNamespace]::LATENCY_[forElement], etc.

Reimplemented in NAL9602.

References ConfigURI::NO_CONFIG_URI.

virtual bool Component::getCriticalFailureReported ( void ) const

inlinevirtual

References criticalFailureReported_.

Referenced by CBIT::handleComponentFaults().

virtual int Component::getFailCount ( void ) const

inlinevirtual

References failCount_.

Referenced by CBIT::handleComponentFaults().

virtual bool Component::getFailureReported ( void ) const

inlinevirtual

References failureReported_.

Referenced by CBIT::handleComponentFaults().

virtual FailureMode::FailType Component::getFailureType ( void ) const

inlinevirtual

References failureType_.

Referenced by CommandLine::commandFailComponent(), and CBIT::handleComponentFaults().

Logger& Component::getLogger ( void )

inline

References logger_.

Referenced by MissionItem::initialize(), MissionItem::Instance(), ValueClause::Instance(), Method::Method(), Slate::NewInputReader(), Slate::NewOutputWriter(), Slate::NewReader(), Slate::NewUniversalElement(), Slate::NewWriter(), UniversalDataElement::notifyChangeDone(), Config::ParseLine(), MissionItem::preempted(), ThreadHandler::PthreadJoinTimeout(), Module::registerComponent(), DataElement::registerWrite(), DataElement::registerWriter(), Aggregate::run(), MissionItem::run(), DataElement::setAccuracy(), DataElement::setInvalid(), MissionItem::setTimedOut(), DataElement::setUnavailable(), PCaller::ShowInfo(), OffshoreEnvelope_Test::testRun(), ValueDetect_Test::testRunDelta(), ValueDetect_Test::testRunNoDelta(), MissionItem::uninitialize(), Module::unregisterComponent(), and DataElement::unregisterWriter().

const Module* Component::getModule ( )

inline

References module_.

Referenced by Slate::ConfigureNewDataElement().

const CodedStr& Component::getName ( void ) const

inline

Returns the name.

References name_.

Referenced by ControlThread::addComponentsFromQueue(), CommandLine::commandFailComponent(), Slate::ConfigureNewDataElement(), DataAccess::DataAccess(), Aggregate::defineArg(), ComponentRegistry::Find(), ComponentRegistry::FindHandler(), Aggregate::getChild(), Aggregate::getItemByRefId(), Aggregate::gotoNextItem(), CBIT::handleComponentFaults(), MissionItem::initializeFromScript(), ComponentRegistry::Insert(), Aggregate::logStack(), Method::Method(), Slate::NewInputReader(), Slate::NewOutputWriter(), newUniversalBlobWriter(), Slate::NewUniversalWriter(), newUniversalWriter(), Config::ParseLine(), ThreadHandler::PthreadJoinTimeout(), Aggregate::redefineArg(), MissionManager::resumeLoadedMission(), TestAsyncComponent::run(), MissionManager::run(), Aggregate::run(), MissionStateLogger::SetActive(), MissionItem::setRepeatIndex(), MultiHandler::shutdown(), MultiHandler::syslogComponentOrder(), CommandLine_Test::testParse(), Blob_Test::testReadWrite(), Blob_Test::testReadWriteConversions(), and Slate::WriteOnce().

const Timespan Component::getPauseTime ( ) const

inlineprotected

References pauseTime_.

const Timespan& Component::getPeriod ( void )

inline

Returns the component's period (regardless of whether it is periodic)

References desiredPeriod_.

Referenced by ComponentRegistry::GetControlThreadPeriod(), and Handler::runBetween().

FlexArray< DataReader * > & Component::getReaderList ( void )

References readers_.

virtual Timespan Component::getRetryTimeout ( void ) const

inlinevirtual

References retryTimeout_.

Referenced by CBIT::handleComponentFaults().

RunState Component::getRunState ( void )

inline

Return the component's run state.

References runState_.

Referenced by PCaller::pCall().

virtual int Component::getSkippedRunsSinceFail ( void ) const

inlinevirtual

References skippedRunsSinceFail_.

ComponentState Component::getState ( void )

inline

Return the component's current state.

References state_.

Referenced by Handler::runBetween().

const Timestamp& Component::getTimeOfFailure ( void ) const

inlineprivate

References timeOfFailure_.

Referenced by CBIT::handleComponentFaults().

const Timestamp& Component::getTimeOfLastRun ( void ) const

inline

References timeOfLastRun_.

Referenced by DataElement::wasTouchedSinceLastRun().

FlexArray< DataWriter * > & Component::getWriterList ( void )

References writers_.

const Timestamp& Component::getWriteTimestamp ( void )

inline

References writeTimestamp_.

Referenced by ReadDataComponent::isSatisfied().

virtual int Component::incrementFailCount ( void )

inlinevirtual

References failCount_.

Referenced by setFailure().

virtual int Component::incrementSkippedRunsSinceFail ( void )

inlinevirtual

References skippedRunsSinceFail_.

virtual void Component::initialize ( void )

inlinevirtual

Provide a space for initialization before being run.

Reimplemented in ScriptSyncComponent, DefinedBehavior, ScriptMissionComponent, ScriptAsyncComponent, Tracking, ExternalSim, NavigationSim, ReadDataComponent, MissionManager, DataOverHttps, InternalSim, ControlThread, CBIT, KeepStation, Lane, HFRadarCompactModelForecaster, PitchRateCalculator, HFRCMSurfaceCurrentAtVehicleLocation, HFRCMTimeInterpolator, OffshoreEnvelope, WaterDepthEnvelope, ZigZag, DeadReckonUsingMultipleVelocitySources, CommandLine, HorizontalControl, VerticalControl, DepthRateCalculator, YawRateCalculator, HFRCMReconstructedInterpolator, YoYo, HFRCMVirtualSurfaceDrifter, DepthEnvelope, DepthServo, PitchServo, SpeedControl, HFRadarModelPoint, HFRCMSpaceInterpolator, StratificationFrontDetector, ValueDetect, IBIT, SBIT, LoopControl, HFRadarModelCalc, AltitudeEnvelope, Buoyancy, Navigator, Execute, PrepareToDive, Aggregate, NavChart, Batt_Ocean_Server, PeakDetectHorizontal, PeakDetectVsDepth, Circle, GoToSurface, Point, Wait, Waypoint, NavChartDb, PAR_Licor, Depth_Keller, HFRadarModel, ReinitializeHFRCMVirtualSurfaceDrifter, Pitch, SetSpeed, StopMission, DeadReckonUsingCompactModelForecast, DeadReckonWithRespectToSeafloor, SpeedCalculator, DeadReckonUsingDVLWaterTrack, UniversalFixResidualReporter, AsyncPiEstimator, DropWeight, VerticalTemperatureHomogeneityIndexCalculator, DeadReckonUsingSpeedCalculator, DeadReckonWithRespectToWater, Onboard, TempGradientCalculator, SendDataComponent, SyslogComponent, CalibrateSparton, and Assign.

Referenced by MissionItem::initialize(), and PCaller::PThreadRun().

bool Component::isActive ( ) const

Indicates if the component is active.

Unless runStates are used, will generally return true

References NO_RUN_STATE, PAUSE, PAUSED, PAUSING, persistentPause_, RESETTING, RESUME, RESUMING, RUNNABLE, runState_, SATISFIED, START, STARTING, STOP, STOPPED, and STOPPING.

Referenced by VerticalControl::controlVertical(), and DataElement::isOwnersActive().

virtual bool Component::isCompleted ( void )

inlinevirtual

Query if this component is completed.

Reimplemented in Behavior.

References BLOCK_COMPLETED, and state_.

Referenced by Handler::continueLoop(), and MissionManager::run().

virtual bool Component::isFailed ( void ) const

inlinevirtual

References failureType_, and FailureMode::NONE.

Referenced by CommandLine::commandFailComponent(), CBIT::handleComponentFaults(), DataElement::isImplemented(), Supervisor::IsMissionManagerFailed(), DataElement::isOwnersFailed(), PCaller::pCall(), Handler::runBetween(), and Radio_Surface::shouldBeOn().

virtual bool Component::isFailureMissionCritical ( )

inlinevirtual

References failureMissionCritical_.

Referenced by CBIT::handleComponentFaults().

bool Component::isFailureUninitialized ( )

inline

References failureUninitialized_.

Referenced by CBIT::handleComponentFaults(), and PCaller::pCall().

bool Component::isUsingRunState ( )

inline

Return true if using runState.

References NO_RUN_STATE, and runState_.

Referenced by PCaller::pCall().

void Component::logCurrent	(	float	current,
		float	averageCurrent
	)

virtual

References avgCurrentWriter_, currentWriter_, FLOAT2, Units::MILLIAMPERE, Slate::NewOutputWriter(), and DataWriter::write().

Referenced by LoadControl::powerDown(), and LoadControl::requestVoltageAndCurrent().

void Component::logVoltage	(	float	voltage,
		float	averageVoltage
	)

virtual

References avgVoltageWriter_, FLOAT2, Slate::NewOutputWriter(), Units::VOLT, voltageWriter_, and DataWriter::write().

Referenced by LoadControl::powerDown(), and LoadControl::requestVoltageAndCurrent().

BlobReader * Component::newBlobReader ( const BlobURI & blobURI )

References ElementURI::getBinaryType(), Slate::GetElement(), ElementURI::getUnit(), and Slate::NewDataElement().

Referenced by newBlobReaderFromUniversal(), Blob_Test::testReadWrite(), Blob_Test::testReadWriteConversions(), and Tracking::Tracking().

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

References Str::cStr(), ElementURI::getBlobType(), ElementURI::getDimension1(), ElementURI::getDimension2(), ElementURI::getDimension3(), ElementURI::getUnit(), and newBlobReader().

Referenced by DeadReckonUsingDVLWaterTrack::DeadReckonUsingDVLWaterTrack().

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

References ElementURI::getBinaryType(), Slate::GetElement(), ElementURI::getUnit(), and Slate::NewDataElement().

Referenced by DAT::DAT(), HFRadarCompactModelForecaster::HFRadarCompactModelForecaster(), Rowe_600::Rowe_600(), Blob_Test::testReadWrite(), Blob_Test::testReadWriteConversions(), Tracking::Tracking(), Turbulence_NPS::Turbulence_NPS(), and VemcoVR2C::VemcoVR2C().

ConfigReader * Component::newConfigReader ( const ConfigURI & configURI )

References Syslog::CRITICAL, Unit::dataValue(), ElementURI::getBinaryType(), Slate::GetElement(), ElementURI::getUnit(), logger_, Slate::MapDataElement(), ConfigURI::requiresRestart(), ConfigDataElement::setRequiresRestart(), and Logger::syslog().

Referenced by AcousticModem_Benthos_ATM900::AcousticModem_Benthos_ATM900(), AHRS_3DMGX3::AHRS_3DMGX3(), AHRS_sp3003D::AHRS_sp3003D(), AltitudeEnvelope::AltitudeEnvelope(), Batt_Ocean_Server::Batt_Ocean_Server(), BPC1::BPC1(), Buoyancy::Buoyancy(), BuoyancyServo::BuoyancyServo(), CANONSampler::CANONSampler(), CBIT::CBIT(), CTD_NeilBrown::CTD_NeilBrown(), DAT::DAT(), DataOverHttps::DataOverHttps(), DeadReckonUsingCompactModelForecast::DeadReckonUsingCompactModelForecast(), DeadReckonUsingDVLWaterTrack::DeadReckonUsingDVLWaterTrack(), DeadReckonUsingMultipleVelocitySources::DeadReckonUsingMultipleVelocitySources(), DeadReckonUsingSpeedCalculator::DeadReckonUsingSpeedCalculator(), DeadReckonWithRespectToSeafloor::DeadReckonWithRespectToSeafloor(), DeadReckonWithRespectToWater::DeadReckonWithRespectToWater(), Depth_Keller::Depth_Keller(), DepthEnvelope::DepthEnvelope(), DepthServo::DepthServo(), DVL_micro::DVL_micro(), ElevatorServo::ElevatorServo(), ESPComponent::ESPComponent(), ExternalSim::ExternalSim(), GoToSurface::GoToSurface(), HFRadarCompactModelForecaster::HFRadarCompactModelForecaster(), HorizontalControl::HorizontalControl(), IBIT::IBIT(), InternalSim::InternalSim(), SimulatorUtils::LoadInit(), MassServo::MassServo(), NAL9602::NAL9602(), NavChartDb::NavChartDb(), Onboard::Onboard(), PAR_Licor::PAR_Licor(), PitchServo::PitchServo(), PNI_TCM::PNI_TCM(), PrepareToDive::PrepareToDive(), Radio_Surface::Radio_Surface(), Rowe_600::Rowe_600(), Rowe_600LCM::Rowe_600LCM(), RudderServo::RudderServo(), SBIT::SBIT(), SCPI::SCPI(), simulateHardware(), SpeedCalculator::SpeedCalculator(), SpeedControl::SpeedControl(), TempGradientCalculator::TempGradientCalculator(), CommandLine_Test::testParse(), ThrusterServo::ThrusterServo(), Turner_Cyclops_rhodamine::Turner_Cyclops_rhodamine(), UniversalFixResidualReporter::UniversalFixResidualReporter(), VerticalControl::VerticalControl(), VerticalTemperatureHomogeneityIndexCalculator::VerticalTemperatureHomogeneityIndexCalculator(), WetLabsBB2FL::WetLabsBB2FL(), and YoYo::YoYo().

DataReader * Component::newDataReader ( const DataURI & dataURI )

References ElementURI::getBinaryType(), Slate::GetElement(), ElementURI::getUnit(), and Slate::NewDataElement().

Referenced by AcousticModem_Benthos_ATM900::AcousticModem_Benthos_ATM900(), AltitudeEnvelope::AltitudeEnvelope(), BuoyancyServo::BuoyancyServo(), CBIT::CBIT(), CommandLine::CommandLine(), CTD_NeilBrown::CTD_NeilBrown(), DAT::DAT(), DepthEnvelope::DepthEnvelope(), DepthServo::DepthServo(), ElevatorServo::ElevatorServo(), ExternalSim::ExternalSim(), HorizontalControl::HorizontalControl(), IBIT::IBIT(), InternalSim::InternalSim(), Lane::Lane(), LoopControl::LoopControl(), MassServo::MassServo(), MissionManager::MissionManager(), NavigationSim::NavigationSim(), newDataReaderFromUniversal(), OffshoreEnvelope::OffshoreEnvelope(), Radio_Surface::Radio_Surface(), RudderServo::RudderServo(), SpeedControl::SpeedControl(), OffshoreEnvelope_Test::testRun(), ThrusterServo::ThrusterServo(), Tracking::Tracking(), Turbulence_NPS::Turbulence_NPS(), VerticalControl::VerticalControl(), WaterDepthEnvelope::WaterDepthEnvelope(), YoYo::YoYo(), and ZigZag::ZigZag().

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

References Str::cStr(), ElementURI::getBinaryType(), ElementURI::getUnit(), and newDataReader().

Referenced by DeadReckonUsingMultipleVelocitySources::DeadReckonUsingMultipleVelocitySources(), DeadReckonUsingSpeedCalculator::DeadReckonUsingSpeedCalculator(), and ExternalSim::ExternalSim().

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

References ElementURI::getBinaryType(), Slate::GetElement(), ElementURI::getUnit(), and Slate::NewDataElement().

Referenced by Aanderaa_O2::Aanderaa_O2(), AcousticModem_Benthos_ATM900::AcousticModem_Benthos_ATM900(), AHRS_3DMGX3::AHRS_3DMGX3(), AHRS_sp3003D::AHRS_sp3003D(), AltitudeEnvelope::AltitudeEnvelope(), Buoyancy::Buoyancy(), CANONSampler::CANONSampler(), CBIT::CBIT(), Circle::Circle(), CTD_NeilBrown::CTD_NeilBrown(), DAT::DAT(), DeadReckonUsingCompactModelForecast::DeadReckonUsingCompactModelForecast(), DeadReckonUsingDVLWaterTrack::DeadReckonUsingDVLWaterTrack(), DeadReckonUsingMultipleVelocitySources::DeadReckonUsingMultipleVelocitySources(), DeadReckonUsingSpeedCalculator::DeadReckonUsingSpeedCalculator(), DeadReckonWithRespectToSeafloor::DeadReckonWithRespectToSeafloor(), DeadReckonWithRespectToWater::DeadReckonWithRespectToWater(), DepthEnvelope::DepthEnvelope(), DepthServo::DepthServo(), DropWeight::DropWeight(), DVL_micro::DVL_micro(), ESPComponent::ESPComponent(), ExternalSim::ExternalSim(), GoToSurface::GoToSurface(), HFRadarModelPoint::HFRadarModelPoint(), HFRCMVirtualSurfaceDrifter::HFRCMVirtualSurfaceDrifter(), HorizontalControl::HorizontalControl(), IBIT::IBIT(), ISUS::ISUS(), KeepStation::KeepStation(), Lane::Lane(), NAL9602::NAL9602(), NavChartDb::NavChartDb(), OffshoreEnvelope::OffshoreEnvelope(), Onboard::Onboard(), PAR_Licor::PAR_Licor(), Pitch::Pitch(), PitchServo::PitchServo(), PNI_TCM::PNI_TCM(), Point::Point(), PrepareToDive::PrepareToDive(), Radio_Surface::Radio_Surface(), Rowe_600::Rowe_600(), Rowe_600LCM::Rowe_600LCM(), SBIT::SBIT(), SCPI::SCPI(), SetSpeed::SetSpeed(), SpeedControl::SpeedControl(), TempGradientCalculator::TempGradientCalculator(), Tracking::Tracking(), Turbulence_NPS::Turbulence_NPS(), Turner_Cyclops_rhodamine::Turner_Cyclops_rhodamine(), VemcoVR2C::VemcoVR2C(), VerticalControl::VerticalControl(), VerticalTemperatureHomogeneityIndexCalculator::VerticalTemperatureHomogeneityIndexCalculator(), WaterDepthEnvelope::WaterDepthEnvelope(), Waypoint::Waypoint(), WetLabsBB2FL::WetLabsBB2FL(), YoYo::YoYo(), and ZigZag::ZigZag().

UniversalBlobReader * Component::newUniversalBlobReader ( const UniversalBlobURI & universalURI )

References ElementURI::getBinaryType(), ElementURI::getUnit(), and Slate::NewUniversalElement().

Referenced by DeadReckonUsingMultipleVelocitySources::DeadReckonUsingMultipleVelocitySources(), DeadReckonWithRespectToSeafloor::DeadReckonWithRespectToSeafloor(), Navigator::Navigator(), Universal_Test::test1DUniversalBlobReadWrite(), Universal_Test::test3DUniversalBlobReadWrite(), and Tracking::Tracking().

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

UniversalDataReader * Component::newUniversalReader ( const UniversalURI & universalURI )

References ElementURI::getBinaryType(), ElementURI::getUnit(), and Slate::NewUniversalElement().

Referenced by AHRS_3DMGX3::AHRS_3DMGX3(), AHRS_sp3003D::AHRS_sp3003D(), AltitudeEnvelope::AltitudeEnvelope(), Buoyancy::Buoyancy(), BuoyancyServo::BuoyancyServo(), CBIT::CBIT(), Circle::Circle(), CommandLine::CommandLine(), CTD_NeilBrown::CTD_NeilBrown(), DeadReckonUsingCompactModelForecast::DeadReckonUsingCompactModelForecast(), DeadReckonWithRespectToWater::DeadReckonWithRespectToWater(), Depth_Keller::Depth_Keller(), DepthEnvelope::DepthEnvelope(), DepthRateCalculator::DepthRateCalculator(), DVL_micro::DVL_micro(), ExternalSim::ExternalSim(), GoToSurface::GoToSurface(), HFRadarCompactModelForecaster::HFRadarCompactModelForecaster(), HFRadarModelPoint::HFRadarModelPoint(), HorizontalControl::HorizontalControl(), IBIT::IBIT(), PeakDetectHorizontal::initialize(), ValueDetect::initialize(), InternalSim::InternalSim(), ISUS::ISUS(), KeepStation::KeepStation(), Lane::Lane(), NAL9602::NAL9602(), NavChart::NavChart(), NavigationSim::NavigationSim(), Navigator::Navigator(), OffshoreEnvelope::OffshoreEnvelope(), PAR_Licor::PAR_Licor(), PeakDetectHorizontal::PeakDetectHorizontal(), PeakDetectVsDepth::PeakDetectVsDepth(), Pitch::Pitch(), PitchRateCalculator::PitchRateCalculator(), PitchServo::PitchServo(), PNI_TCM::PNI_TCM(), Point::Point(), PrepareToDive::PrepareToDive(), Radio_Surface::Radio_Surface(), SBIT::SBIT(), SetSpeed::SetSpeed(), SpeedCalculator::SpeedCalculator(), SpeedControl::SpeedControl(), TempGradientCalculator::TempGradientCalculator(), Tracking::Tracking(), UniversalFixResidualReporter::UniversalFixResidualReporter(), VerticalControl::VerticalControl(), VerticalTemperatureHomogeneityIndexCalculator::VerticalTemperatureHomogeneityIndexCalculator(), WaterDepthEnvelope::WaterDepthEnvelope(), Waypoint::Waypoint(), WetLabsBB2FL::WetLabsBB2FL(), YawRateCalculator::YawRateCalculator(), and YoYo::YoYo().

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

References UniversalDataElement::addElement(), ElementURI::getBinaryType(), getName(), ElementURI::getUnit(), Slate::NewDataElement(), Slate::NewUniversalElement(), DataElement::NO_ACCURACY, UniversalDataElement::notifyChangeDone(), and DataElement::registerUniversal().

Referenced by Aanderaa_O2::Aanderaa_O2(), AcousticModem_Benthos_ATM900::AcousticModem_Benthos_ATM900(), AHRS_3DMGX3::AHRS_3DMGX3(), AHRS_sp3003D::AHRS_sp3003D(), Batt_Ocean_Server::Batt_Ocean_Server(), BPC1::BPC1(), BuoyancyServo::BuoyancyServo(), CBIT::CBIT(), CommandLine::CommandLine(), CTD_NeilBrown::CTD_NeilBrown(), CycleStarter::CycleStarter(), DAT::DAT(), DataOverHttps::DataOverHttps(), Depth_Keller::Depth_Keller(), DepthRateCalculator::DepthRateCalculator(), DVL_micro::DVL_micro(), ElevatorServo::ElevatorServo(), HFRCMSurfaceCurrentAtVehicleLocation::HFRCMSurfaceCurrentAtVehicleLocation(), InternalSim::InternalSim(), ISUS::ISUS(), LogSplitterComponent::LogSplitterComponent(), MassServo::MassServo(), MissionManager::MissionManager(), NAL9602::NAL9602(), NavChart::NavChart(), NavigationSim::NavigationSim(), Navigator::Navigator(), Onboard::Onboard(), PAR_Licor::PAR_Licor(), PitchRateCalculator::PitchRateCalculator(), PNI_TCM::PNI_TCM(), Rowe_600::Rowe_600(), Rowe_600LCM::Rowe_600LCM(), RudderServo::RudderServo(), SpeedCalculator::SpeedCalculator(), TempGradientCalculator::TempGradientCalculator(), OffshoreEnvelope_Test::testRun(), ThrusterServo::ThrusterServo(), Turner_Cyclops_rhodamine::Turner_Cyclops_rhodamine(), WetLabsBB2FL::WetLabsBB2FL(), and YawRateCalculator::YawRateCalculator().

virtual RunState Component::pause ( )

inlinevirtual

Pause for a short period (indicated by pauseTime)

Reimplemented in NAL9602, Rowe_600, BPC1, Rowe_600LCM, AHRS_sp3003D, CTD_NeilBrown, AHRS_3DMGX3, PNI_TCM, ThrusterServo, ESPComponent, Turbulence_NPS, DAT, WetLabsBB2FL, AcousticModem_Benthos_ATM900, Radio_Surface, Aanderaa_O2, CANONSampler, ISUS, Turner_Cyclops_rhodamine, VemcoVR2C, DVL_micro, BuoyancyServo, RudderServo, ElevatorServo, MassServo, and SCPI.

References PAUSED.

Referenced by CommandLine::commandRestartApplication(), and execute().

virtual RunState Component::paused ( )

inlinevirtual

Should eventually follow a PAUSE request: should set continueTime.

Reimplemented in NAL9602, Rowe_600, BPC1, Rowe_600LCM, AHRS_sp3003D, CTD_NeilBrown, AHRS_3DMGX3, PNI_TCM, ThrusterServo, ESPComponent, Turbulence_NPS, DAT, WetLabsBB2FL, AcousticModem_Benthos_ATM900, Radio_Surface, Aanderaa_O2, CANONSampler, ISUS, Turner_Cyclops_rhodamine, VemcoVR2C, BuoyancyServo, RudderServo, ElevatorServo, MassServo, DVL_micro, and SCPI.

References PAUSED.

Referenced by execute().

virtual RunState Component::pausing ( )

inlinevirtual

Might follow a PAUSE request.

Reimplemented in BPC1.

References PAUSED.

Referenced by execute().

void Component::registerReader ( DataReader * reader )

References FlexArray< T >::push(), and readers_.

Referenced by DataReader::DataReader().

void Component::registerWriter ( DataWriter * writer )

References FlexArray< T >::push(), and writers_.

Referenced by DataWriter::DataWriter().

void Component::requestData ( bool requestingData )

Tell the component to start (or stop) sending data.

References FlexArrayBase::getMaxIndex(), and writers_.

Referenced by ReadDataComponent::requestData().

void Component::requestPause ( const Timespan expectedPauseTime )

Tell the component to pause runnning.

References NO_RUN_STATE, PAUSE, PAUSED, pauseTime_, PAUSING, RESETTING, RESUME, RESUMING, RUNNABLE, runState_, SATISFIED, setRunState(), START, STARTING, STOP, STOPPED, and STOPPING.

void Component::requestResume ( )

Tell the component resume from pause.

References NO_RUN_STATE, PAUSE, PAUSED, PAUSING, RESETTING, RESUME, RESUMING, RUNNABLE, runState_, SATISFIED, setRunState(), START, STARTING, STOP, STOPPED, and STOPPING.

void Component::requestStart ( )

Tell the component to start runnning.

References NO_RUN_STATE, PAUSE, PAUSED, PAUSING, RESETTING, RESUME, RESUMING, RUNNABLE, runState_, SATISFIED, setRunState(), START, STARTING, startRequested_, STOP, STOPPED, and STOPPING.

Referenced by PCaller::pCall().

void Component::requestStop ( )

Tell the component to stop runnning.

References NO_RUN_STATE, PAUSE, PAUSED, PAUSING, RESETTING, RESUME, RESUMING, RUNNABLE, runState_, SATISFIED, setRunState(), START, STARTING, STOP, STOPPED, and STOPPING.

Referenced by PCaller::pCall().

void Component::resetFailCount ( void )

virtual

References criticalFailureReported_, failCount_, Syslog::INFO, logger_, name_, recoveringFromCritical_, and Logger::syslog().

Referenced by NAL9602::awake(), DataOverHttps::dataRead(), CBIT::handleComponentFaults(), Turbulence_NPS::receive(), PAR_Licor::run(), Depth_Keller::run(), Batt_Ocean_Server::run(), DVL_micro::runnable(), SCPI::runnable(), ElevatorServo::runnable(), MassServo::runnable(), BuoyancyServo::runnable(), Aanderaa_O2::runnable(), RudderServo::runnable(), CANONSampler::runnable(), Turner_Cyclops_rhodamine::runnable(), VemcoVR2C::runnable(), ISUS::runnable(), AcousticModem_Benthos_ATM900::runnable(), Radio_Surface::runnable(), WetLabsBB2FL::runnable(), DAT::runnable(), ESPComponent::runnable(), ThrusterServo::runnable(), AHRS_3DMGX3::runnable(), PNI_TCM::runnable(), CTD_NeilBrown::runnable(), AHRS_sp3003D::runnable(), BPC1::runnable(), Rowe_600::runnable(), NAL9602::sendingVerify(), NAL9602::sessionMTQueueVerify(), and Navigator::writeVehiclePosition().

virtual RunState Component::resetting ( )

inlinevirtual

Might occur in case of Error.

Reimplemented in NAL9602, Rowe_600, BPC1, Rowe_600LCM, AHRS_sp3003D, CTD_NeilBrown, AHRS_3DMGX3, PNI_TCM, ThrusterServo, ESPComponent, Turbulence_NPS, DAT, WetLabsBB2FL, AcousticModem_Benthos_ATM900, Radio_Surface, Aanderaa_O2, CANONSampler, ISUS, Turner_Cyclops_rhodamine, VemcoVR2C, BuoyancyServo, RudderServo, ElevatorServo, MassServo, SCPI, and DVL_micro.

References RUNNABLE.

Referenced by execute().

virtual RunState Component::resume ( )

inlinevirtual

Resume from PAUSE.

Reimplemented in NAL9602, Rowe_600, BPC1, Rowe_600LCM, AHRS_sp3003D, CTD_NeilBrown, AHRS_3DMGX3, PNI_TCM, ThrusterServo, ESPComponent, Turbulence_NPS, DAT, WetLabsBB2FL, AcousticModem_Benthos_ATM900, Radio_Surface, Aanderaa_O2, CANONSampler, ISUS, Turner_Cyclops_rhodamine, VemcoVR2C, BuoyancyServo, RudderServo, ElevatorServo, MassServo, SCPI, and DVL_micro.

References RUNNABLE.

Referenced by execute().

virtual RunState Component::resuming ( )

inlinevirtual

Might follow a PAUSE...RESUME sequence.

Reimplemented in NAL9602, Rowe_600, BPC1, Rowe_600LCM, AHRS_sp3003D, CTD_NeilBrown, AHRS_3DMGX3, PNI_TCM, ThrusterServo, ESPComponent, Turbulence_NPS, DAT, WetLabsBB2FL, AcousticModem_Benthos_ATM900, Radio_Surface, Aanderaa_O2, CANONSampler, ISUS, Turner_Cyclops_rhodamine, VemcoVR2C, BuoyancyServo, RudderServo, ElevatorServo, MassServo, SCPI, and DVL_micro.

References RUNNABLE.

Referenced by execute().

virtual void Component::run ( void )

inlinevirtual

The actual "payload" of the component.

Reimplemented in ScriptSyncComponent, DefinedBehavior, ScriptMissionComponent, ScriptAsyncComponent, NAL9602, Maintainer::MaintainItem, Aggregate, Tracking, DepthServo, Lane, ReadDataComponent, OffshoreEnvelope, WaterDepthEnvelope, ExternalSim, NavigationSim, ZigZag, Reporter, BPC1, InternalSim, YoYo, ControlThread, CBIT, KeepStation, ValueDetect, DepthRateCalculator, HFRadarCompactModelForecaster, Pitch, HFRCMVirtualSurfaceDrifter, Circle, PrepareToDive, DataOverHttps, PeakDetectHorizontal, PeakDetectVsDepth, PitchRateCalculator, HFRadarModelPoint, HFRCMSurfaceCurrentAtVehicleLocation, HFRCMTimeInterpolator, GoToSurface, Point, Waypoint, MissionManager, HorizontalControl, YawRateCalculator, HFRCMReconstructedInterpolator, SetSpeed, CommandLine, VerticalControl, DepthEnvelope, PitchServo, NavChart, DVL_micro, HFRCMSpaceInterpolator, StratificationFrontDetector, AHRS_sp3003D, IBIT, SBIT, LoopControl, SpeedControl, HFRadarModelCalc, ReinitializeHFRCMVirtualSurfaceDrifter, AltitudeEnvelope, Buoyancy, Navigator, CTD_NeilBrown, Execute, Config, AHRS_3DMGX3, Batt_Ocean_Server, PNI_TCM, ThrusterServo, Wait, ESPComponent, Turbulence_NPS, DAT, HFRadarModel, StopMission, NavChartDb, DeadReckoner, WetLabsBB2FL, LogEngineComponent, PAR_Licor, AcousticModem_Benthos_ATM900, Depth_Keller, Aanderaa_O2, CANONSampler, ISUS, Turner_Cyclops_rhodamine, VemcoVR2C, BuoyancyServo, RudderServo, SpeedCalculator, AsyncPiEstimator, DropWeight, Radio_Surface, ElevatorServo, MassServo, VerticalTemperatureHomogeneityIndexCalculator, LogSplitterComponent, UniversalFixResidualReporter, SCPI, TempGradientCalculator, Onboard, CalibrateSparton, SendDataComponent, SyslogComponent, TestAsyncComponent, Assign, and CycleStarter.

Referenced by execute(), and Behavior::runIfUnsatisfied().

virtual RunState Component::runnable ( )

inlinevirtual

Should eventually follow a START request or RESETTING.

Reimplemented in NAL9602, Rowe_600, BPC1, Rowe_600LCM, AHRS_sp3003D, CTD_NeilBrown, AHRS_3DMGX3, PNI_TCM, ThrusterServo, ESPComponent, Turbulence_NPS, DAT, WetLabsBB2FL, AcousticModem_Benthos_ATM900, Radio_Surface, Aanderaa_O2, CANONSampler, ISUS, Turner_Cyclops_rhodamine, VemcoVR2C, BuoyancyServo, RudderServo, ElevatorServo, MassServo, SCPI, and DVL_micro.

References RUNNABLE.

Referenced by execute(), and satisfied().

virtual RunState Component::satisfied ( )

inlinevirtual

Possible return value of a Behavior.

References runnable().

Referenced by Point::calcSatisfied(), WaterDepthEnvelope::calcSatisfied(), execute(), Behavior::executeIfUnsatisfied(), ReadDataComponent::isSatisfied(), MissionManager::run(), Aggregate::run(), Point::runIfUnsatisfied(), Lane::runIfUnsatisfied(), and MissionItem::satisfied().

void Component::segfault ( )

inlineprivate

Referenced by CommandLine::commandFailComponent(), and ThreadHandler::PthreadJoinTimeout().

void Component::segfaultImpl ( )

private

References Syslog::FAULT, logger_, segfaultRequested_, and Logger::syslog().

Referenced by execute(), and CommandLine::getLines().

virtual void Component::setAllowableFailures ( int fails )

inlinevirtual

References allowableFailures_.

Referenced by Aanderaa_O2::Aanderaa_O2(), AcousticModem_Benthos_ATM900::AcousticModem_Benthos_ATM900(), CANONSampler::CANONSampler(), CommandLine::CommandLine(), ESPComponent::ESPComponent(), DeadReckonWithRespectToWater::initialize(), DeadReckonUsingSpeedCalculator::initialize(), DeadReckonUsingDVLWaterTrack::initialize(), DeadReckonWithRespectToSeafloor::initialize(), DeadReckonUsingCompactModelForecast::initialize(), PAR_Licor::initialize(), Depth_Keller::initialize(), Batt_Ocean_Server::initialize(), IBIT::initialize(), SBIT::initialize(), DeadReckonUsingMultipleVelocitySources::initialize(), CBIT::initialize(), InternalSim::InternalSim(), ISUS::ISUS(), MissionManager::MissionManager(), NAL9602::NAL9602(), Radio_Surface::Radio_Surface(), Rowe_600::Rowe_600(), Rowe_600LCM::Rowe_600LCM(), SCPI::SCPI(), ElevatorServo::start(), MassServo::start(), Turner_Cyclops_rhodamine::start(), BuoyancyServo::start(), RudderServo::start(), AcousticModem_Benthos_ATM900::start(), Turbulence_NPS::start(), DAT::start(), AHRS_3DMGX3::start(), DVL_micro::start(), ThrusterServo::start(), PNI_TCM::start(), CTD_NeilBrown::start(), AHRS_sp3003D::start(), Rowe_600LCM::start(), BPC1::start(), Rowe_600::start(), VemcoVR2C::VemcoVR2C(), and WetLabsBB2FL::WetLabsBB2FL().

void Component::setCriticalFailureReported ( bool boolVal )

inline

References criticalFailureReported_.

Referenced by CBIT::handleComponentFaults().

void Component::setDt ( const Timespan & dt )

protectedvirtual

References dt, and dt_.

Referenced by execute(), and Behavior::executeIfUnsatisfied().

void Component::setDurationOfLastRun ( const Timespan & span )

protectedvirtual

References Timespan::asDouble(), durationOfLastRun_, durationOfLastRunWriter_, FLOAT2, meteringEnabled_, Slate::NewOutputWriter(), Units::SECOND, and DataWriter::write().

Referenced by execute(), and Behavior::executeIfUnsatisfied().

virtual bool Component::setEnabled ( bool enabled = true )

inlineprotectedvirtual

References enabled_.

Referenced by CommandLine::commandQuit(), and Handler::shutdown().

virtual void Component::setFailTime ( Timestamp t )

inlineprivatevirtual

FailureMode::FailType Component::setFailure ( FailureMode::FailType failureType )

virtual

References Syslog::ERROR, failCount_, failureReported_, failureType_, incrementFailCount(), Logger::logComponentFailure(), logger_, FailureMode::NONE, Timestamp::Now(), DataWriter::registerChange(), FlexArrayBase::size(), skippedRunsSinceFail_, Logger::syslog(), timeOfFailure_, FailureMode::ToString(), and writers_.

Referenced by EZServoServo::checkResponse(), NAL9602::cmdMode(), CommandLine::commandFailComponent(), PCaller::DefaultSignalHandler(), ESPComponent::getLine(), NAL9602::getMTQueueSignalStrength(), NAL9602::getReceivedSignalStrength(), CBIT::handleComponentFaults(), Batt_Ocean_Server::initialize(), CBIT::initialize(), DVL_micro::logVoltageAndCurrent(), CANONSampler::logVoltageAndCurrent(), VemcoVR2C::logVoltageAndCurrent(), ISUS::logVoltageAndCurrent(), AcousticModem_Benthos_ATM900::logVoltageAndCurrent(), DAT::logVoltageAndCurrent(), NAL9602::needFix(), DAT::parseResponses(), ElevatorServo::pause(), MassServo::pause(), BuoyancyServo::pause(), Aanderaa_O2::pause(), RudderServo::pause(), DVL_micro::pause(), Turbulence_NPS::pause(), AHRS_3DMGX3::pause(), ThrusterServo::pause(), PNI_TCM::pause(), CTD_NeilBrown::pause(), AHRS_sp3003D::pause(), ElevatorServo::paused(), MassServo::paused(), BuoyancyServo::paused(), RudderServo::paused(), NAL9602::paused(), BPC1::pausing(), ESPComponent::powerDownESP(), ESPComponent::powerUpESP(), AcousticModem_Benthos_ATM900::readAndParseResponses(), DAT::readAndParseResponses(), Rowe_600::readEnsemble(), DVL_micro::readNQ1(), Navigator::readVehicleOrientation(), Turbulence_NPS::receive(), CTD_NeilBrown::receive(), DVL_micro::resume(), BuoyancyServo::resume(), Turbulence_NPS::resume(), AHRS_3DMGX3::resume(), ThrusterServo::resume(), PNI_TCM::resume(), CTD_NeilBrown::resume(), AHRS_sp3003D::resume(), MassServo::resuming(), DropWeight::run(), Depth_Keller::run(), PAR_Licor::run(), Batt_Ocean_Server::run(), HFRadarModelPoint::run(), InternalSim::run(), PrepareToDive::runIfUnsatisfied(), DVL_micro::runnable(), SCPI::runnable(), ElevatorServo::runnable(), MassServo::runnable(), BuoyancyServo::runnable(), ISUS::runnable(), Aanderaa_O2::runnable(), RudderServo::runnable(), Turner_Cyclops_rhodamine::runnable(), VemcoVR2C::runnable(), CANONSampler::runnable(), Radio_Surface::runnable(), WetLabsBB2FL::runnable(), ESPComponent::runnable(), PNI_TCM::runnable(), AHRS_3DMGX3::runnable(), ThrusterServo::runnable(), CTD_NeilBrown::runnable(), AHRS_sp3003D::runnable(), Rowe_600LCM::runnable(), BPC1::runnable(), Rowe_600::runnable(), NAL9602::runnable(), ESPComponent::scanEspServerPort(), NAL9602::sendingVerify(), NAL9602::sessionMTQueueVerify(), SCPI::start(), MassServo::start(), ElevatorServo::start(), Aanderaa_O2::start(), BuoyancyServo::start(), ISUS::start(), Turner_Cyclops_rhodamine::start(), CANONSampler::start(), VemcoVR2C::start(), RudderServo::start(), Radio_Surface::start(), AcousticModem_Benthos_ATM900::start(), WetLabsBB2FL::start(), DAT::start(), Turbulence_NPS::start(), ESPComponent::start(), AHRS_3DMGX3::start(), ThrusterServo::start(), DVL_micro::start(), PNI_TCM::start(), CTD_NeilBrown::start(), AHRS_sp3003D::start(), Rowe_600LCM::start(), BPC1::start(), Rowe_600::start(), NAL9602::start(), SCPI::starting(), ElevatorServo::starting(), MassServo::starting(), BuoyancyServo::starting(), RudderServo::starting(), ISUS::starting(), Aanderaa_O2::starting(), AcousticModem_Benthos_ATM900::starting(), WetLabsBB2FL::starting(), DVL_micro::starting(), DAT::starting(), ESPComponent::starting(), AHRS_3DMGX3::starting(), PNI_TCM::starting(), ThrusterServo::starting(), AHRS_sp3003D::starting(), Rowe_600LCM::starting(), BPC1::starting(), ESPComponent::startPPP(), SCPI::stop(), VemcoVR2C::stop(), CANONSampler::stop(), ISUS::stop(), Turner_Cyclops_rhodamine::stop(), Radio_Surface::stop(), Rowe_600::stop(), DVL_micro::stopping(), SCPI::stopping(), ElevatorServo::stopping(), MassServo::stopping(), BuoyancyServo::stopping(), CANONSampler::stopping(), ISUS::stopping(), Aanderaa_O2::stopping(), Turner_Cyclops_rhodamine::stopping(), VemcoVR2C::stopping(), RudderServo::stopping(), Radio_Surface::stopping(), AcousticModem_Benthos_ATM900::stopping(), WetLabsBB2FL::stopping(), ESPComponent::stopping(), DAT::stopping(), Turbulence_NPS::stopping(), PNI_TCM::stopping(), ThrusterServo::stopping(), AHRS_3DMGX3::stopping(), CTD_NeilBrown::stopping(), AHRS_sp3003D::stopping(), Rowe_600LCM::stopping(), Rowe_600::stopping(), NAL9602::stopping(), ESPComponent::stopPPP(), DataOverHttps::tcpConnect(), DVL_micro::uninitialize(), Aanderaa_O2::uninitialize(), VemcoVR2C::uninitialize(), CANONSampler::uninitialize(), ISUS::uninitialize(), MassServo::uninitialize(), ElevatorServo::uninitialize(), BuoyancyServo::uninitialize(), AcousticModem_Benthos_ATM900::uninitialize(), RudderServo::uninitialize(), WetLabsBB2FL::uninitialize(), Turbulence_NPS::uninitialize(), ESPComponent::uninitialize(), DAT::uninitialize(), AHRS_3DMGX3::uninitialize(), PNI_TCM::uninitialize(), CTD_NeilBrown::uninitialize(), ThrusterServo::uninitialize(), AHRS_sp3003D::uninitialize(), Rowe_600LCM::uninitialize(), Rowe_600::uninitialize(), ESPComponent::waitForESPConnection(), MassServo::waitForHoming(), and Navigator::writeVehiclePosition().

virtual void Component::setFailureMissionCritical ( bool failureMissionCritical )

inlineprotectedvirtual

void Component::setFailureReported ( bool boolVal )

inline

References failureReported_.

Referenced by CBIT::handleComponentFaults().

void Component::setFailureUninitialized ( bool boolVal )

inline

References failureUninitialized_.

Referenced by PCaller::pCall().

void Component::setPeriod ( const Timespan & period )

inline

Set the period of this component... used if it is periodic.

References desiredPeriod_.

Referenced by AsyncComponent::AsyncComponent(), CTD_NeilBrown::CTD_NeilBrown(), NavChartDb::run(), ComponentRegistry::SetControlThreadPeriod(), and Turbulence_NPS::Turbulence_NPS().

void Component::setRecoveringFromCritical ( bool boolVal )

inline

References recoveringFromCritical_.

Referenced by CBIT::handleComponentFaults().

void Component::setRetryTimeout ( const Timespan & timeout )

inline

void Component::setRunState ( const RunState runState )

protected

References DataAccessor::getElement(), FlexArrayBase::getMaxIndex(), DataElement::getUniversal(), UniversalDataElement::recalculate(), RUNNABLE, runState_, SATISFIED, and writers_.

Referenced by Aanderaa_O2::Aanderaa_O2(), AcousticModem_Benthos_ATM900::AcousticModem_Benthos_ATM900(), AHRS_3DMGX3::AHRS_3DMGX3(), AHRS_sp3003D::AHRS_sp3003D(), BPC1::BPC1(), BuoyancyServo::BuoyancyServo(), CANONSampler::CANONSampler(), CTD_NeilBrown::CTD_NeilBrown(), DAT::DAT(), DVL_micro::DVL_micro(), ElevatorServo::ElevatorServo(), ESPComponent::ESPComponent(), execute(), ISUS::ISUS(), MassServo::MassServo(), NAL9602::NAL9602(), PNI_TCM::PNI_TCM(), Radio_Surface::Radio_Surface(), Rowe_600::readEnsemble(), DVL_micro::readNQ1(), Turbulence_NPS::receive(), CTD_NeilBrown::receive(), requestPause(), requestResume(), requestStart(), requestStop(), Rowe_600::Rowe_600(), Rowe_600LCM::Rowe_600LCM(), RudderServo::RudderServo(), WetLabsBB2FL::runnable(), CTD_NeilBrown::runnable(), SCPI::SCPI(), ThrusterServo::ThrusterServo(), Turbulence_NPS::Turbulence_NPS(), Turner_Cyclops_rhodamine::Turner_Cyclops_rhodamine(), VemcoVR2C::VemcoVR2C(), and WetLabsBB2FL::WetLabsBB2FL().

void Component::setState ( ComponentState state )

inline

References state_.

Referenced by AsyncComponent::AsyncComponent(), CommandLine::commandQuit(), MissionManager::missionFromFile(), Reporter::Reporter(), NavChartDb::run(), InternalSim::run(), NavigationSim::run(), ExternalSim::run(), Supervisor::stopMission(), and Turbulence_NPS::Turbulence_NPS().

void Component::setTimeOfLastRun ( const Timestamp & time )

protectedvirtual

References timeOfLastRun_.

Referenced by execute(), Behavior::executeIfUnsatisfied(), and ReadDataComponent::initialize().

virtual void Component::setTimeOfRun ( const Timestamp & time )

inlineprotectedvirtual

Referenced by execute(), and Behavior::executeIfUnsatisfied().

void Component::setWriteTimestamp ( const Timestamp & writeTimestamp )

inline

References writeTimestamp_.

Referenced by DataWriter::write(), and UniversalDataWriter::writeWithAccuracy().

bool Component::simulateHardware ( )

protected

References Units::BOOL, CONFIG_SIMULATE_HARDWARE, getConfigURI(), newConfigReader(), ConfigURI::NO_CONFIG_URI, DataReader::read(), simulateHardware_, and simulateHardwareReader_.

virtual RunState Component::start ( )

inlinevirtual

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

Reimplemented in NAL9602, Rowe_600, BPC1, Rowe_600LCM, AHRS_sp3003D, CTD_NeilBrown, AHRS_3DMGX3, DVL_micro, PNI_TCM, ThrusterServo, ESPComponent, Turbulence_NPS, DAT, WetLabsBB2FL, AcousticModem_Benthos_ATM900, Radio_Surface, Aanderaa_O2, CANONSampler, ISUS, Turner_Cyclops_rhodamine, VemcoVR2C, BuoyancyServo, RudderServo, ElevatorServo, MassServo, and SCPI.

References RUNNABLE.

Referenced by execute().

virtual RunState Component::starting ( )

inlinevirtual

Might follow a STOP...START sequence Subseqent.

Similar to initialize, in old init/run/uninit sequence

Reimplemented in NAL9602, Rowe_600, BPC1, Rowe_600LCM, AHRS_sp3003D, CTD_NeilBrown, AHRS_3DMGX3, PNI_TCM, ThrusterServo, ESPComponent, Turbulence_NPS, DAT, WetLabsBB2FL, DVL_micro, AcousticModem_Benthos_ATM900, Radio_Surface, Aanderaa_O2, CANONSampler, ISUS, Turner_Cyclops_rhodamine, VemcoVR2C, BuoyancyServo, RudderServo, ElevatorServo, MassServo, and SCPI.

References RUNNABLE.

Referenced by execute().

virtual RunState Component::stop ( )

inlinevirtual

Initial state – can be later followed by START.

Reimplemented in NAL9602, Rowe_600, BPC1, Rowe_600LCM, AHRS_sp3003D, CTD_NeilBrown, AHRS_3DMGX3, PNI_TCM, ThrusterServo, ESPComponent, Turbulence_NPS, DAT, WetLabsBB2FL, AcousticModem_Benthos_ATM900, Radio_Surface, Aanderaa_O2, CANONSampler, ISUS, Turner_Cyclops_rhodamine, VemcoVR2C, BuoyancyServo, RudderServo, ElevatorServo, MassServo, SCPI, and DVL_micro.

References STOPPED.

Referenced by execute().

virtual RunState Component::stopped ( )

inlinevirtual

Should eventually follow a STOP request.

Reimplemented in NAL9602, Rowe_600, BPC1, Rowe_600LCM, AHRS_sp3003D, CTD_NeilBrown, AHRS_3DMGX3, PNI_TCM, ThrusterServo, ESPComponent, Turbulence_NPS, DAT, WetLabsBB2FL, AcousticModem_Benthos_ATM900, Radio_Surface, Aanderaa_O2, CANONSampler, ISUS, Turner_Cyclops_rhodamine, VemcoVR2C, BuoyancyServo, RudderServo, ElevatorServo, MassServo, SCPI, and DVL_micro.

References STOPPED.

Referenced by execute().

virtual RunState Component::stopping ( )

inlinevirtual

Might follow a STOP request.

Reimplemented in NAL9602, Rowe_600, BPC1, Rowe_600LCM, AHRS_sp3003D, CTD_NeilBrown, AHRS_3DMGX3, PNI_TCM, ThrusterServo, ESPComponent, Turbulence_NPS, DAT, WetLabsBB2FL, AcousticModem_Benthos_ATM900, Radio_Surface, Aanderaa_O2, CANONSampler, ISUS, Turner_Cyclops_rhodamine, VemcoVR2C, BuoyancyServo, RudderServo, ElevatorServo, MassServo, SCPI, and DVL_micro.

References STOPPED.

Referenced by execute().

virtual void Component::uninitialize ( void )

inlinevirtual

Provide a space for uninitialization.

Reimplemented in ScriptSyncComponent, ScriptMissionComponent, DefinedBehavior, NAL9602, ScriptAsyncComponent, Rowe_600, BPC1, Rowe_600LCM, AHRS_sp3003D, CTD_NeilBrown, ThrusterServo, AHRS_3DMGX3, PNI_TCM, ESPComponent, Turbulence_NPS, DAT, WetLabsBB2FL, AcousticModem_Benthos_ATM900, BuoyancyServo, RudderServo, Aanderaa_O2, CANONSampler, ISUS, VemcoVR2C, ElevatorServo, MassServo, ReadDataComponent, DepthServo, OffshoreEnvelope, WaterDepthEnvelope, Tracking, DVL_micro, Lane, KeepStation, ExternalSim, NavigationSim, ValueDetect, Pitch, PrepareToDive, PeakDetectHorizontal, PeakDetectVsDepth, GoToSurface, Point, ZigZag, InternalSim, SetSpeed, YoYo, Buoyancy, DepthEnvelope, Execute, PitchServo, ControlThread, CBIT, MissionManager, HFRadarModelPoint, AltitudeEnvelope, Wait, DataOverHttps, Circle, Waypoint, HorizontalControl, StopMission, CommandLine, VerticalControl, IBIT, SBIT, LoopControl, DepthRateCalculator, SpeedControl, NavChartDb, Aggregate, Batt_Ocean_Server, NavChart, AsyncPiEstimator, PAR_Licor, Depth_Keller, CalibrateSparton, DropWeight, Radio_Surface, Onboard, SendDataComponent, SyslogComponent, and Assign.

Referenced by ThreadHandler::cleanup(), PCaller::PThreadRun(), MultiHandler::removeComponent(), and MissionItem::uninitialize().

void Component::unregisterReader ( DataReader * reader )

References FlexArrayBase::getMaxIndex(), FlexArray< T >::pop(), and readers_.

Referenced by DataReader::~DataReader().

void Component::unregisterWriter ( DataWriter * writer )

References FlexArrayBase::getMaxIndex(), FlexArray< T >::pop(), and writers_.

Referenced by DataWriter::~DataWriter().

Friends And Related Function Documentation

friend class AsyncComponent

friend

friend class Behavior

friend

friend class CBIT

friend

friend class CommandLine

friend

friend class Config

friend

friend class Handler

friend

friend class ScriptComponent

friend

friend class SyncComponent

friend

friend class ThreadHandler

friend

Referenced by ComponentRegistry::Insert().

Member Data Documentation

int Component::allowableFailures_

protected

Number of failures allowed to occur.

Referenced by getAllowableFailures(), and setAllowableFailures().

DataWriter* Component::avgCurrentWriter_

protected

Referenced by logCurrent().

DataWriter* Component::avgVoltageWriter_

protected

Referenced by logVoltage().

ComponentType Component::componentType_

private

This is private, since it should not change.

Referenced by getComponentType().

bool Component::criticalFailureReported_

protected

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

Referenced by getCriticalFailureReported(), resetFailCount(), and setCriticalFailureReported().

DataWriter* Component::currentWriter_

protected

Referenced by logCurrent().

Syslog::Severity Component::debugLevel_

protected

Referenced by DataOverHttps::DataOverHttps().

Timespan Component::desiredPeriod_

protected

Referenced by getPeriod(), and setPeriod().

Timespan Component::dt_

protected

Timespan Component::durationOfLastRun_

protected

Referenced by setDurationOfLastRun().

DataWriter* Component::durationOfLastRunWriter_

protected

Writer for durationOfLastRun.

Referenced by setDurationOfLastRun().

bool Component::enabled_

protected

Referenced by NavChartDb::addEncData(), execute(), Behavior::executeIfUnsatisfied(), CommandLine::getLines(), CommandLine::isWritable(), CommandLine::run(), and setEnabled().

int Component::failCount_

protected

Number of failures logged by PCaller.

Referenced by getFailCount(), incrementFailCount(), resetFailCount(), and setFailure().

bool Component::failureMissionCritical_

protected

If true (default), complete failure ends mission.

Referenced by isFailureMissionCritical().

bool Component::failureReported_

protected

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

Referenced by getFailureReported(), setFailure(), and setFailureReported().

FailureMode::FailType Component::failureType_

protected

Failed status. If failCount_ > 0, then this may be reset.

Referenced by getFailureType(), isFailed(), and setFailure().

bool Component::failureUninitialized_

protected

Indicates if the failure has resulted in an uninitialize call.

Referenced by isFailureUninitialized(), and setFailureUninitialized().

Logger Component::logger_

protected

bool Component::meteringEnabled_

protected

If true, metering is enabled.

Referenced by disableMetering(), and setDurationOfLastRun().

const Module* Component::module_

protected

Referenced by getModule().

CodedStr& Component::name_

protected

Store the component's name (used for logging purposes)

Referenced by getName(), Aggregate::initialize(), resetFailCount(), and Aggregate::uninitialize().

Timespan Component::pauseTime_

protected

Referenced by getPauseTime(), and requestPause().

bool Component::persistentPause_

protected

True if data is persistent while component is paused.

Referenced by BuoyancyServo::BuoyancyServo(), DataOverHttps::DataOverHttps(), ElevatorServo::ElevatorServo(), isActive(), MassServo::MassServo(), NAL9602::NAL9602(), RudderServo::RudderServo(), and ThrusterServo::ThrusterServo().

FlexArray<DataReader*> Component::readers_

protected

Referenced by getReaderList(), registerReader(), unregisterReader(), and ~Component().

bool Component::recoveringFromCritical_

protected

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

Referenced by resetFailCount(), and setRecoveringFromCritical().

Timespan Component::retryTimeout_

protected

Referenced by getRetryTimeout(), and setRetryTimeout().

RunState Component::runState_

private

Referenced by execute(), getRunState(), isActive(), isUsingRunState(), requestPause(), requestResume(), requestStart(), requestStop(), and setRunState().

bool Component::segfaultRequested_

private

Referenced by execute(), CommandLine::getLines(), and segfaultImpl().

int Component::simulateHardware_

private

Referenced by simulateHardware().

ConfigReader* Component::simulateHardwareReader_

private

Referenced by simulateHardware().

int Component::skippedRunsSinceFail_

protected

Number of skipped runs since failureMode_ set by failCount_.

Referenced by getSkippedRunsSinceFail(), incrementSkippedRunsSinceFail(), and setFailure().

bool Component::startRequested_

private

Referenced by execute(), and requestStart().

ComponentState Component::state_

protected

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

Referenced by getState(), isCompleted(), CommandLine::isWritable(), and setState().

Timestamp Component::timeOfFailure_

protected

Time of last failure. Relevant only if failed=true.

Referenced by getTimeOfFailure(), and setFailure().

Timestamp Component::timeOfLastRun_

protected

Referenced by execute(), Behavior::executeIfUnsatisfied(), getTimeOfLastRun(), CycleStarter::run(), and setTimeOfLastRun().

Timestamp Component::timeOfRun_

protected

Referenced by HFRadarModelPoint::run().

DataWriter* Component::voltageWriter_

protected

Referenced by logVoltage().

FlexArray<DataWriter*> Component::writers_

protected

Referenced by getWriterList(), registerWriter(), requestData(), setFailure(), setRunState(), unregisterWriter(), and ~Component().

Timestamp Component::writeTimestamp_

protected

Time of last write.

Referenced by getWriteTimestamp(), and setWriteTimestamp().

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

/Volumes/ubuntu_share/lrauv-application/Source/component/Component.h
/Volumes/ubuntu_share/lrauv-application/Source/component/Component.cpp

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation