C# Class EnergyUsage

Show file Open project: FIU-SCIS-Senior-Projects/SmartBuilding4 Class Usage Examples

Public Methods

Method	Description
addTotalUse ( float use ) : void	Adds the total use.
addUsages ( int amt ) : void	Sets the number of usages.
getAvgUsePerSec ( ) : float	Gets The current use of energy per second of time in the simulation.
getBatteryList ( ) : List	Gets the battery list.
getIsEnergySupplied ( ) : bool	Gets if is energy supplied.
getIsOn ( ) : bool	Gets whether the energy use is currently on.
getIsUsingBattery ( ) : bool	Gets the is using battery.
getNumberOfUsages ( ) : int	Gets the number of usages.
getPlugLoad ( ) : PlugLoad,
getTotalUse ( ) : float	Gets the total use.
setAvgUsePerSec ( float amt ) : void	Sets the avg use per sec.
setIsEnergySupplied ( bool state ) : void	Sets if is energy supplied.
setIsOn ( bool state ) : void	Sets is on or off.
setIsUsingBattery ( bool state ) : void	Sets if is using battery.
setPlugLoad ( PlugLoad, pl ) : void

Private Methods

Method	Description
Start ( ) : void
Update ( ) : void

Method Details

addTotalUse() public method

Adds the total use.

public addTotalUse ( float use ) : void
use	float	Use... subtracts if negative.
return	void

addUsages() public method

Sets the number of usages.

public addUsages ( int amt ) : void
amt	int	Amt.
return	void

getAvgUsePerSec() public method

Gets The current use of energy per second of time in the simulation.

public getAvgUsePerSec ( ) : float
return	float

getBatteryList() public method

Gets the battery list.

public getBatteryList ( ) : List
return	List

getIsEnergySupplied() public method

Gets if is energy supplied.

public getIsEnergySupplied ( ) : bool
return	bool

getIsOn() public method

Gets whether the energy use is currently on.

public getIsOn ( ) : bool
return	bool

getIsUsingBattery() public method

Gets the is using battery.

public getIsUsingBattery ( ) : bool
return	bool

getNumberOfUsages() public method

Gets the number of usages.

public getNumberOfUsages ( ) : int
return	int

getPlugLoad() public method

public getPlugLoad ( ) : PlugLoad,
return	PlugLoad,

getTotalUse() public method

Gets the total use.

public getTotalUse ( ) : float
return	float

setAvgUsePerSec() public method

Sets the avg use per sec.

public setAvgUsePerSec ( float amt ) : void
amt	float	Amt.
return	void

setIsEnergySupplied() public method

Sets if is energy supplied.

public setIsEnergySupplied ( bool state ) : void
state	bool	If set to true state.
return	void

setIsOn() public method

Sets is on or off.

public setIsOn ( bool state ) : void
state	bool	If set to true state.
return	void

setIsUsingBattery() public method

Sets if is using battery.

public setIsUsingBattery ( bool state ) : void
state	bool	If set to true state.
return	void

setPlugLoad() public method

public setPlugLoad ( PlugLoad, pl ) : void
pl	PlugLoad,
return	void