vrfAggregateStateRepository.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjcore/vrfMovingObjectStateRepository.h"
#include "vrfutil/rwFormationType.h"
#include "vrfutil/rwAggregateState.h"
#include "geometry/extent.h"
#include <vlpi/disEnums.h>

class DtFormation;
class DtFormationState;
class DtAggregateObjectParameters;

#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtVrfAggregateStateRepository : public DtVrfMovingObjectStateRepository
{
protected:
   DtVrfAggregateStateRepository();

public:

   DtVrfAggregateStateRepository (DtVrfObject* vrfObject, 
      const DtObjectType& objectType, DtVrfObjectParameters* parameters,
      const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0);

   DtVrfAggregateStateRepository (const DtVrfAggregateStateRepository& orig, 
      const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0);

   const DtVrfAggregateStateRepository & operator= (
      const DtVrfAggregateStateRepository & orig);

   virtual ~DtVrfAggregateStateRepository();

   virtual DtSimObjectStateRepository* clone(
      const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry*  parentRegistry = 0) const;

   virtual bool init();

   virtual void initStatePropertiesNotToBeRestored();

   virtual DtString type() const;

   virtual DtFormationState* formationState() const;

   virtual void setFormation(DtAggregateFormation formation);
   virtual DtAggregateFormation formation() const;


   virtual void setFormationName(const DtString& name);
   virtual DtString formationName() const;

   virtual std::list<DtString> allowableFormationNames() const;


   virtual void setAggregateState(enum DtAggregateState state);
   virtual enum DtAggregateState aggregateState() const;

   virtual bool formationNameSpecified() const;

   virtual double formationHalfLength();

   virtual double totalMass() const;

   virtual double numberSubordinateVehicles(void) const;
   virtual void setNumberSubordinateVehicles(const double nVehicles);

   virtual const int vrfMovingObjectStateRepositorySubType() const;

   virtual const int aggregateStateRepositorySubType() const;

   virtual void setBlockSetFormationChange(bool);
   virtual bool blockSetFormationChange() const;

   virtual void getSelf(DtlObjPtr args, 
      const DtReaderWriter::SearchPaths& searchPaths, 
      const DtVariableBindingsList& variableBindings);

   static DtVrfObjectStateRepository* creator (const DtString& name,
      DtVrfObject* vrfObject,const DtObjectType& objectType,
      DtVrfObjectParameters* parameters, 
      DtReaderWriterRegistry* parentRegistry);

   static DtVrfAggregateStateRepository* isVrfAggregateStateRepository(
      DtSimObjectStateRepository* repository);

   static const DtVrfAggregateStateRepository* isVrfAggregateStateRepository(
      const DtSimObjectStateRepository* repository);

   virtual bool aggregatedExtent(DtExtent& extent);

   virtual bool computeExtentFromParameters(const DtString& formationName, DtExtent& extent);

   virtual void setParameterEntry(DtVrfObjectParameters* parameterEntry);

protected:

   virtual void createFormationState(); 

   virtual bool computeExtent(const DtAggregateObjectParameters& parameterEntry, 
      const DtString& formationName, DtExtent& extent);

   virtual std::list<DtVector> generateFormationPositions(
      const DtVrfObjectParameters& parameterEntry, DtFormation& formation);

   virtual bool getFormation(const DtString& formationName,
      const DtAggregateObjectParameters& parameterEntry,
      DtFormation& formation);

   virtual void preGetSelf();
   virtual void postGetSelf();

protected:

   DtRwFormationType myFormation;
   DtRwString myFormationName;
   DtFormationState* myFormationState;
   DtRwAggregateState myAggregateState;

   DtExtent myCachedExtent;
   bool myCachedExtentIsValid;

   double myNumberOfSubordinateVehicles;

   DtRwBoolean myBlockSetFormationChange;
};