VR-Forces 5.0.3 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::DtSimRemoteEnvironmentalNetInterface Class Reference
Inheritance diagram for makVrf::DtSimRemoteEnvironmentalNetInterface:
Inheritance graph
[legend]

Public Member Functions

 DtSimRemoteEnvironmentalNetInterface (DtStateData *simObject, DtVrlinkNetworkInterface *, bool publishObject=true)
 
virtual ~DtSimRemoteEnvironmentalNetInterface ()
 
virtual bool init ()
 
virtual void onTick ()
 
virtual void updateFromReflectedObject ()
 
virtual
DtReflectedEnvironmentProcess
reflectedObject () const
 
virtual void setupFromNetworkRepository ()
 
virtual bool isValidReflectedObject (DtReflectedEnvironmentProcess *) const
 
virtual void setReflectedObject (DtReflectedEnvironmentProcess *reflectedObject)
 
virtual void clearReflectedObject ()
 
virtual void toBeRemoved ()
 
virtual bool isLocal () const
 
virtual DtString type () const
 
virtual void setUpdateReceived (bool updateReceived)
 
virtual bool updateReceived () const
 
virtual RTI::ObjectClassHandle objectClassHandle () const
 
virtual bool wantsToCreatePublisher () const
 
- Public Member Functions inherited from makVrf::DtSimEnvironmentalNetInterface
 DtSimEnvironmentalNetInterface (DtStateData *simObject, DtVrlinkNetworkInterface *objMgr, bool publishObject=true)
 
virtual ~DtSimEnvironmentalNetInterface ()
 
virtual DtControlObjectRepositorycontrolObjectNetworkState () const
 
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 bool init (const DtEntityIdentifier &id=DtEntityIdentifier())
 
virtual void tick ()
 
virtual int maxNameLength () const
 
virtual bool publishObject () const
 
virtual void parallelTick ()
 
virtual void forceUpdate ()
 

Static Public Member Functions

static
DtSimRemoteEnvironmentalNetInterface
isRemoteEnvironmentalNetInterface (const DtSimObjectNetInterface *objNetInterface)
 
static void reflectedObjectUpdateCallbackFunction (DtReflectedObject *obj, void *userData)
 
static DtSimObjectNetInterfacecreator (DtStateData *simObject, DtVrlinkNetworkInterface *, bool publishObject)
 
- 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 void updateLocalGeometry ()
 
virtual void updateLocalBoundingGeometry ()
 
virtual void updateLocalObjectState ()
 
virtual void updateLocalObjectType ()
 
virtual void updateLocalModelType ()
 
virtual void updateUUIDIfNeeded ()
 
virtual DtVrfStateComponentgetOrCreateVrfStateComponent (DtControlObjectRepository *netState)
 
virtual
DtStatePropertiesStateComponent
getOrCreateStatePropertiesStateComponent (DtControlObjectRepository *netState)
 
virtual void initializeRemoteStateComponents ()
 
- Protected Member Functions inherited from makVrf::DtSimObjectNetInterface
bool runFullyThreaded () const
 
const DtStateDatavrfObject () const
 
DtStateDatanextFrameVrfObject ()
 
virtual const DtStateRepositorynetworkState () const
 

Protected Attributes

DtReflectedEnvironmentProcessmyReflectedObject
 
bool myUpdateReceived
 
- Protected Attributes inherited from makVrf::DtSimObjectNetInterface
DtStateDatamySimObject
 
DtVrlinkNetworkInterfacemyObjectManager
 
DtStateRepositorymyNetworkState
 
bool myNeedsNetworkSetup
 
DtNetInterfaceParallelLock myLock
 

Private Member Functions

 DtSimRemoteEnvironmentalNetInterface ()
 
 DtSimRemoteEnvironmentalNetInterface (const DtSimRemoteEnvironmentalNetInterface &orig)
 
const
DtSimRemoteEnvironmentalNetInterface
operator= (const DtSimRemoteEnvironmentalNetInterface &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::DtSimObjectNetInterface
static
DtSimObjectNetInterfaceFactory
theFactory
 
static DtNonVrfUUIDResolvertheNonVrfUUIDResolver
 

Constructor & Destructor Documentation

makVrf::DtSimRemoteEnvironmentalNetInterface::DtSimRemoteEnvironmentalNetInterface ( )
private

default constructor

makVrf::DtSimRemoteEnvironmentalNetInterface::DtSimRemoteEnvironmentalNetInterface ( const DtSimRemoteEnvironmentalNetInterface orig)
private

copy constructor

makVrf::DtSimRemoteEnvironmentalNetInterface::DtSimRemoteEnvironmentalNetInterface ( DtStateData simObject,
DtVrlinkNetworkInterface ,
bool  publishObject = true 
)

read/writable contructor

virtual makVrf::DtSimRemoteEnvironmentalNetInterface::~DtSimRemoteEnvironmentalNetInterface ( )
virtual

destructor

Member Function Documentation

const DtSimRemoteEnvironmentalNetInterface& makVrf::DtSimRemoteEnvironmentalNetInterface::operator= ( const DtSimRemoteEnvironmentalNetInterface orig)
private

assignment operator

virtual bool makVrf::DtSimRemoteEnvironmentalNetInterface::init ( )
virtual

override of base class init(). Registers for post update callbacks on reflected object.

Reimplemented from makVrf::DtSimEnvironmentalNetInterface.

virtual void makVrf::DtSimRemoteEnvironmentalNetInterface::onTick ( )
virtual
virtual void makVrf::DtSimRemoteEnvironmentalNetInterface::updateFromReflectedObject ( )
virtual

this will copy from the reflected environment process and associated network state repository to the local state repository

Reimplemented in makVrf::DtRemoteExtendedPropertiesNetInterface< DtVrfRemoteEnvironmentalNetInterface, DtControlObjectRepository >, and makVrf::DtRemoteTacticalSmokeNetInterface.

virtual DtReflectedEnvironmentProcess* makVrf::DtSimRemoteEnvironmentalNetInterface::reflectedObject ( ) const
virtual

returns the pointer to the VR-Link reflected entity being used to represent this remote entity

virtual void makVrf::DtSimRemoteEnvironmentalNetInterface::setupFromNetworkRepository ( )
virtual

initializes parts of the local repository from the network state rep. This needs to be done after the call to setReflectedObject()

virtual bool makVrf::DtSimRemoteEnvironmentalNetInterface::isValidReflectedObject ( DtReflectedEnvironmentProcess ) const
virtual

This method will return false if the reflected object type is not of DtReflectedEnvironmentProcess. Make sure to check the return value of this method as this is an invalid initialization if that occurs.

virtual void makVrf::DtSimRemoteEnvironmentalNetInterface::setReflectedObject ( DtReflectedEnvironmentProcess reflectedObject)
virtual

A reflected object must always be supplied. This function also sets the network state repository pointer (myBaseNetworkState) to the repository created by this reflected object.

virtual void makVrf::DtSimRemoteEnvironmentalNetInterface::clearReflectedObject ( )
virtual
virtual void makVrf::DtSimRemoteEnvironmentalNetInterface::toBeRemoved ( )
virtual

Called when this object is removed.

Reimplemented from makVrf::DtSimObjectNetInterface.

virtual bool makVrf::DtSimRemoteEnvironmentalNetInterface::isLocal ( ) const
inlinevirtual

Is this network interface for a local (true) or remote (false) object? Local network interfaces should implement this function to return true. Remote network interfaces should implement this to return true.

Implements makVrf::DtSimObjectNetInterface.

virtual DtString makVrf::DtSimRemoteEnvironmentalNetInterface::type ( ) const
virtual
virtual void makVrf::DtSimRemoteEnvironmentalNetInterface::setUpdateReceived ( bool  updateReceived)
virtual

Setting update received to true will cause updateFromRemoteObject() to be called on the next tick.

virtual bool makVrf::DtSimRemoteEnvironmentalNetInterface::updateReceived ( ) const
virtual

Check to see if an update has been received from the network.

virtual RTI::ObjectClassHandle makVrf::DtSimRemoteEnvironmentalNetInterface::objectClassHandle ( ) const
virtual

Returns the HLA object class handle of the reflected object.

Implements makVrf::DtSimObjectNetInterface.

static DtSimRemoteEnvironmentalNetInterface* makVrf::DtSimRemoteEnvironmentalNetInterface::isRemoteEnvironmentalNetInterface ( const DtSimObjectNetInterface objNetInterface)
static

This function will return the objNetInterface passed in, cast to a DtSimIndividualRemoteEntityNetInterface*, provided the objNetInterface is indeed an individual remote entity network interface.

static void makVrf::DtSimRemoteEnvironmentalNetInterface::reflectedObjectUpdateCallbackFunction ( DtReflectedObject obj,
void *  userData 
)
static
static DtSimObjectNetInterface* makVrf::DtSimRemoteEnvironmentalNetInterface::creator ( DtStateData simObject,
DtVrlinkNetworkInterface ,
bool  publishObject 
)
static
virtual bool makVrf::DtSimRemoteEnvironmentalNetInterface::wantsToCreatePublisher ( ) const
inlinevirtual

Returns true if this interface wants to create a publisher. This cannot be done in parallel.

Implements makVrf::DtSimObjectNetInterface.

Reimplemented in makVrf::DtGlobalEnvironmentRemoteNetInterface.

virtual void makVrf::DtSimRemoteEnvironmentalNetInterface::updateLocalGeometry ( )
protectedvirtual

put the data INTO the local state repository

Reimplemented in makVrf::DtRemoteTacticalSmokeNetInterface.

virtual void makVrf::DtSimRemoteEnvironmentalNetInterface::updateLocalBoundingGeometry ( )
protectedvirtual
virtual void makVrf::DtSimRemoteEnvironmentalNetInterface::updateLocalObjectState ( )
protectedvirtual
virtual void makVrf::DtSimRemoteEnvironmentalNetInterface::updateLocalObjectType ( )
protectedvirtual
virtual void makVrf::DtSimRemoteEnvironmentalNetInterface::updateLocalModelType ( )
protectedvirtual
virtual void makVrf::DtSimRemoteEnvironmentalNetInterface::updateUUIDIfNeeded ( )
protectedvirtual

Upon setting of reflected object see if UUID needs to be updated.

virtual DtVrfStateComponent* makVrf::DtSimRemoteEnvironmentalNetInterface::getOrCreateVrfStateComponent ( DtControlObjectRepository netState)
protectedvirtual
virtual DtStatePropertiesStateComponent* makVrf::DtSimRemoteEnvironmentalNetInterface::getOrCreateStatePropertiesStateComponent ( DtControlObjectRepository netState)
protectedvirtual
virtual void makVrf::DtSimRemoteEnvironmentalNetInterface::initializeRemoteStateComponents ( )
protectedvirtual

Member Data Documentation

DtReflectedEnvironmentProcess* makVrf::DtSimRemoteEnvironmentalNetInterface::myReflectedObject
protected

Pointer to the VR-Link Reflected Object.

bool makVrf::DtSimRemoteEnvironmentalNetInterface::myUpdateReceived
protected

Set to true by post-update callback; set to false after update has been processed.


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

Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)