Simulator interface. More...

Inheritance diagram for SimPT_Sim::SimInterface:

Collaboration diagram for SimPT_Sim::SimInterface:

Public Member Functions
virtual	~SimInterface ()
	Virtual destructor.

virtual CoreData &	GetCoreData ()=0
	Access to CoreData.

virtual const boost::property_tree::ptree &	GetParameters () const =0
	Provide reference to the parameters.

virtual std::string	GetProjectName () const =0
	Return name that identifies this project.

virtual std::string	GetRunDate () const =0
	Return start time/date of the current simulation run.

virtual int	GetSimStep () const =0
	Get number of simulation steps taken in this simulation history.

virtual Timings	GetTimings () const =0
	Execution timings in duration units specified in milliseconds.

virtual bool	IsAtTermination () const =0
	Query whether simulation has met termination condition.

virtual bool	IsStationary () const =0
	Returns true if the simulation is in a stationary state.

virtual void	Reinitialize (const boost::property_tree::ptree &parameters)=0
	Reinitialize with parameters; executed any time the parameters change.

virtual void	TimeStep ()=0
	Let simulator take a time step.

Public Member Functions inherited from SimPT_Sim::ClockMan::Timeable<>
virtual	~Timeable ()
	Destructor virtual for polymorphic class.

Additional Inherited Members
Public Types inherited from SimPT_Sim::ClockMan::Timeable<>
using	Timings = typename ClockTraits< std::chrono::system_clock, typename std::chrono::system_clock::duration >::CumulativeTimings

Public Types inherited from SimPT_Sim::ClockMan::ClockTraits< std::chrono::system_clock, typename std::chrono::system_clock::duration >
using	Clock = std::chrono::system_clock
	Type for clock.

using	CumulativeTimings = SimPT_Sim::ClockMan::CumulativeRecords< typename std::chrono::system_clock::duration >
	Records with cumulative timing info.

using	Duration = typename std::chrono::system_clock::duration
	Type for time duration units.

using	IndividualTimings = SimPT_Sim::ClockMan::IndividualRecords< typename std::chrono::system_clock::duration >
	Records with individual timing info.

using	Stopclock = SimPT_Sim::ClockMan::Stopwatch< std::chrono::system_clock >
	Stopwatch to measure time durations.

Detailed Description

Simulator interface.

Definition at line 36 of file SimInterface.h.

The documentation for this class was generated from the following file:

Public Member Functions