VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes
DtShipClutterAreaControllerDescriptor Class Reference

/******************************************************************************* ** Copyright (c) 2022 MAK Technologies, Inc. ** All rights reserved. *******************************************************************************/

Instances of DtShipClutterAreaControllerDescriptor are used to specify the parameters for a DtShipClutterAreaController object.

Inheritance diagram for DtShipClutterAreaControllerDescriptor:
Inheritance graph
[legend]

Classes

class  IMOEntry
 
class  MMSIEntry
 
class  VesselTypeCodeEntry
 

Public Types

typedef DtRwTemplatedListPtr
< MMSIEntry, true > 		MMSIMappingList
 
typedef DtRwTemplatedListPtr
< IMOEntry, true > 		IMOMappingList
 
typedef DtRwTemplatedListPtr
< VesselTypeCodeEntry, true > 		VesselTypeCodeList
 
- 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 )()
 

Public Member Functions

 DtShipClutterAreaControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtShipClutterAreaControllerDescriptor ()
 
 DtShipClutterAreaControllerDescriptor (const DtShipClutterAreaControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
 
DtShipClutterAreaControllerDescriptor & operator= (const DtShipClutterAreaControllerDescriptor &orig)
 
virtual DtString type () const override
 
virtual const MMSIMappingList & mmsiMappingList () const
 
virtual const IMOMappingList & imoMappingList () const
 
virtual const VesselTypeCodeList & vesselTypeCodeList () const
 
virtual const DtRwEntityTypeList & excludedEntityTypes () const
 
virtual DtComponentDescriptor * clone (DtReaderWriterRegistry *parentRegistry=0) const
 
virtual int maxClutterShipsPerArea () const
 
virtual void setMaxClutterShipsPerArea (int n)
 
virtual int maxEntitiesCreatedPerTick () const
 
virtual void setEntitiesCreatedPerTick (int n)
 
virtual double checkPeriod () const
 
virtual void setCheckPeriod (int p)
 
virtual double requestPeriod () const
 
virtual void setRequestPeriod (int p)
 
- Public Member Functions inherited from DtComponentDescriptor
 DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
DtComponentDescriptor & operator= (const DtComponentDescriptor &orig)
 
virtual ~DtComponentDescriptor ()
 
virtual void putData (std::string &fp, int indentLevel=0)
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual bool init ()
 
virtual const DtString & stateAndParameterDataPrefix () const
 
bool operator== (const DtComponentDescriptor &) const
 
 DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual void setComponentType (const DtString &componentType)
 
virtual const DtString & componentType () const
 
virtual void setMinTickPeriod (DtReal minTickPeriod)
 
virtual DtReal minTickPeriod () const
 
virtual void setMinTickPeriodVariance (DtReal minTickPeriodVariance)
 
virtual DtReal minTickPeriodVariance () const
 
virtual void setPeriodicTickWhilePaused (bool value)
 
virtual bool periodicTickWhilePaused () const
 
virtual const DtString & processStateRepositoryName () const
 
virtual void setProcessStateRepositoryName (const DtString &name)
 
virtual const DtString & processStateRepositoryType () const
 
virtual void setProcessStateRepositoryType (const DtString &type)
 
virtual void setIsEnabled (bool yesNo)
 
virtual bool isEnabled () const
 
virtual void setIsEnabledForClutterEntities (bool yesNo)
 
virtual bool isEnabledForClutterEntities () const
 
virtual void setDebugActive (bool active)
 
virtual bool debugActive () const
 
virtual void setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)
 
virtual DtReal minTaskVisualizationTickPeriod () const
 
virtual void setTaskVisualizationsEnabled (bool enabled)
 
virtual bool taskVisualizationsEnabled () const
 
virtual void setCreateComponent (bool yesNo)
 
virtual bool createComponent () const
 
virtual void setCreateOnRemoteObject (bool yesNo)
 
virtual bool createOnRemoteObject () const
 
virtual const
DtRwNLengthStringVector & 		scriptIds () const
 
virtual DtRwNLengthStringVector & scriptIds ()
 
virtual const
DtRwScriptVariablesList & 		scriptVariables () const
 
virtual DtRwScriptVariablesList & scriptVariables ()
 
virtual const DtRwProperties & parameterData () const
 
virtual DtRwProperties & parameterData ()
 
virtual const DtRwProperties & stateData () const
 
virtual DtRwProperties & stateData ()
 
- 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)
 
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 DtComponentDescriptor * creator ()
 
- Static Public Member Functions inherited from DtComponentDescriptor
static void addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
 
static DtComponentDescriptor * createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
static DtComponentDescriptor * createComponentDescriptor (const char *pName)
 
static DtComponentDescriptor * creator ()
 
static
DtComponentDescriptorFactory * 		factory ()
 
static void setFactory (DtComponentDescriptorFactory *factory)
 
- 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

MMSIMappingList myMMSIMappingList
 
IMOMappingList myIMOMappingList
 
VesselTypeCodeList myVesselTypeCodeList
 
DtRwEntityTypeList myExcludedEntityTypes
 
parameters

These parameters are available for setting in the OPD files.

DtRwInt myMaxClutterShipsPerArea
 
DtRwInt myMaxEntitiesCreatedPerTick
 
DtRwReal myCheckPeriod
 
DtRwReal myRequestPeriod
 
- Protected Attributes inherited from DtComponentDescriptor
bool myPrefixAppliedToStateAndParamData
 
DtRwString myComponentType
 
DtRwReal myMinTickPeriod
 
DtRwReal myMinTickPeriodVariance
 
DtRwBoolean myPeriodicTickWhilePaused
 
DtRwString myProcessStateRepositoryName
 
DtRwString myProcessStateRepositoryType
 
DtRwBoolean myIsEnabled
 
DtRwBoolean myIsEnabledForClutterEntities
 
DtRwBoolean myDebug
 
DtRwReal myMinTaskVisualizationTickPeriod
 
DtRwBoolean myTaskVisualizationsEnabled
 
DtRwBoolean myCreateComponent
 
DtRwBoolean myCreateOnRemoteObject
 
DtRwProperties myParameterData
 
DtRwProperties myStateData
 
DtRwString myStateAndParameterDataPrefix
 
DtRwNLengthStringVector myScriptIds
 
DtRwScriptVariablesList myScriptVariables
 
- 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

- Protected Member Functions inherited from DtComponentDescriptor
 DtComponentDescriptor ()
 
void addPrefixToStateAndParameterData ()
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 
- Static Protected Attributes inherited from DtComponentDescriptor
static
DtComponentDescriptorFactory * 		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
 

Member Typedef Documentation

typedef DtRwTemplatedListPtr<MMSIEntry, true> DtShipClutterAreaControllerDescriptor::MMSIMappingList
typedef DtRwTemplatedListPtr<IMOEntry, true> DtShipClutterAreaControllerDescriptor::IMOMappingList
typedef DtRwTemplatedListPtr<VesselTypeCodeEntry, true> DtShipClutterAreaControllerDescriptor::VesselTypeCodeList

Constructor & Destructor Documentation

DtShipClutterAreaControllerDescriptor::DtShipClutterAreaControllerDescriptor ( const DtString &  name,
DtReaderWriterRegistry *  parentRegistry = 0 
)

constructor

virtual DtShipClutterAreaControllerDescriptor::~DtShipClutterAreaControllerDescriptor ( )
virtual

destructor

DtShipClutterAreaControllerDescriptor::DtShipClutterAreaControllerDescriptor ( const DtShipClutterAreaControllerDescriptor &  orig,
DtReaderWriterRegistry *  parentRegistry = 0 
)

copy constructor

Member Function Documentation

DtShipClutterAreaControllerDescriptor& DtShipClutterAreaControllerDescriptor::operator= ( const DtShipClutterAreaControllerDescriptor &  orig)

assignment operator

virtual DtString DtShipClutterAreaControllerDescriptor::type ( ) const
overridevirtual

Returns the type of component this descriptor describes. Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns
DtDynamicTerrainControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual const MMSIMappingList& DtShipClutterAreaControllerDescriptor::mmsiMappingList ( ) const
virtual
virtual const IMOMappingList& DtShipClutterAreaControllerDescriptor::imoMappingList ( ) const
virtual
virtual const VesselTypeCodeList& DtShipClutterAreaControllerDescriptor::vesselTypeCodeList ( ) const
virtual
virtual const DtRwEntityTypeList& DtShipClutterAreaControllerDescriptor::excludedEntityTypes ( ) const
virtual
virtual int DtShipClutterAreaControllerDescriptor::maxClutterShipsPerArea ( ) const
virtual

Setter and getter for myMaxClutterShipsPerArea.

virtual void DtShipClutterAreaControllerDescriptor::setMaxClutterShipsPerArea ( int  n)
virtual

Setter and getter for myMaxClutterShipsPerArea.

virtual int DtShipClutterAreaControllerDescriptor::maxEntitiesCreatedPerTick ( ) const
virtual

Setter and getter for myMaxEntitiesCreatedPerTick.

virtual void DtShipClutterAreaControllerDescriptor::setEntitiesCreatedPerTick ( int  n)
virtual

Setter and getter for myMaxEntitiesCreatedPerTick.

virtual double DtShipClutterAreaControllerDescriptor::checkPeriod ( ) const
virtual

Setter and getter for myCheckPeriod.

virtual void DtShipClutterAreaControllerDescriptor::setCheckPeriod ( int  p)
virtual

Setter and getter for myCheckPeriod.

virtual double DtShipClutterAreaControllerDescriptor::requestPeriod ( ) const
virtual

Setter and getter for myRequestPeriod.

virtual void DtShipClutterAreaControllerDescriptor::setRequestPeriod ( int  p)
virtual

Setter and getter for myRequestPeriod.

virtual DtComponentDescriptor* DtShipClutterAreaControllerDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = 0) const
virtual

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtShipClutterAreaControllerDescriptor::creator ( )
static

Returns
Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Member Data Documentation

MMSIMappingList DtShipClutterAreaControllerDescriptor::myMMSIMappingList
protected
IMOMappingList DtShipClutterAreaControllerDescriptor::myIMOMappingList
protected
VesselTypeCodeList DtShipClutterAreaControllerDescriptor::myVesselTypeCodeList
protected
DtRwEntityTypeList DtShipClutterAreaControllerDescriptor::myExcludedEntityTypes
protected
DtRwInt DtShipClutterAreaControllerDescriptor::myMaxClutterShipsPerArea
protected

Parameter Name: max-clutter-ships-per-area
Parameter Description: The maximum number of clutter ship entities to create in a single area.
Parameter Default Value: 1000

DtRwInt DtShipClutterAreaControllerDescriptor::myMaxEntitiesCreatedPerTick
protected

Parameter Name: max-entities-created-per-tick
Parameter Description: The maximum number of clutter ship entities to create in a single tick.
Parameter Default Value: 60

DtRwReal DtShipClutterAreaControllerDescriptor::myCheckPeriod
protected

Parameter Name: check-period
Parameter Description: The period at which ships are re-checked if they cannot currently be added, perhaps because they are owned by another controller.
Parameter Default Value: 30.0 seconds

DtRwReal DtShipClutterAreaControllerDescriptor::myRequestPeriod
protected

Parameter Name: request-period
Parameter Description: The period at which to request track data from the data manager.
Parameter Default Value: 7200.0 seconds

The documentation for this class was generated from the following file:
Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)