extAggregateStateRepository.h

Go to the documentation of this file.

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

#pragma once

#include <vrfExtObjects/vrfExtObjectsDefines.h>
#include <vl/aggregateStateRepository.h>
#include <vrfExtObjects/vrfExtensions.h>
#include <vrfExtProtocol/vrfExtendedRecordData.h>

#include <vector>

class DT_DLL_vrfExtObjects DtAggregateExtendedRecordData : public DtVrfExtendedRecordData
{
public:
   DtAggregateExtendedRecordData();

   virtual ~DtAggregateExtendedRecordData();

   virtual void updateDataRecords(DtAggregateStateRepository*);

   virtual void decodeDataRecords(DtAggregateStateRepository*);

   virtual bool readFromRecord(DtVariableDatumRecord&);
};

// class DtExtAggregateStateRepository:
//
// Instances of DtExtAggregateStateRepository are

class DT_DLL_vrfExtObjects DtExtAggregateStateRepository : public DtAggregateStateRepository, public DtVrfExtensions
{

public:

   // default constructor
   DtExtAggregateStateRepository();

   // destructor
   virtual ~DtExtAggregateStateRepository();

   // copy constructor
   DtExtAggregateStateRepository(const DtExtAggregateStateRepository& orig);

   // assignment operator
   DtExtAggregateStateRepository& operator=(
      const DtExtAggregateStateRepository& orig);

   // Return a copy/empty object of the same type as this.
   virtual DtStateRepository* clone(bool copy = false) const;

   // Compares us against the supplied state repository and returns what's 
   // changed
   virtual int compare(const DtExtAggregateStateRepository* rhs);

   // Returns what has changed since the last time we called compare
   virtual int compareToMostRecent();

   // Returns true if our stashed location is different than our
   // current location
   virtual bool locationsDifferent(bool updateIfDifferent);

   virtual DtString extendedData(const DtString& key) const;

   const DtVrfExtendedRecordData& extendedRecordData() const
   {
      return myExtendedRecordData;
   }

   DtVrfExtendedRecordData& extendedRecordData()
   {
      return myExtendedRecordData;
   }

public:
   virtual void addEntity(const DtBaseEntityStateRepository*);
   virtual void removeEntity(const DtBaseEntityStateRepository*);

   virtual void addAggregate(const DtBaseEntityStateRepository*);
   virtual void removeAggregate(const DtBaseEntityStateRepository*);

   virtual void addSubordinate(const DtEntityIdentifier&);
   virtual void removeSubordinate(const DtEntityIdentifier&);

   virtual void setExtendedData(const std::map<DtString, DtString>& ed);
   virtual void setExtendedData(const DtString& key, const DtString& value);

public:
   virtual int numVrfVariableDatumRecords() const;

   virtual bool getUserVariableDatum(int userRecordNumber,
                                      DtVariableDatumRecord& rec);

   virtual bool setUserVariableDatum(int userRecordNumber,
      const DtVariableDatumRecord& record);

   virtual void updateDataRecords();

public:
   // Appearance as read from network or set by user
   int appearance() const;
   void setAppearance(int);

   // Gets/sets the list of subordinates in subordinate order
   const std::vector<DtEntityIdentifier>& orderedSubordinates() const;
   virtual void setOrderedSubordinates(const std::vector<DtEntityIdentifier>&);

   // The name of the current formation of the aggregate.
   virtual DtString formationName() const;
   virtual void setFormationName(const DtString& formationName);

public:
   virtual void updateExtensions();

public:
   
   static DtExtAggregateStateRepository* create();

protected:
   virtual void extensionModified();

protected:
   DtExtAggregateStateRepository* myLastCopy;
   DtAggregateExtendedRecordData myExtendedRecordData;

   int   myAppearance;
   std::vector<DtEntityIdentifier> myOrderedSubordinates;

   char* mySubordinateBuffer;
   int myBitLength;
   bool myRecordModified;
   DtString myFormationName;
};

inline int DtExtAggregateStateRepository::appearance() const
{
   return myAppearance;
}

inline void DtExtAggregateStateRepository::setAppearance(int i)
{
   if (i != myAppearance)
   {
      myRecordModified = true;
      myAppearance = i;
   }
}

inline const std::vector<DtEntityIdentifier>& DtExtAggregateStateRepository::orderedSubordinates() const
{
   return myOrderedSubordinates;
}