timeKeeperCmpt.h

Go to the documentation of this file.

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

//
//class DtTimeKeeperComponent
//
//This is a component which simply keeps track of the elapsed simulation time
//since the component was created.  It illustrates the creation and use of
//a process state repository to save the simulation time since creation
//into a checkpointed scenario file, and read it back in at load time.
//
#pragma once

#include "vrfobjcore/simComponent.h"

class DtTimeKeeperPSR;
class DtTimeKeeperDescriptor;

//String which uniquely identifies this controller
const char TimeKeeperComponentType[] = "time-keeper-component";

class DtTimeKeeperComponent : public DtSimComponent
{
public:
   //constructor
   DtTimeKeeperComponent(const DtString & name, DtLocalObject* owner, 
      DtSimulationServices * simManager, DtComponentDescriptor* desc = NULL,
      DtReaderWriterRegistry * parentRegistry = 0);

   //destructor
   virtual ~DtTimeKeeperComponent() override;

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

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

   //Returns the string type for this component.
   virtual const char* type() const override;

   //Overridden from the base class to call createPSR().
   virtual bool init() override;

   //Create a time-keeper process state repository, or a different 
   //type if it is specified in the OPD.
   virtual bool createPSR();

   //Update control values
   //For this controller, we simply add dT() to our elapsed time 
   //state variable, and print out the value every 10 seconds of 
   //simulation time.
   virtual void tick() override;

   //This is called by the factory
   static DtSimComponent* creator(const DtString & name, DtLocalObject* owner,
      DtSimulationServices * simManager, DtComponentDescriptor* desc,
      DtReaderWriterRegistry * parentRegistry);

protected:
   //This is the pointer to the custom descriptor
   DtTimeKeeperDescriptor * myDescriptor;

   //This is the pointer to our process state repository used during
   //the execution of the simulation.
   DtTimeKeeperPSR* myProcessState;
};