src/contrib/energy/model/energy-source.h
changeset 6553 fb5ad9c7755a
parent 6535 0a90ef2b29a9
child 6699 d8909a1fd0ff
equal deleted inserted replaced
6552:e1a18247fa9c 6553:fb5ad9c7755a
    95    * This function returns the percentage of energy left in the energy source.
    95    * This function returns the percentage of energy left in the energy source.
    96    */
    96    */
    97   virtual double GetEnergyFraction (void) = 0;
    97   virtual double GetEnergyFraction (void) = 0;
    98 
    98 
    99   /**
    99   /**
   100    * \param energy Amount of energy to decrease (in Joules)
   100    * \param energyJ Amount of energy to decrease (in Joules)
   101    *
   101    *
   102    * This function decreases the remaining energy in the energy source by the
   102    * This function decreases the remaining energy in the energy source by the
   103    * specified amount. Provides linear interface for direct energy deduction.
   103    * specified amount. Provides linear interface for direct energy deduction.
   104    */
   104    */
   105   virtual void DecreaseRemainingEnergy (double energyJ) = 0;
   105   virtual void DecreaseRemainingEnergy (double energyJ) = 0;
   106 
   106 
   107   /**
   107   /**
   108    * \param energy Amount of energy to increase (in Joules)
   108    * \param energyJ Amount of energy to increase (in Joules)
   109    *
   109    *
   110    * This function increases the remaining energy in the energy source by the
   110    * This function increases the remaining energy in the energy source by the
   111    * specified amount. Provides linear interface for direct energy increase.
   111    * specified amount. Provides linear interface for direct energy increase.
   112    */
   112    */
   113   virtual void IncreaseRemainingEnergy (double energyJ) = 0;
   113   virtual void IncreaseRemainingEnergy (double energyJ) = 0;
   134    */
   134    */
   135   Ptr<Node> GetNode (void) const;
   135   Ptr<Node> GetNode (void) const;
   136 
   136 
   137   /**
   137   /**
   138    * \param deviceEnergyModelPtr Pointer to device energy model.
   138    * \param deviceEnergyModelPtr Pointer to device energy model.
   139    * \param tid TypeId of the specific device energy model.
       
   140    *
   139    *
   141    * This function appends a device energy model to the end of a list of
   140    * This function appends a device energy model to the end of a list of
   142    * DeviceEnergyModelInfo structs.
   141    * DeviceEnergyModelInfo structs.
   143    */
   142    */
   144   void AppendDeviceEnergyModel (Ptr<DeviceEnergyModel> deviceEnergyModelPtr);
   143   void AppendDeviceEnergyModel (Ptr<DeviceEnergyModel> deviceEnergyModelPtr);