rwScenarioEvent.h

Go to the documentation of this file.

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


#pragma once

#include "vrfutil/vrfutilDefines.h"
#include "vrfutil/readerWriter.h"
#include "vrfutil/rwReal.h"
#include "vrfutil/rwString.h"
#include "vrfutil/rwBoolean.h"
#include "vrfutil/rwVector.h"
#include "vrfutil/rwInt.h"
#include "vrfutil/nLengthIntegerVector.h"
#include "vrfutil/rwUUID.h"

const int DtSEPredecessorType_Active = 1;
const int DtSEPredecessorType_Concluded = 2;

const int DtSETriggerStatus_None = 0;
const int DtSETriggerStatus_Pending = 1;
const int DtSETriggerStatus_Suspended = 2;
const int DtSETriggerStatus_InProcess = 3;
const int DtSETriggerStatus_Concluded = 4;

const int DtSEStartTimeType_Start = 0;
const int DtSEStartTimeType_Manual = 1;
const int DtSEStartTimeType_Link = 2;
const int DtSEStartTimeType_SPLUS = 3;
const int DtSEStartTimeType_Immediate = 4;
const int DtSEStartTimeType_IntelligenceObject = 100;

const int DtSEEndTimeType_Manual = 0;
const int DtSEEndTimeType_TOD = 1;
const int DtSEEndTimeType_SPLUS = 2;
const int DtSEEndTimeType_Never = 3;
const double DtScenarioEventVersion = 2.0;

class DT_DLL_vrfutil DtRwScenarioEventUUID : public DtRwUUID
{
public:
   DtRwScenarioEventUUID();
   DtRwScenarioEventUUID(const DtString& name, DtReaderWriterRegistry* const parentRegistry);
   DtRwScenarioEventUUID(const DtSymbolString& name, DtReaderWriterRegistry* const parentRegistry);

   DtRwScenarioEventUUID& operator=(const DtUUID&);
   DtRwScenarioEventUUID& operator=(const DtRwScenarioEventUUID&);

protected:
   virtual DtlObjPtr getData(DtlObjPtr args, const SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings);
   virtual void getData(const DtEnvironmentSP, const DtEnvValueSP,
      const SearchPaths& searchPaths = SearchPaths(), 
      const DtVariableBindingsList& bindings = DtVariableBindingsList());
};

class DT_DLL_vrfutil DtRwScenarioEvent : public DtReaderWriter
{
public:

   DtRwScenarioEvent(const DtString& name, 
      DtReaderWriterRegistry* parentRegistry = 0);

   DtRwScenarioEvent(const DtRwScenarioEvent & orig, 
      DtReaderWriterRegistry * parentRegistry = 0);

   DtRwScenarioEvent & operator=(const DtRwScenarioEvent & orig);

   virtual ~DtRwScenarioEvent();

   virtual const char* readerWriterType() const;
   static const char* theXmlType();

   virtual const char* xmlType() const
   {
      return theXmlType();
   }

public:
   virtual const DtString& caption() const;
   virtual void setCaption( const DtString& input );

   virtual int endTimeType() const;
   virtual void setEndTimeType( int input );

   virtual double endTimeValue() const;
   virtual void setEndTimeValue( double tValue );

   virtual double simTimeEnded() const;
   virtual void setSimTimeEnded( double tValue );

   virtual const DtNLengthIntegerVector& forces() const;
   virtual void addForce( int input );
   virtual void removeForce (int);
   virtual void setForces(const DtNLengthIntegerVector&);
   virtual bool isAvailableToForce(int) const;
   virtual bool isAvailableToForce(const std::vector<int>&) const;
   virtual void clearForces();

   virtual const unsigned int forcePermissionMask() const;
   virtual void setForcePermissionMask( int input );

   virtual const DtVector& location() const;
   virtual void setLocation( const DtVector& input );

   virtual bool isLocationSet() const;
   virtual void setLocationIsSet(bool isSet);

   virtual const DtString& symbolFile() const;
   virtual void setSymbolFile( const DtString& input);

   virtual const DtString& mediaText() const;
   virtual void setMediaText( const DtString& input);

   virtual const DtString& mediaSound() const;
   virtual void setMediaSound( const DtString& input);

   virtual const DtString& mediaVideo() const;
   virtual void setMediaVideo( const DtString& input);

   virtual const DtString& mediaPicture() const;
   virtual void setMediaPicture( const DtString& input);

   virtual const DtString& multipleChoiceQuiz() const;
   virtual void setMultipleChoiceQuiz( const DtString& input );

   virtual int ordinal() const;
   virtual void setOrdinal(int nOrd);

   virtual void addToPredecessorList( const DtUUID& pUniqueID,  
      int predType = DtSEPredecessorType_Concluded);

   struct PredecessorItem
   {
      DtRwScenarioEventUUID uniqueId;
      int predecessorType;
   };

   typedef std::vector<PredecessorItem> PredecessorList;

   virtual PredecessorList predecessorList() const;
   virtual void setPredecessorList(const PredecessorList&);

   virtual void clearPredecessorList();

   virtual void removeFromPredecessorList( const DtUUID& pUniqueID );

   virtual bool resolved() const;
   virtual void setResolved( bool input );

   virtual int startTimeType() const;
   virtual void setStartTimeType( int input );
   virtual DtString startTimeString() const;

   virtual double startTimeValue() const;
   virtual void setStartTimeValue( double tValue );

   virtual bool isQuickLaunch() const;
   virtual void setIsQuickLaunch( bool );

   virtual double simTimeStarted() const;
   virtual void setSimTimeStarted( double tValue );

   virtual int triggerStatus() const;
   virtual void setTriggerStatus( int input );

   virtual const DtUUID& uniqueId() const;
   virtual void setUniqueId( const DtUUID& input );

   virtual double version() const;
   virtual void setVersion( double input );

   virtual double predecessorDeltaValue() const;
   virtual void setPredecessorDeltaValue( double delta );

   virtual void addSensorSignature(const DtString&, double val);
   virtual void removeSensorSignature(const DtString&);
   virtual void setSensorSignatures(const std::map<std::string, double>&);
   virtual std::map<std::string, double> sensorSignatures() const;

private:
   DtRwScenarioEvent();

protected:

   DtRwString myCaption;
   DtRwInt myEndTimeType;
   DtRwReal myEndTime;
   DtRwInt myStartTimeType;
   DtRwReal myStartTime;
   DtNLengthIntegerVector myForces;
   DtRwInt myForcePermissionMask;
   DtRwVector myLocation;
   DtRwBoolean myUseLocation;
   DtRwString mySymbolFile;
   DtRwString myMediaText;
   DtRwString myMediaVideo;
   DtRwString myMediaSound;
   DtRwString myMediaPicture;
   DtRwString myMultipleChoiceQuiz;
   DtRwInt myOrdinal;
   DtRwString myPredecessorList;
   DtRwBoolean myResolved;
   DtRwInt myTriggerStatus;
   DtRwScenarioEventUUID myUniqueId;
   DtRwInt myVersion;
   DtRwReal myPredecessorDeltaValue;
   DtRwReal mySimTimeStarted;
   DtRwReal mySimTimeEnded;
   DtRwBoolean myIsQuickLaunch;

   DtRwString mySensorSignatures;
};