spaceSR.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: spaceSR.h,v $ $Revision: 1.12 $ $State: Exp $
*******************************************************************************/


//
//File:        spaceSR.h
//
//Class:       DtSpaceEntityStateRepository
//
//Description: This repository holds all information that is common to all the
//forms of space entities within the system.  It contains a pointer
//to the space entity parameters, and provides accessors and mutators
//for all parameter values.  In this example, we add a single new parameter,
//myMaxHullTemperature, representing the maximum outer hull temperature that
//this entity can sustain (e.g. such as during reentry).  Any future 
//controller and actuator components we build to simulate the entity's 
//behavior can view or set this new parameter as necessary.
//


#ifndef DtSpaceEntityStateRepository_H_
#define DtSpaceEntityStateRepository_H_


#include <vlutil/vlMachineTypes.h>
#include "vrfobjcore/vrfObject.h"
#include "vrfobjcore/groundInter.h"
#include "vrfobjcore/vrfMvObjSR.h"
#include "vrfobjcore/vrfObjSR.h"

class DtSpaceEntityParameters;
class DtVector;

class DtSpaceEntityStateRepository : public DtVrfMovingObjectStateRepository
{

public:

   //Constructor with parameters to set up read/writability correctly.
   DtSpaceEntityStateRepository(DtVrfObject* vrfObject, 
      const DtObjectType& objectType, DtVrfObjectParameters* parameters, 
      const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);

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

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

   //destructor
   virtual ~DtSpaceEntityStateRepository();

   virtual bool init();

   //Returns a unique string identifying the type of component, 
   //DtSpaceVehicleSRType (defined in spacetypes.h).  Used a key in 
   //the state repository factory.
   virtual DtString type() const;

   //Override to create an instance DtSpaceEntityParameters and
   //set it in myParameters data member.
   virtual bool createParameters();

   //Override to initialize space entity specific parameters from
   //our parameters object.
   virtual void initializeFromParameters();

   //Implemented for convenience.  Since we overrode createParameters()
   //to create a DtSpaceEntityParameters object (a derived kind of 
   //DtSimObjectParameters), we provide an accessor casting it to the
   //dervied type.
   virtual const DtSpaceEntityParameters * spaceEntityParameters() const;

   //Accessor/mutator for our new parameter, myMaxHullTemperature.
   //Set/get maximum hull temperature this entity can sustain (degrees C).
   virtual void setMaxHullTemperature(DtReal temp);
   virtual DtReal maxHullTemperature() const;

   //Returns a newly created instance of this class.  To be registered
   //with the state repository factory.
   static DtVrfObjectStateRepository * creator(const DtString& name, 
      DtVrfObject* vrfObject,const DtObjectType& objectType, 
      DtVrfObjectParameters* parameters, DtReaderWriterRegistry* parentRegistry);

   //Returns a the pointer the repository, if the repository passed
   //in is of type DtSpaceEntityStateRepository, 0 if not.  Implmementation
   //is optional - may be useful for safe type checking.
   static DtSpaceEntityStateRepository* isSpaceEntityStateRepository(
      const DtVrfObjectStateRepository* repository);

protected:

   //Maximum hull temperature (in degrees Celsius).
   DtRwReal myMaxHullTemperature;
};

#endif