src/contrib/energy/model/basic-energy-source.h
changeset 6553 fb5ad9c7755a
parent 6535 0a90ef2b29a9
child 6699 d8909a1fd0ff
equal deleted inserted replaced
6552:e1a18247fa9c 6553:fb5ad9c7755a
    66    * Implements GetEnergyFraction.
    66    * Implements GetEnergyFraction.
    67    */
    67    */
    68   virtual double GetEnergyFraction (void);
    68   virtual double GetEnergyFraction (void);
    69 
    69 
    70   /**
    70   /**
    71    * \param energy Amount of energy (in Joules) to decrease from energy source.
    71    * \param energyJ Amount of energy (in Joules) to decrease from energy source.
    72    *
    72    *
    73    * Implements DecreaseRemainingEnergy.
    73    * Implements DecreaseRemainingEnergy.
    74    */
    74    */
    75   virtual void DecreaseRemainingEnergy (double energyJ);
    75   virtual void DecreaseRemainingEnergy (double energyJ);
    76 
    76 
    77   /**
    77   /**
    78    * \param energy Amount of energy (in Joules) to increase from energy source.
    78    * \param energyJ Amount of energy (in Joules) to increase from energy source.
    79    *
    79    *
    80    * Implements IncreaseRemainingEnergy.
    80    * Implements IncreaseRemainingEnergy.
    81    */
    81    */
    82   virtual void IncreaseRemainingEnergy (double energyJ);
    82   virtual void IncreaseRemainingEnergy (double energyJ);
    83 
    83 
    85    * Implements UpdateEnergySource.
    85    * Implements UpdateEnergySource.
    86    */
    86    */
    87   virtual void UpdateEnergySource (void);
    87   virtual void UpdateEnergySource (void);
    88 
    88 
    89   /**
    89   /**
    90    * \param initialEnergy Initial energy, in Joules
    90    * \param initialEnergyJ Initial energy, in Joules
    91    *
    91    *
    92    * Sets initial energy stored in the energy source. Note that initial energy
    92    * Sets initial energy stored in the energy source. Note that initial energy
    93    * is assumed to be set before simulation starts and is set only once per
    93    * is assumed to be set before simulation starts and is set only once per
    94    * simulation.
    94    * simulation.
    95    */
    95    */
    96   void SetInitialEnergy (double initialEnergyJ);
    96   void SetInitialEnergy (double initialEnergyJ);
    97 
    97 
    98   /**
    98   /**
    99    * \param supplyVoltage Supply voltage at the energy source, in Volts.
    99    * \param supplyVoltageV Supply voltage at the energy source, in Volts.
   100    *
   100    *
   101    * Sets supply voltage of the energy source.
   101    * Sets supply voltage of the energy source.
   102    */
   102    */
   103   void SetSupplyVoltage (double supplyVoltageV);
   103   void SetSupplyVoltage (double supplyVoltageV);
   104 
   104