partons/beans/Computation.h

0001 #ifndef COMPUTATION_H
0002 #define COMPUTATION_H
0003
0004 /**
0005  * @file Computation.h
0006  * @author: Bryan BERTHOU (SPhN / CEA Saclay)
0007  * @date November 05, 2015
0008  * @version 1.0
0009  */
0010
0011 #include <ctime>
0012
0013 #include "../BaseObject.h"
0014
0015 namespace PARTONS {
0016
0017 /**
0018  * @class Computation
0019  *
0020  * @brief Class to store computation information.
0021  *
0022  * This object is used to store the computation information, like that indicating time when a given computation was performed.
0023  * It is used in particular when a given computation is performed via xml scenario and its result is stored in the database.
0024  * In this case the content of Computation class is stored in the corresponding database table, so it can be retrieved latter.
0025  */
0026 class Computation: public BaseObject {
0027
0028 public:
0029
0030     /**
0031      * Default constructor.
0032      */
0033     Computation();
0034
0035     /**
0036      * Copy constructor.
0037      *
0038      * @param other Object to be copied.
0039      */
0040     Computation(const Computation &other);
0041
0042     /**
0043      * Assignment constructor.
0044      *
0045      * @param indexId Index id to be set, see BaseObject::m_indexId.
0046      * @param dateTime Time associated to a given computation to be set.
0047      */
0048     Computation(int indexId, time_t dateTime);
0049
0050     /**
0051      * Destructor.
0052      */
0053     virtual ~Computation();
0054
0055     //********************************************************
0056     //*** SETTERS AND GETTERS ********************************
0057     //********************************************************
0058
0059     /**
0060      * Get time associated to a given computation.
0061      */
0062     time_t getDateTime() const;
0063
0064     /**
0065      * Set time associated to a given computation.
0066      */
0067     void setDateTime(time_t dateTime);
0068
0069 private:
0070
0071     /**
0072      * Time associated to a given computation.
0073      */
0074     time_t m_dateTime;
0075 };
0076
0077 } /* namespace PARTONS */
0078
0079 #endif /* COMPUTATION_H */