spacePar.h

Go to the documentation of this file.

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


//
//File:        spacePar.h
//
//Class:       DtSpaceEntityParameters
//
//Description: This parameter class holds all of the parameters required by
//space entities (entities having a state repository class of type
//DtSpaceEntityStateRepository).  It contains a single the readable/writeable
//parameter data members specific to space entities.  In this example, we add a
//single new readable/writeable parameter, myMaxHullTemperature.

#pragma once

#include "vrfobjparam/mvObjParams.h"
#include "vrfobjparam/vrfObjParams.h"
#include "vrfobjcore/rwGndInter.h"
#include "vrfobjparam/vrfXmlUtils.h"

class DtString;
class DtReaderWriterRegistry;
class DtVector;

class DtSpaceEntityParameters : public DtMovingObjectParameters
{
public:

   //constructor with parameters to set up read/writability correctly
   DtSpaceEntityParameters(const DtString& name = DtString::nullString(), 
      DtReaderWriterRegistry* parentRegistry = NULL, DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);

   //copy constructor
   DtSpaceEntityParameters(const DtSpaceEntityParameters& orig,
      const DtString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL);

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

   //destructor
   virtual ~DtSpaceEntityParameters();

   //Returns new copy of this object
   virtual DtVrfObjectParameters* clone(
      const DtString& name = DtString::nullString(), 
      DtReaderWriterRegistry* parentRegistry = 0) const;

   //should return the type of entity this is a parameter block for.
   //Use the strings in paramTypes.h
   virtual DtString type() const;

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

   static DtVrfObjectParameters* creator(DtEnvironmentSP, DtEnvValueSP* root);

protected:

   DtRwReal myMaxHullTemperature;
};