vlFedTarget.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
*********************************************************************/
#pragma once

#include "vlMachineTypes.h"
#include <vlutil/vlString.h>
#include <map>
#include <vector>

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

enum DtFomType
{
   DtFomInvalid = 0,
   DtFom13 = 1,
   DtFom1516 = 2,
   DtFom1516E = 3
};

enum DtTransportType
{
   DtBest_Effort,
   DtReliable
};

enum DtOrderType
{
   DtReceive,
   DtTimestamp
};

enum DtResignAction
{
   DtUnconditionallyDivestAttributes = 1,
   DtDeleteObjects,
   DtDeleteObjectsThanDivest,
   DtNoAction,
   DtCancelPendingOwnershipAcquitions,
   DtCancelThenDeleteThenDivest
};

typedef std::map<unsigned long, DtString> DtUpdateRateNameByHandleMap;
typedef std::map<DtString, unsigned long> DtUpdateRateHandleByNameMap;


class DT_DLL_VLUTIL DtFedTarget
{
public:

   DtFedTarget();

   virtual ~DtFedTarget();

   DtFedTarget(const DtFedTarget& orig);

   DtFedTarget& operator=(const DtFedTarget& orig);

   virtual void setFomType(DtFomType type);
   virtual DtFomType fomType();

   virtual void addSpace(const char* name) = 0;

   virtual void addDimension(const char* SpaceName, const char* dimName) = 0;

   virtual void addDimension(const char* dimName, unsigned long upperBound,
      unsigned long defaultLowerBound, unsigned long defaultUpperBound,
      bool excluded) = 0;

   virtual void addInterClass(const char* name, 
      const char* baseName, DtTransportType transport, 
      DtOrderType order, const char* space=0) = 0;

   virtual void addParameter(const char* className, 
      const char* paramName) = 0;

   virtual bool addInteractionDimension(const char* interactionName,
      const char* dimension) = 0;

   virtual void addObjClass(const char* name, 
      const char* baseName) = 0;

   virtual void addAttribute(const char* className, 
      const char* attributeName, DtTransportType transport, 
      DtOrderType order, const char* space=0) = 0;

   virtual bool addAttributeDimension(const char* className,
      const char* attrName, const char* dimName) = 0;


   //-------------------------------------------------------------------------
   //-------------------------------------------------------------------------

   virtual bool autoProvide() const;
   virtual void setAutoProvide(bool value);

   virtual bool conveyRegionDesignatorSets() const;
   virtual void setConveyRegionDesignatorSets(bool value);

   virtual bool conveyProducingFederate() const;
   virtual void setConveyProducingFederate(bool value);

   virtual bool attributeScopeAdvisory() const;
   virtual void setAttributeScopeAdvisory(bool value);

   virtual bool attributeRelevanceAdvisory() const;
   virtual void setAttributeRelevanceAdvisory(bool value);

   virtual bool objectClassRelevanceAdvisory() const;
   virtual void setObjectClassRelevanceAdvisory(bool value);

   virtual bool interactionRelevanceAdvisory() const;
   virtual void setInteractionRelevanceAdvisory(bool value);

   virtual bool serviceReporting() const;
   virtual void setServiceReporting(bool value);

   virtual bool exceptionReporting() const;
   virtual void setExceptionReporting(bool value);

   virtual bool delaySubscriptionEvaluation() const;
   virtual void setDelaySubscriptionEvaluation(bool value);

   virtual DtResignAction automaticResignAction() const;
   virtual void setAutomaticResignAction(DtResignAction value);

   virtual bool knownUpdateRate( const DtString updateRateName ) const;

   virtual void addUpdateRate( const DtString updateRateName, float rate );

   DtString updateRateNameByHandle( unsigned long handle );

public:

   static void setDefaultAutoProvide(bool onOff);
   static bool defaultAutoProvide();

   static void setDefaultConveyRegionDesignatorSets(bool onOff);
   static bool defaultConveyRegionDesignatorSets();

   static void setDefaultConveyProducingFederate(bool onOff);
   static bool defaultConveyProducingFederate();

   static void setDefaultObjectClassRelevanceAdvisory(bool onOff);
   static bool defaultObjectClassRelevanceAdvisory();

   static void setDefaultAttributeRelevanceAdvisory(bool onOff);
   static bool defaultAttributeRelevanceAdvisory();

   static void setDefaultAttributeScopeAdvisory(bool onOff);
   static bool defaultAttributeScopeAdvisory();

   static void setDefaultInteractionRelevanceAdvisory(bool onOff);
   static bool defaultInteractionRelevanceAdvisory();

   static void setDefaultServiceReporting(bool onOff);
   static bool defaultServiceReporting();

   static void setDefaultExceptionReporting(bool onOff);
   static bool defaultExceptionReporting();

   static void setDefaultAutomaticResignAction( DtResignAction val );
   static DtResignAction defaultAutomaticResignAction();

protected:

   bool myAutoProvide;
   bool myConveyRegionDesignatorSets;
   bool myConveyProducingFederate;
   bool myAttributeScopeAdvisory;
   bool myAttributeRelevanceAdvisory;
   bool myObjectClassRelevanceAdvisory;
   bool myInteractionRelevanceAdvisory;
   bool myServiceReporting;
   bool myExceptionReporting;
   bool myDelaySubscriptionEvaluation;
   DtResignAction myAutomaticResignAction;

   DtFomType myFomType;

   std::vector<float> myUpdateRates;

   DtUpdateRateHandleByNameMap myUpdateRateHandleByName;

   DtUpdateRateNameByHandleMap myUpdateRateNameByHandle;

protected:

   static bool theDefaultAutoProvide;
   static bool theDefaultConveyRegionDesignatorSets;
   static bool theDefaultConveyProducingFederate;
   static bool theDefaultObjectClassRelevanceAdvisory;
   static bool theDefaultAttributeRelevanceAdvisory;
   static bool theDefaultAttributeScopeAdvisory;
   static bool theDefaultInteractionRelevanceAdvisory;
   static bool theDefaultServiceReporting;
   static bool theDefaultExceptionReporting;
   static DtResignAction theDefaultAutomaticResignAction;
};

#ifdef DtUSE_UTILITIES_NAMESPACE
} 
#endif