2014-12-13 01:19:51 +01:00
|
|
|
/*
|
|
|
|
* The MIT License (MIT)
|
2015-02-03 12:04:13 +01:00
|
|
|
*
|
2014-12-13 01:19:51 +01:00
|
|
|
* Copyright (c) 2013 AlgorithmX2
|
2015-02-03 12:04:13 +01:00
|
|
|
*
|
2014-12-13 01:19:51 +01:00
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
|
|
* this software and associated documentation files (the "Software"), to deal in
|
|
|
|
* the Software without restriction, including without limitation the rights to
|
|
|
|
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
|
|
* the Software, and to permit persons to whom the Software is furnished to do so,
|
|
|
|
* subject to the following conditions:
|
2015-02-03 12:04:13 +01:00
|
|
|
*
|
2014-12-13 01:19:51 +01:00
|
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
|
|
* copies or substantial portions of the Software.
|
2015-02-03 12:04:13 +01:00
|
|
|
*
|
2014-12-13 01:19:51 +01:00
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
|
|
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
|
|
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
|
|
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
|
|
*/
|
|
|
|
|
2014-12-04 13:00:54 +01:00
|
|
|
package appeng.api.networking.energy;
|
|
|
|
|
2015-04-03 08:54:31 +02:00
|
|
|
|
2014-12-04 13:00:54 +01:00
|
|
|
import appeng.api.config.AccessRestriction;
|
|
|
|
import appeng.api.config.Actionable;
|
|
|
|
|
2015-04-03 08:54:31 +02:00
|
|
|
|
2014-12-04 13:00:54 +01:00
|
|
|
/**
|
|
|
|
* Used to access information about AE's various power accepting blocks for monitoring purposes.
|
|
|
|
*/
|
|
|
|
public interface IAEPowerStorage extends IEnergySource
|
|
|
|
{
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Inject amt, power into the device, it will store what it can, and return the amount unable to be stored.
|
2015-02-03 12:04:13 +01:00
|
|
|
*
|
2016-01-01 01:48:15 +01:00
|
|
|
* @param amt to be injected amount
|
2014-12-04 13:00:54 +01:00
|
|
|
* @param mode action mode
|
2015-02-03 12:04:13 +01:00
|
|
|
*
|
2014-12-04 13:00:54 +01:00
|
|
|
* @return amount of power which was unable to be stored
|
|
|
|
*/
|
2015-03-26 11:03:30 +01:00
|
|
|
double injectAEPower( double amt, Actionable mode );
|
2014-12-04 13:00:54 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @return the current maximum power ( this can change :P )
|
|
|
|
*/
|
2015-03-26 11:03:30 +01:00
|
|
|
double getAEMaxPower();
|
2014-12-04 13:00:54 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @return the current AE Power Level, this may exceed getMEMaxPower()
|
|
|
|
*/
|
2015-03-26 11:03:30 +01:00
|
|
|
double getAECurrentPower();
|
2014-12-04 13:00:54 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Checked on network reset to see if your block can be used as a public power storage ( use getPowerFlow to control
|
|
|
|
* the behavior )
|
2015-02-03 12:04:13 +01:00
|
|
|
*
|
2014-12-04 13:00:54 +01:00
|
|
|
* @return true if it can be used as a public power storage
|
|
|
|
*/
|
2015-03-26 11:03:30 +01:00
|
|
|
boolean isAEPublicPowerStorage();
|
2014-12-04 13:00:54 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Control the power flow by telling what the network can do, either add? or subtract? or both!
|
2015-02-03 12:04:13 +01:00
|
|
|
*
|
2014-12-04 13:00:54 +01:00
|
|
|
* @return access restriction what the network can do
|
|
|
|
*/
|
2015-03-26 11:03:30 +01:00
|
|
|
AccessRestriction getPowerFlow();
|
2014-12-04 13:00:54 +01:00
|
|
|
}
|