Gadget
Public Member Functions | Protected Attributes | List of all members
RunID Class Reference

This is the class used to store information about the machine used for, and the time of, the model run. More...

#include <runid.h>

Collaboration diagram for RunID:
Collaboration graph

Public Member Functions

 RunID ()
 This is the default RunID constructor. More...
 
 ~RunID ()
 This is the default RunID destructor. More...
 
void Print (ostream &o)
 This will print the model run information for the current model. More...
 
void printTime (ostream &o)
 This will print information about the run time for the current model. More...
 

Protected Attributes

char * hostname
 This is the name of the host machine that is running the current model. More...
 
char * timestring
 This is the time stamp used to denote the time that the current model run started. More...
 
time_t runtime
 This is the host machine that is running the current model. More...
 

Detailed Description

This is the class used to store information about the machine used for, and the time of, the model run.

Constructor & Destructor Documentation

◆ RunID()

RunID::RunID ( )

This is the default RunID constructor.

◆ ~RunID()

RunID::~RunID ( )

This is the default RunID destructor.

Member Function Documentation

◆ Print()

void RunID::Print ( ostream &  o)

This will print the model run information for the current model.

Parameters
ois the ofstream that the model run information will be written to

◆ printTime()

void RunID::printTime ( ostream &  o)

This will print information about the run time for the current model.

Parameters
ois the ofstream that the model run information will be written to

Member Data Documentation

◆ hostname

char* RunID::hostname
protected

This is the name of the host machine that is running the current model.

◆ runtime

time_t RunID::runtime
protected

This is the host machine that is running the current model.

This is the time that the current model started the simulation

◆ timestring

char* RunID::timestring
protected

This is the time stamp used to denote the time that the current model run started.


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