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

Local network interface for global environment state objects. These objects must have a DtGlobalEnvironmentStateRepository to work with this net interface.

Inheritance diagram for makVrf::DtGlobalEnvironmentLocalNetInterface:
Inheritance graph
[legend]

Public Member Functions

 DtGlobalEnvironmentLocalNetInterface (DtStateData *vrfObject, DtVrlinkNetworkInterface *, bool publishObject=true)
 
virtual ~DtGlobalEnvironmentLocalNetInterface ()
 
virtual void updatePublisher ()
 
virtual void setupRecords ()
 
virtual DtString type () const
 
virtual int weatherRecordIndex () const
 
- Public Member Functions inherited from makVrf::DtWeatherLocalNetInterface
 DtWeatherLocalNetInterface (DtStateData *vrfObject, DtVrlinkNetworkInterface *, bool publishObject=true)
 
virtual ~DtWeatherLocalNetInterface ()
 
virtual bool init (const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
 
virtual void destroyPublisher ()
 
- Public Member Functions inherited from makVrf::DtSimLocalControlObjectNetInterface
 DtSimLocalControlObjectNetInterface (DtStateData *vrfObject, DtVrlinkNetworkInterface *mgr, bool publishObject=true)
 
virtual ~DtSimLocalControlObjectNetInterface ()
 
virtual void forceUpdate ()
 
virtual DtControlObjectRepositorycontrolObjectNetworkState () const
 
virtual DtObjectPublisherpublisher ()
 
virtual bool setEntityPublisher (DtVrfExtControlObjectPublisher *publisher)
 
virtual
DtVrfExtControlObjectPublisher
controlObjectPublisher () const
 
virtual void updateUuid ()
 
- Public Member Functions inherited from makVrf::DtSimLocalEnvironmentalNetInterface
 DtSimLocalEnvironmentalNetInterface (DtStateData *vrfObject, DtVrlinkNetworkInterface *mgr, bool publishObject=true)
 
virtual ~DtSimLocalEnvironmentalNetInterface ()
 
virtual bool publisherUserSupplied () const
 
virtual bool setEntityPublisher (DtEnvironmentProcessPublisher *publisher)
 
virtual
DtEnvironmentProcessPublisher
environmentalPublisher () const
 
virtual void setupNetworkRepository ()
 
virtual bool publishObject () const
 
virtual bool isLocal () const
 
virtual RTI::ObjectClassHandle objectClassHandle () const
 
- Public Member Functions inherited from makVrf::DtSimEnvironmentalNetInterface
 DtSimEnvironmentalNetInterface (DtStateData *simObject, DtVrlinkNetworkInterface *objMgr, bool publishObject=true)
 
virtual ~DtSimEnvironmentalNetInterface ()
 
virtual bool init ()
 
virtual
DtEnvironmentProcessRepository
environmentalNetworkState () const
 
virtual bool isUnit () const
 
virtual bool isEntity () const
 
virtual bool isEnvironmental () const
 
- Public Member Functions inherited from makVrf::DtSimObjectNetInterface
 DtSimObjectNetInterface (DtStateData *simObject, DtVrlinkNetworkInterface *, bool publishObject=true)
 
virtual ~DtSimObjectNetInterface ()
 
virtual void tick ()
 
virtual int maxNameLength () const
 
virtual void toBeRemoved ()
 
virtual void parallelTick ()
 

Static Public Member Functions

static DtSimObjectNetInterfacecreator (DtStateData *vrfObject, DtVrlinkNetworkInterface *, bool publishObject)
 
- Static Public Member Functions inherited from makVrf::DtWeatherLocalNetInterface
static DtSimObjectNetInterfacecreator (DtStateData *vrfObject, DtVrlinkNetworkInterface *, bool publishObject)
 
- Static Public Member Functions inherited from makVrf::DtSimLocalControlObjectNetInterface
static DtSimObjectNetInterfacecreator (DtStateData *vrfObject, DtVrlinkNetworkInterface *mgr, bool publishObject)
 
- Static Public Member Functions inherited from makVrf::DtSimLocalEnvironmentalNetInterface
static
DtSimLocalEnvironmentalNetInterface
isLocalEnvironmentalNetInterface (const DtSimObjectNetInterface *objNetInterface)
 
static void setHeartbeatVariance (double variance)
 
static double heartbeatVariance ()
 
- Static Public Member Functions inherited from makVrf::DtSimEnvironmentalNetInterface
static
DtSimEnvironmentalNetInterface
isEnvironmentalNetInterface (const DtSimObjectNetInterface *objNetInterface)
 
- Static Public Member Functions inherited from makVrf::DtSimObjectNetInterface
static void setNonVrfUUIDResolver (DtNonVrfUUIDResolver *)
 
static DtNonVrfUUIDResolvernonVrfUUIDResolver ()
 
static void addSimObjectNetInterfaceCreatorFcn (const DtString &type, DtSimObjectNetIfaceCreatorFcn fcn)
 
static void setFactory (DtSimObjectNetInterfaceFactory *factory)
 
static
DtSimObjectNetInterfaceFactory
factory ()
 
static DtSimObjectNetInterfacecreateNetInterface (const DtString &type, DtStateData *simObject, DtVrlinkNetworkInterface *, bool publishObject=true)
 
static int maxNameLengthForInterfaceType (const DtString &interfaceTypeString)
 
static void setNonVrfObjectsUUIDScheme (const DtString &)
 
static DtString nonVrfObjectsUUIDScheme ()
 

Protected Member Functions

virtual
DtEnvironmentProcessPublisher
_createPublisher (const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
 
virtual void updateStateRecord ()
 
virtual void updateV3EnvironmentalRecord ()
 
virtual void setupMetocPublisher () override
 
virtual bool metocAvailable (DtString &reasonUnavailable) const
 
- Protected Member Functions inherited from makVrf::DtWeatherLocalNetInterface
virtual
DtEnvironmentProcessRepository
epsr () const
 
virtual void updateGeometryRecord ()
 
virtual void updateWindLayers ()
 
virtual bool createPublisher (const DtEntityIdentifier &entityId)
 
virtual void metocTick ()
 
virtual void updateMetocPublishers ()
 
virtual void updateMetocSurfacePublishers (const DtWeatherStateComponent *)
 
virtual void updateMetocSubsurfacePublishers (const DtWeatherStateComponent *)
 
virtual void updateMetocWaterPublishers (const DtWeatherStateComponent *)
 
virtual void updateMetocTropospherePublishers (const DtWeatherStateComponent *)
 
virtual void updateCommonMetocWeatherRepository (const DtWeatherStateComponent *, DtVrfWeatherStateRepositoryPtr repo)
 
virtual void updateMetocGeoreference (const DtWeatherStateComponent *, DtVrfEnvironmentConditionStateRepositoryPtr repo)
 
virtual void onTick () override
 
virtual std::vector< unsignedmapCloudStateToLayerAltitudes (DtVrfWeatherCloudState cloudState) const
 
virtual DtCloudTypeEnum32 mapVrvCloudTypeToMetocCloudType (int) const
 
virtual DtCloudTypeEnum32 mapCloudStateToCloudType (DtVrfWeatherCloudState cloudState, unsigned altitude) const
 
virtual float mapCloudStateToCloudCoverage (DtVrfWeatherCloudState cloudState, unsigned altitude) const
 
virtual float mapCloudStateToCloudDensity (DtVrfWeatherCloudState cloudState, unsigned altitude) const
 
virtual DtPrecipitationTypeEnum32 mapVrfPrecipitationtypeToMetocPrecipitationType (int vrfPrecipitationType) const
 
virtual DtHazeTypeEnum32 mapFogColorToHazeType (const DtVector &fogColor)
 
virtual DtHazeTypeEnum32 mapObscurantToHazeType (int obscurant)
 
virtual float mapSwellStateToSwellHeight (int state)
 
virtual float mapSwellStateToSwellLength (int state)
 
virtual int mapSwellStateToSwellPeriod (int state)
 
virtual float mapSeaStateToWaveHeight (int state)
 
virtual float mapSeaStateToWaveLength (int state)
 
virtual int mapSeaStateToWavePeriod (int state)
 
virtual DtGeoLocationTypeEnum32 mapEntityTypeToGeoLocationType (const DtObjectType &type)
 
- Protected Member Functions inherited from makVrf::DtSimLocalControlObjectNetInterface
virtual bool updateGeometry ()
 
virtual bool updateBoundingGeometry ()
 
virtual bool updateObjectState ()
 
virtual bool updateEnvModelType ()
 
virtual bool updateVrfDataAsSeenByRemote ()
 
virtual
DtEnvironmentProcessRepository
_createSR () const
 
virtual const
makVrf::DtEnvironmentalStateComponent
environmentalStateComponent ()
 
virtual const
makVrf::DtEnvironmentalLocationStateComponent
environmentalLocationStateComponent ()
 
virtual const
makVrf::DtVrfStateComponent
vrfStateComponent ()
 
virtual const
makVrf::DtVrfGeometryStateComponent
vrfGeometryStateComponent ()
 
virtual void firstTimeInitialize ()
 
virtual bool wantsToCreatePublisher () const
 
- Protected Member Functions inherited from makVrf::DtSimObjectNetInterface
bool runFullyThreaded () const
 
const DtStateDatavrfObject () const
 
DtStateDatanextFrameVrfObject ()
 
virtual const DtStateRepositorynetworkState () const
 

Protected Attributes

DtVrfSimulationDateTimeStateRecordmySimulationDateTimeRecord
 
DtVrfEnvironmentalWeatherStateRecord_V3myV3EnvironmentalRecord
 
double myLastDateAndTimeOfDay
 
- Protected Attributes inherited from makVrf::DtWeatherLocalNetInterface
DtVrfEnvironmentalWeatherStateRecordmyEnvironmentalStateRecord
 
DtVrfSubsurfacePublisherPtr myMetocSubsurfacePublisher
 
DtVrfLandSurfacePublisherPtr myMetocSurfacePublisher
 
DtVrfWaterSurfacePublisherPtr myMetocWaterPublisher
 
std::vector
< DtVrfTropospherePublisherPtr
myMetocTropospherePublishers
 
bool mySetMetocGeoreference
 
DtGeoLocationTypeEnum32 myMetocGeoLocationType
 
- Protected Attributes inherited from makVrf::DtSimLocalControlObjectNetInterface
bool myPublisherUserSupplied
 
DtVrfExtControlObjectPublishermyControlObjectPublisher
 
std::vector< charmyPropertyBuffer
 
DtClock myClock
 
DtTime myLastTimeUpdated
 
bool myNeedsFullUpdate
 
const
makVrf::DtEnvironmentalStateComponent
myEnvironmentalStateComponent
 
const
makVrf::DtEnvironmentalLocationStateComponent
myEnvironmentalLocationStateComponent
 
const makVrf::DtVrfStateComponentmyVrfStateComponent
 
const
makVrf::DtVrfGeometryStateComponent
myVrfGeometryStateComponent
 
bool myFirstTimeInitialize
 
DtVector myLastParentPosition
 
- Protected Attributes inherited from makVrf::DtSimLocalEnvironmentalNetInterface
bool myPublisherUserSupplied
 
DtEnvironmentProcessPublishermyEnvironmentalPublisher
 
bool myPublishObject
 
- Protected Attributes inherited from makVrf::DtSimObjectNetInterface
DtStateDatamySimObject
 
DtVrlinkNetworkInterfacemyObjectManager
 
DtStateRepositorymyNetworkState
 
bool myNeedsNetworkSetup
 
DtNetInterfaceParallelLock myLock
 

Private Member Functions

 DtGlobalEnvironmentLocalNetInterface ()
 
 DtGlobalEnvironmentLocalNetInterface (const DtGlobalEnvironmentLocalNetInterface &orig)
 
const
DtGlobalEnvironmentLocalNetInterface
operator= (const DtGlobalEnvironmentLocalNetInterface &orig)
 

Additional Inherited Members

- Static Public Attributes inherited from makVrf::DtSimObjectNetInterface
static tbb::spin_rw_mutex thePublisherCreationMutex
 
static tbb::spin_rw_mutex thePublisherTickMutex
 
- Static Protected Attributes inherited from makVrf::DtWeatherLocalNetInterface
static DtObjectType theAreaType
 
static DtObjectType theBoxType
 
static DtObjectType theCircleType
 
- Static Protected Attributes inherited from makVrf::DtSimLocalEnvironmentalNetInterface
static double theHeartbeatVariance
 
- Static Protected Attributes inherited from makVrf::DtSimObjectNetInterface
static
DtSimObjectNetInterfaceFactory
theFactory
 
static DtNonVrfUUIDResolvertheNonVrfUUIDResolver
 

Constructor & Destructor Documentation

makVrf::DtGlobalEnvironmentLocalNetInterface::DtGlobalEnvironmentLocalNetInterface ( )
private

default constructor

makVrf::DtGlobalEnvironmentLocalNetInterface::DtGlobalEnvironmentLocalNetInterface ( const DtGlobalEnvironmentLocalNetInterface orig)
private
makVrf::DtGlobalEnvironmentLocalNetInterface::DtGlobalEnvironmentLocalNetInterface ( DtStateData vrfObject,
DtVrlinkNetworkInterface ,
bool  publishObject = true 
)

read/writable contructor

virtual makVrf::DtGlobalEnvironmentLocalNetInterface::~DtGlobalEnvironmentLocalNetInterface ( )
virtual

destructor; calls destroyPublisher()

Member Function Documentation

const DtGlobalEnvironmentLocalNetInterface& makVrf::DtGlobalEnvironmentLocalNetInterface::operator= ( const DtGlobalEnvironmentLocalNetInterface orig)
private
virtual void makVrf::DtGlobalEnvironmentLocalNetInterface::updatePublisher ( )
virtual

If set to force update, do it here.

Reimplemented from makVrf::DtWeatherLocalNetInterface.

virtual void makVrf::DtGlobalEnvironmentLocalNetInterface::setupRecords ( )
virtual

Creates and sets the records to the VRL state repository.

Reimplemented from makVrf::DtWeatherLocalNetInterface.

virtual DtString makVrf::DtGlobalEnvironmentLocalNetInterface::type ( ) const
virtual

Return type string for publisher that can be refered to in ope files (see "vrfNetIfTypes.h")

Reimplemented from makVrf::DtWeatherLocalNetInterface.

static DtSimObjectNetInterface* makVrf::DtGlobalEnvironmentLocalNetInterface::creator ( DtStateData vrfObject,
DtVrlinkNetworkInterface ,
bool  publishObject 
)
static
virtual int makVrf::DtGlobalEnvironmentLocalNetInterface::weatherRecordIndex ( ) const
virtual
virtual DtEnvironmentProcessPublisher* makVrf::DtGlobalEnvironmentLocalNetInterface::_createPublisher ( const DtEntityIdentifier &  id = DtEntityIdentifier::nullId())
protectedvirtual

Override this functions to use a subclass of DtEnvironmentProcessPublisher.

Reimplemented from makVrf::DtWeatherLocalNetInterface.

virtual void makVrf::DtGlobalEnvironmentLocalNetInterface::updateStateRecord ( )
protectedvirtual
virtual void makVrf::DtGlobalEnvironmentLocalNetInterface::updateV3EnvironmentalRecord ( )
protectedvirtual
virtual void makVrf::DtGlobalEnvironmentLocalNetInterface::setupMetocPublisher ( )
overrideprotectedvirtual

Create and sets the METOC publisher.

Reimplemented from makVrf::DtWeatherLocalNetInterface.

virtual bool makVrf::DtGlobalEnvironmentLocalNetInterface::metocAvailable ( DtString reasonUnavailable) const
protectedvirtual

Member Data Documentation

DtVrfSimulationDateTimeStateRecord* makVrf::DtGlobalEnvironmentLocalNetInterface::mySimulationDateTimeRecord
protected
DtVrfEnvironmentalWeatherStateRecord_V3* makVrf::DtGlobalEnvironmentLocalNetInterface::myV3EnvironmentalRecord
protected
double makVrf::DtGlobalEnvironmentLocalNetInterface::myLastDateAndTimeOfDay
protected

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

Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)