rwSensorContactInfo.h

Go to the documentation of this file.

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


#pragma once

#include <readerWriter/readerWriter.h>
#include <readerWriter/rwReal.h>
#include <readerWriter/rwList.h>
#include <readerWriter/rwString.h>
#include "readerWriter/rwVector.h"
#include <readerWriter/rwInt.h>
#include "vrfutil/nLengthIntegerVector.h"
#include <vlutil/vlTime.h>
#include "vrfutil/rwFormationType.h"
#include "vrfutil/rwUUID.h"
#include "vrfutil/rwTaitBryan.h"
#include <readerWriter/rwObjectType.h>
#include "vrfutil/rwForceType.h"
#include "vrfutil/rwAppearance.h"
#include <readerWriter/rwBoolean.h>
#include <vl/hostStructs.h>
#include "vrfutil/vrfutilDefines.h"

class DtReaderWriterRegistry;

enum DtCIDLevelType
{
   LEVEL_N0_DETECTION = 0,
   LEVEL_DETECTED,
   LEVEL_CLASSIFIED,
   LEVEL_IDENTIFIED,
   LEVEL_FULL_KNOWLEDGE
};


typedef enum
{
   DtSensorTypeUnknown = 0,
   DtSensorTypeVisual =  1,
   DtSensorTypeRadar =   2,
   DtSensorTypeSonar =   3,
   DtSensorTypeInfrared = 4,
   DtSensorTypePassiveSonar = 5,
   DtSensorTypeActiveSonar = 6,
   DtSensorTypeSpotReport = 7,
   DtSensorTypeMAD = 8, 
   DtSensorTypeEmissions = 9, 
   DtSensorTypeBeaconRadar = 10, 
   DtSensorTypeSearchRescue = 11, 
} DtSensorTypeEnum;

class DT_DLL_vrfutil DtRwSensorContactInfo : public DtReaderWriter
{
public:
   DtRwSensorContactInfo();
   
   DtRwSensorContactInfo(const DtString& name,
      DtReaderWriterRegistry* const parentRegistry = NULL);
   DtRwSensorContactInfo(const DtSymbolString& name,
      DtReaderWriterRegistry* const parentRegistry = NULL);

   DtRwSensorContactInfo(const DtRwSensorContactInfo& orig,
      DtReaderWriterRegistry* const parentRegistry = NULL);

   virtual ~DtRwSensorContactInfo();

   DtRwSensorContactInfo& operator=(const DtRwSensorContactInfo& orig);


   virtual const DtEntityIdentifier& id() const { return myId; };
   virtual void setId(const DtEntityIdentifier& id) { myId = id; };

   virtual void fixDetectionTimesFromDateAndTime(double currentSimTime,
      double currentDateAndTime);


   virtual double originalDetectionTime() const { return myOriginalTimeOfDetection; };
   virtual void setOriginalDetectionTime(DtReal origTime);


   virtual double originalDetectionDateAndTime() const { return myOriginalDateAndTimeOfDetection; };
   virtual void setOriginalDetectionDateAndTime(DtReal origTime) { myOriginalDateAndTimeOfDetection = origTime; };


   virtual void setLastTimeOfDetection(double time);
   virtual double lastDetectionTime() const { return myLastTimeOfDetection; };


   virtual void setLastDateAndTimeOfDetection(double time) { myLastDateAndTimeOfDetection = time; };
   virtual double lastDetectionDateAndTime() const { return myLastDateAndTimeOfDetection; };


   virtual const DtUUID& spotter() const { return mySpotter; };
   virtual void setSpotter(const DtUUID& name) { mySpotter = name; };

   virtual void setSpotterMarkingText(const DtString& s) { mySpotterMarkingText = s; };
   virtual const DtString& spotterMarkingText() const { return mySpotterMarkingText; };


   virtual const DtUUID& contact() const { return myContact; };

   virtual void setContact(const DtUUID& name) { myContact = name; };

   virtual void setContactMarkingText(const DtString& s) { myContactMarkingText = s; };
   virtual const DtString& contactMarkingText() const { return myContactMarkingText; };


   virtual int combatIdentificationLevel() const {return myCombatIdentificationLevel; };
   virtual void setCombatIdentificationLevel(int level) { myCombatIdentificationLevel = level; };


   virtual double detectionError() const {return myDetectionError; };
   virtual void setDetectionError(double level) { myDetectionError = level; };
   

   virtual void setContactIsCurrentlyDetected(bool);
   virtual bool isContactCurrentlyDetected() const;


   virtual void setContactPosition(const DtVector& vector);
   virtual DtVector contactPosition() const;


   virtual void setContactOrientation( const DtTaitBryan& orientation );
   virtual DtTaitBryan contactOrientation() const;
   

   virtual void setContactVelocity( const DtVector& velocity );
   virtual DtVector contactVelocity() const;


   virtual void setContactType(const DtObjectType& type);
   virtual DtObjectType contactType() const;


   virtual void setContactForce(const DtForceType& force);
   virtual DtForceType contactForce() const;


   virtual void setContactFormation(const DtAggregateFormation formation);
   virtual DtAggregateFormation contactFormation() const;
   virtual DtString contactFormationString() const;



   virtual void setContactActivity(const DtString& activity);
   virtual const DtString& contactActivity() const;


   virtual void setContactAppearance(const DtAppearance & app);
   virtual const DtAppearance& contactAppearance() const;
   virtual DtAppearance& contactAppearance() ;


   virtual void setContactRadius(DtReal radius);
   virtual DtReal contactRadius() const;


   virtual void setHealthPercentage(DtReal);
   virtual DtReal healthPercentage() const;


   virtual void setIsBreached(bool);
   virtual bool isBreached() const;


   virtual void setContactExpirationTime(DtReal contactExpirationTime);
   virtual DtReal contactExpirationTime() const;

   virtual const DtNLengthIntegerVector& contactSources() const; 
   virtual void setContactSources(const DtNLengthIntegerVector& sources);

   virtual bool addContactSource(int source);

   virtual bool addContactSources(const DtNLengthIntegerVector& sources);


   virtual void removeContactSource(int source);


   virtual int findContactSource( int source);

   virtual DtRwSensorContactInfo* clone() const;

   bool operator==(const DtRwSensorContactInfo&) const;

protected:
   DtRwUUID                myContact;
   DtRwString              myContactMarkingText;
   DtRwUUID                mySpotter;
   DtRwString              mySpotterMarkingText;
   DtEntityIdentifier      myId;
   DtRwReal                myOriginalTimeOfDetection;
   DtRwReal                myOriginalDateAndTimeOfDetection;
   DtRwReal                myLastTimeOfDetection;
   DtRwReal                myLastDateAndTimeOfDetection;
   DtRwInt                 myCombatIdentificationLevel;
   DtRwReal                myDetectionError; 
   DtRwVector              myContactPosition;
   DtRwTaitBryan           myContactOrientation;
   DtRwVector              myContactVelocity;
   DtRwObjectType          myContactType;
   DtRwForceType           myContactForce;
   DtNLengthIntegerVector  myContactSourceTypes;
   DtRwFormationType       myContactFormation;
   DtRwString              myContactActivity;   
   DtRwAppearance          myContactAppearance;
   DtRwReal                myContactRadius; 

   DtRwReal                myHealthPercentage;

   DtRwBoolean             myIsBreached;

   DtRwReal                myContactExpirationTime;
   
   DtRwBoolean             myIsContactCurrentlyDetected;   
};

DT_DLL_vrfutil bool mergeContactInfo(DtRwSensorContactInfo & info, const DtRwSensorContactInfo & sourceInfo);

namespace DtBufferSerialize
{
   DT_DLL_vrfutil int getSize(const DtRwSensorContactInfo& data);

   DT_DLL_vrfutil char *encode(const DtRwSensorContactInfo& data, char *buffer);

   DT_DLL_vrfutil const char *decode(DtRwSensorContactInfo &data, const char *buffer) ;
}