include/vrfExtObjects/vrfExtAppInit.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2005 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: vrfExtAppInit.h,v $ $Revision: 1.4 $ $State: Exp $
*******************************************************************************/

#ifndef VRFEXTAPPOPTIONS_H_
#define VRFEXTAPPOPTIONS_H_

#include <vlutil/vlMachineTypes.h>
#include <vl/exConnInit.h>
#include <mtl/mtl.h>
#include <vector>

// class DtVrfExtApplicationInitializer:
//
// Instances of DtVrfExtApplicationInitializer are

#include <vrfExtObjects/vrfExtObjectsDefines.h>
class DT_DLL_vrfExtObjects DtVrfExtApplicationInitializer : public DtVrlApplicationInitializer
{

public:

   // Default constructor
   DtVrfExtApplicationInitializer(int argc, char** argv,const char* appName, const char* appVersion);

   // Destructor
   virtual ~DtVrfExtApplicationInitializer();

   virtual void initializeMtlParams();

   // Returns mtl environment variable to be able to add new mtl environment items to
   DtMtlEnvironment* mtlEnvironment();

public:
   // Returns true if a custom DtMapDatum has been specified
   virtual bool useCustomMapDatum() const;
   // Returns the spheroid semiMajor axis for a custom DtMapDatum
   virtual DtFloat64 spheroidSemiMajor() const;
   // Returns the spheroid semiMinor axis for a custom DtMapDatum
   virtual DtFloat64 spheroidSemiMinor() const;
   // Returns the x datumShift for a custom DtMapDatum
   virtual DtFloat64 datumShiftX() const;
   // Returns the y datumShift for a custom DtMapDatum
   virtual DtFloat64 datumShiftY() const;
   // Returns the z datumShift for a custom DtMapDatum
   virtual DtFloat64 datumShiftZ() const;

   virtual void setMaxDrainInputTime(double maxTime);
   virtual double maxDrainInputTime() const;

   virtual void setMinDrainInputTime(double minTime);
   virtual double minDrainInputTime() const;

   virtual void setMaxDrainInputReads(int reads);
   virtual int maxDrainInputReads() const;

#if DtDIS
   virtual std::vector<DtString>& multicastAddresses();

   virtual void setDefaultHeartbeatThreshold(double);
   virtual double defaultHeartbeatThreshold(void) const;

   virtual void setDefaultObjectTimeout(double);
   virtual double defaultObjectTimeout() const;

   // Returns lower/upper range of DIS app id for VRF published objects.  Default is 3000-4000
   virtual void appIdRange(int& lower, int& upper);
   virtual void setAppIdRange(int lower, int upper);

#endif

#ifdef DtHLA
   virtual void setApplicationNumber(int);
   virtual int applicationNumber() const;
   virtual void setSiteId(int);
   virtual int siteId() const;
#endif

#ifdef DtDIS
   static void addMulticastAddr(const DtString& s);
   static DtlObjPtr addMulticastAddr(const DtlObjPtr& args, const DtlObjPtr&);
#endif

private:

   // Copy constructor -- not implemented
   DtVrfExtApplicationInitializer(const DtVrfExtApplicationInitializer& orig);

   // Assignment operator -- not implemented
   DtVrfExtApplicationInitializer& operator=(const DtVrfExtApplicationInitializer& rhs);

protected:
   // Used only when reading from MTL files, then stashed into
   // command line variables

#if DtDIS
   // Range to use for lower/upper bound of dis app id range which will
   // tell what range is used to identify a VRF generated object
   DtConfigVariable<DtString>  myAppIdRange;

   static std::vector<DtString>& mtlMcastAddrList();
   static std::vector<DtString> theMtlMcastAddrList;
#endif

#if DtHLA
   // This is already in the DIS base-class... For the PVD,
   // make one for HLA
   DtConfigVariable<int> myApplicationNumber;
   DtConfigVariable<int> mySiteId;
#endif
   // DtMapDatum Variables
   short       myUseCustomMapDatum;
   DtFloat64   mySpheroidSemiMajor;
   DtFloat64   mySpheroidSemiMinor;
   DtFloat64   myDatumShiftX;
   DtFloat64   myDatumShiftY;
   DtFloat64   myDatumShiftZ;

   double   myMaxDrainInputTime;

   // HLA only
   double   myMinDrainInputTime;

   // DIS only
   int         myMaxDrainInputReads;
   double      myDefaultHeartbeatThreshold;
   double      myDefaultObjectTimeout;
};

inline DtMtlEnvironment* DtVrfExtApplicationInitializer::mtlEnvironment()
{
   return myMtlEnv;
}

#endif