DtSetSurfaceVesselLightingRequest Class Reference

DtSetSurfaceVesselLightingRequest sets advanced lighting settings for the specified object Supported enumurations can be found at vrfutil/extendedLightingUtils.h.

Inheritance diagram for DtSetSurfaceVesselLightingRequest:

Public Member Functions
	DtSetSurfaceVesselLightingRequest ()
	DtSetSurfaceVesselLightingRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSetSurfaceVesselLightingRequest (const DtString &writeName, const DtSetSurfaceVesselLightingRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSetSurfaceVesselLightingRequest &	operator= (const DtSetSurfaceVesselLightingRequest &orig)
virtual	~DtSetSurfaceVesselLightingRequest ()
virtual const DtSetMessageType &	type () const
virtual DtSetDataRequest *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	stringRep () const
virtual bool	anchorLightsOn () const
virtual void	setAnchorLightsOn (bool myAnchorLightsOn)
virtual bool	anchorLightsOnSpecified () const
virtual bool	warningLightsOn () const
virtual void	setWarningLightsOn (bool warningLightsOn)
virtual bool	warningLightsOnSpecified () const
virtual bool	distressBeaconOn () const
virtual void	setDistressBeaconOn (bool distressBeaconOn)
virtual bool	distressBeaconOnSpecified () const
virtual int	flightDeckLights () const
virtual void	setFlightDeckLights (int flightDeckLights)
virtual bool	flightDeckLightsSpecified () const
virtual bool	upperDeckFloodLightsOn () const
virtual void	setUpperDeckFloodLightsOn (bool upperDeckFloodLightsOn)
virtual bool	upperDeckFloodLightsOnSpecified () const
virtual bool	upperDeckLightsOn () const
virtual void	setUpperDeckLightsOn (bool upperDeckLightsOn)
virtual bool	upperDeckLightsOnSpecified () const
virtual int	horizonBarLights () const
virtual void	setHorizonBarLights (int horizonBarLights)
virtual bool	horizonBarLightsSpecified () const
virtual int	glidePathIndicatorBeam () const
virtual void	setGlidePathIndicatorBeam (int glidePathIndicatorBeam)
virtual bool	glidePathIndicatorBeamSpecified () const
virtual bool	waveOffLightOn () const
virtual void	setWaveOffLightOn (bool waveOffLightOn)
virtual bool	waveOffLightOnSpecified () const
virtual bool	notUnderCommandLightsOn () const
virtual void	setNotUnderCommandLightsOn (bool notUnderCommandLightsOn)
virtual bool	notUnderCommandLightsOnSpecified () const
virtual bool	ramLightsOn () const
virtual void	setRAMLightsOn (bool ramLightsOn)
virtual bool	ramLightsOnSpecified () const
virtual bool	fishingWithLinesLightsOn () const
virtual void	setFishingWithLinesLightsOn (bool fishingWithLinesLightsOn)
virtual bool	fishingWithLinesLightsOnSpecified () const
virtual bool	fishingWithNetsLightsOn () const
virtual void	setFishingWithNetsLightsOn (bool fishingWithNetsLightsOn)
virtual bool	fishingWithNetsLightsOnSpecified () const
virtual bool	mineHuntingLightsOn () const
virtual void	setMineHuntingLightsOn (bool mineHuntingLightsOn)
virtual bool	mineHuntingLightsOnSpecified () const
virtual bool	runningLightsOn () const
virtual void	setRunningLightsOn (bool runningLightsOn)
virtual bool	runningLightsOnSpecified () const
virtual bool	spotLightsOn () const
virtual void	setSpotLightsOn (bool spotLightsOn)
virtual bool	spotLightsOnSpecified () const
virtual bool	interiorLightsOn () const
virtual void	setInteriorLightsOn (bool interiorLightsOn)
virtual bool	interiorLightsOnSpecified () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
Public Member Functions inherited from DtSetDataRequest
virtual	~DtSetDataRequest ()
virtual bool	init ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual char *	netRep ()
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs) const
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtSetDataRequest *	creator ()
Static Public Member Functions inherited from DtSetDataRequest
static DtSetDataRequest *	createSetDataRequest (DtlObjPtr mtlStream)
static DtSetDataRequest *	createSetDataRequest (DtSetMessageType requestType)
static void	addSetDataRequestCreatorFcn (const DtSetMessageType &setDataName, DtSetDataRequestCreatorFcn fcn)
static void	setFactory (DtSetDataRequestFactory *factory)
static DtSetDataRequestFactory *	factory ()
static bool	isTypeRegistered (DtSetMessageType setDataType)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes
DtRwBoolean	myAnchorLightsOn
DtRwBoolean	myWarningLightsOn
DtRwBoolean	myDistressBeaconOn
DtRwInt8	myFlightDeckLights
DtRwBoolean	myUpperDeckFloodLightsOn
DtRwBoolean	myUpperDeckLightsOn
DtRwInt8	myHorizonBarLights
DtRwInt8	myGlidePathIndicatorBeam
DtRwBoolean	myWaveOffLightOn
DtRwBoolean	myNotUnderCommandLightsOn
DtRwBoolean	myRAMLightsOn
DtRwBoolean	myFishingWithLinesLightsOn
DtRwBoolean	myFishingWithNetsLightsOn
DtRwBoolean	myMineHuntingLightsOn
DtRwBoolean	myRunningLightsOn
DtRwBoolean	mySpotLightsOn
DtRwBoolean	myInteriorLightsOn
Protected Attributes inherited from DtSetDataRequest
char *	myNetRep
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtSetDataRequest
	DtSetDataRequest ()
	DtSetDataRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSetDataRequest (const DtString &writeName, const DtSetDataRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSetDataRequest &	operator= (const DtSetDataRequest &orig)
virtual char *	createNetworkBuffer ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtSetDataRequest
static DtSetDataRequestFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtSetSurfaceVesselLightingRequest::DtSetSurfaceVesselLightingRequest

(

)

default constructor

DtSetSurfaceVesselLightingRequest::DtSetSurfaceVesselLightingRequest	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtSetSurfaceVesselLightingRequest::DtSetSurfaceVesselLightingRequest	(	const DtString &	writeName,
		const DtSetSurfaceVesselLightingRequest &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtSetSurfaceVesselLightingRequest::~DtSetSurfaceVesselLightingRequest ( )

virtual

Member Function Documentation

const DtSetSurfaceVesselLightingRequest& DtSetSurfaceVesselLightingRequest::operator=

(

const DtSetSurfaceVesselLightingRequest &

orig

)

assignment operator

virtual const DtSetMessageType& DtSetSurfaceVesselLightingRequest::type ( ) const

virtual

Returns DtSetSurfaceVesselLightingRequestType.

Implements DtSetDataRequest.

virtual DtSetDataRequest* DtSetSurfaceVesselLightingRequest::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = 0  ) const

virtual

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetSurfaceVesselLightingRequest::stringRep ( ) const

virtual

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual bool DtSetSurfaceVesselLightingRequest::anchorLightsOn ( ) const

virtual

Whether the anchor lights are on.

virtual void DtSetSurfaceVesselLightingRequest::setAnchorLightsOn ( bool  myAnchorLightsOn )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::anchorLightsOnSpecified ( ) const

virtual

virtual bool DtSetSurfaceVesselLightingRequest::warningLightsOn ( ) const

virtual

Whether the warning lights are on.

virtual void DtSetSurfaceVesselLightingRequest::setWarningLightsOn ( bool  warningLightsOn )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::warningLightsOnSpecified ( ) const

virtual

virtual bool DtSetSurfaceVesselLightingRequest::distressBeaconOn ( ) const

virtual

Whether the distress beacon is on.

virtual void DtSetSurfaceVesselLightingRequest::setDistressBeaconOn ( bool  distressBeaconOn )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::distressBeaconOnSpecified ( ) const

virtual

virtual int DtSetSurfaceVesselLightingRequest::flightDeckLights ( ) const

virtual

Whether the flight deck lights are on.

virtual void DtSetSurfaceVesselLightingRequest::setFlightDeckLights ( int  flightDeckLights )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::flightDeckLightsSpecified ( ) const

virtual

virtual bool DtSetSurfaceVesselLightingRequest::upperDeckFloodLightsOn ( ) const

virtual

Whether the upper deck flood lights are on.

virtual void DtSetSurfaceVesselLightingRequest::setUpperDeckFloodLightsOn ( bool  upperDeckFloodLightsOn )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::upperDeckFloodLightsOnSpecified ( ) const

virtual

virtual bool DtSetSurfaceVesselLightingRequest::upperDeckLightsOn ( ) const

virtual

Whether the upper deck lights are on.

virtual void DtSetSurfaceVesselLightingRequest::setUpperDeckLightsOn ( bool  upperDeckLightsOn )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::upperDeckLightsOnSpecified ( ) const

virtual

virtual int DtSetSurfaceVesselLightingRequest::horizonBarLights ( ) const

virtual

Whether the horizon bar lights are on/intensity.

virtual void DtSetSurfaceVesselLightingRequest::setHorizonBarLights ( int  horizonBarLights )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::horizonBarLightsSpecified ( ) const

virtual

virtual int DtSetSurfaceVesselLightingRequest::glidePathIndicatorBeam ( ) const

virtual

Whether the glide path indicator beam is on/instensity.

virtual void DtSetSurfaceVesselLightingRequest::setGlidePathIndicatorBeam ( int  glidePathIndicatorBeam )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::glidePathIndicatorBeamSpecified ( ) const

virtual

virtual bool DtSetSurfaceVesselLightingRequest::waveOffLightOn ( ) const

virtual

Whether the wave off light is on.

virtual void DtSetSurfaceVesselLightingRequest::setWaveOffLightOn ( bool  waveOffLightOn )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::waveOffLightOnSpecified ( ) const

virtual

virtual bool DtSetSurfaceVesselLightingRequest::notUnderCommandLightsOn ( ) const

virtual

Whether the not under command lights are on.

virtual void DtSetSurfaceVesselLightingRequest::setNotUnderCommandLightsOn ( bool  notUnderCommandLightsOn )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::notUnderCommandLightsOnSpecified ( ) const

virtual

virtual bool DtSetSurfaceVesselLightingRequest::ramLightsOn ( ) const

virtual

Whether the RAM lights are on.

virtual void DtSetSurfaceVesselLightingRequest::setRAMLightsOn ( bool  ramLightsOn )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::ramLightsOnSpecified ( ) const

virtual

virtual bool DtSetSurfaceVesselLightingRequest::fishingWithLinesLightsOn ( ) const

virtual

Whether the fishing with lines lights are on.

virtual void DtSetSurfaceVesselLightingRequest::setFishingWithLinesLightsOn ( bool  fishingWithLinesLightsOn )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::fishingWithLinesLightsOnSpecified ( ) const

virtual

virtual bool DtSetSurfaceVesselLightingRequest::fishingWithNetsLightsOn ( ) const

virtual

Whether the fishing with nets lights are on.

virtual void DtSetSurfaceVesselLightingRequest::setFishingWithNetsLightsOn ( bool  fishingWithNetsLightsOn )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::fishingWithNetsLightsOnSpecified ( ) const

virtual

virtual bool DtSetSurfaceVesselLightingRequest::mineHuntingLightsOn ( ) const

virtual

Whether the mine hunting lights are on.

virtual void DtSetSurfaceVesselLightingRequest::setMineHuntingLightsOn ( bool  mineHuntingLightsOn )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::mineHuntingLightsOnSpecified ( ) const

virtual

virtual bool DtSetSurfaceVesselLightingRequest::runningLightsOn ( ) const

virtual

Whether the running lights are on.

virtual void DtSetSurfaceVesselLightingRequest::setRunningLightsOn ( bool  runningLightsOn )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::runningLightsOnSpecified ( ) const

virtual

virtual bool DtSetSurfaceVesselLightingRequest::spotLightsOn ( ) const

virtual

Whether the spot lights are on.

virtual void DtSetSurfaceVesselLightingRequest::setSpotLightsOn ( bool  spotLightsOn )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::spotLightsOnSpecified ( ) const

virtual

virtual bool DtSetSurfaceVesselLightingRequest::interiorLightsOn ( ) const

virtual

Whether the interior lights are on.

virtual void DtSetSurfaceVesselLightingRequest::setInteriorLightsOn ( bool  interiorLightsOn )

virtual

virtual bool DtSetSurfaceVesselLightingRequest::interiorLightsOnSpecified ( ) const

virtual

virtual int DtSetSurfaceVesselLightingRequest::netRepSize ( ) const

virtual

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSetDataRequest.

virtual bool DtSetSurfaceVesselLightingRequest::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetSurfaceVesselLightingRequest::setToNet ( )

virtual

Fills in the network buffer the set data request contents.

Reimplemented from DtSetDataRequest.

static DtSetDataRequest* DtSetSurfaceVesselLightingRequest::creator ( )

static

Member Data Documentation

DtRwBoolean DtSetSurfaceVesselLightingRequest::myAnchorLightsOn

protected

DtRwBoolean DtSetSurfaceVesselLightingRequest::myWarningLightsOn

protected

DtRwBoolean DtSetSurfaceVesselLightingRequest::myDistressBeaconOn

protected

DtRwInt8 DtSetSurfaceVesselLightingRequest::myFlightDeckLights

protected

DtRwBoolean DtSetSurfaceVesselLightingRequest::myUpperDeckFloodLightsOn

protected

DtRwBoolean DtSetSurfaceVesselLightingRequest::myUpperDeckLightsOn

protected

DtRwInt8 DtSetSurfaceVesselLightingRequest::myHorizonBarLights

protected

DtRwInt8 DtSetSurfaceVesselLightingRequest::myGlidePathIndicatorBeam

protected

DtRwBoolean DtSetSurfaceVesselLightingRequest::myWaveOffLightOn

protected

DtRwBoolean DtSetSurfaceVesselLightingRequest::myNotUnderCommandLightsOn

protected

DtRwBoolean DtSetSurfaceVesselLightingRequest::myRAMLightsOn

protected

DtRwBoolean DtSetSurfaceVesselLightingRequest::myFishingWithLinesLightsOn

protected

DtRwBoolean DtSetSurfaceVesselLightingRequest::myFishingWithNetsLightsOn

protected

DtRwBoolean DtSetSurfaceVesselLightingRequest::myMineHuntingLightsOn

protected

DtRwBoolean DtSetSurfaceVesselLightingRequest::myRunningLightsOn

protected

DtRwBoolean DtSetSurfaceVesselLightingRequest::mySpotLightsOn

protected

DtRwBoolean DtSetSurfaceVesselLightingRequest::myInteriorLightsOn

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrftasks/setSurfaceVesselLightingRequest.h