ColdStorage (Power TAC customer models 1.3.2 API)

java.lang.Object
- org.powertac.customer.AbstractCustomer
- - org.powertac.customer.coldstorage.ColdStorage

All Implemented Interfaces:

org.powertac.common.interfaces.CustomerModelAccessor
```
@Domain
 @ConfigurableInstance
public class ColdStorage
extends org.powertac.customer.AbstractCustomer
implements org.powertac.common.interfaces.CustomerModelAccessor
```
Model of a cold-storage warehouse with multiple refrigeration units. The size of the refrigeration units is specified as stockCapacity. The number is indeterminate - as many as needed will be used, depending on heat loss and current internal temperature. If currentTemp < nominalTemp and falling or steady, then a unit will be de-energized. If currentTemp >= nominalTemp and rising or steady, then another unit will be activated.

Author:

John Collins

Field Summary
- Fields inherited from class org.powertac.customer.AbstractCustomer
  allCustomerInfos, customerInfos, name, rs1, service

Constructor Summary

Constructors
Constructor and Description

ColdStorage()
Default constructor, requires manual setting of name

ColdStorage(String name)
Constructor with name

Constructors
Constructor and Description
`ColdStorage()` Default constructor, requires manual setting of name
`ColdStorage(String name)` Constructor with name

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`evaluateTariffs(List<org.powertac.common.Tariff> tariffs)`
`double`	`getBrokerSwitchFactor(boolean isSuperseding)`
`org.powertac.common.CapacityProfile`	`getCapacityProfile(org.powertac.common.Tariff tariff)`
`double`	`getCop()`
`double`	`getCurrentTemp()`
`org.powertac.common.CustomerInfo`	`getCustomerInfo()`
`double`	`getEvalEnvTemp()`
`double`	`getFloorRValue()`
`double`	`getHysteresis()`
`double`	`getInertiaSample()`
`double`	`getInfiltrationRatio()`
`double`	`getMaxTemp()`
`double`	`getMinTemp()`
`double`	`getNewStockTemp()`
`double`	`getNominalTemp()`
`double`	`getNonCoolingUsage()`
`double`	`getRoofArea()`
`double`	`getRoofRValue()`
`double`	`getShiftingInconvenienceFactor(org.powertac.common.Tariff tariff)`
`double`	`getShiftSag()`
`double`	`getStockCapacity()`
`double`	`getTariffChoiceSample()`
`double`	`getTurnoverRatio()`
`double`	`getUnitSize()`
`double`	`getWallArea()`
`double`	`getWallRValue()`
`void`	`initialize()`
`void`	`setCurrentTemp(double temp)`
`void`	`setEvalEnvTemp(double temp)`
`void`	`setShiftSag(double deltaT)`
`void`	`step()`
`ColdStorage`	`withCop(double value)`
`ColdStorage`	`withFloorRValue(double value)`
`ColdStorage`	`withHysteresis(double value)`
`ColdStorage`	`withInfiltrationRatio(double value)`
`ColdStorage`	`withMaxTemp(double temp)`
`ColdStorage`	`withMinTemp(double temp)`
`ColdStorage`	`withNewStockTemp(double temp)`
`ColdStorage`	`withNominalTemp(double temp)`
`ColdStorage`	`withNonCoolingUsage(double value)`
`ColdStorage`	`withRoofArea(double area)`
`ColdStorage`	`withRoofRValue(double value)`
`ColdStorage`	`withStockCapacity(double value)`
`ColdStorage`	`withTurnoverRatio(double ratio)`
`ColdStorage`	`withUnitSize(double cap)`
`ColdStorage`	`withWallArea(double area)`
`ColdStorage`	`withWallRValue(double value)`

Methods inherited from class org.powertac.customer.AbstractCustomer
addCustomerInfo, changeSubscription, getCurrentSubscriptions, getCurrentSubscriptions, getCustId, getCustomerInfo, getCustomerInfoList, getCustomerInfos, getId, getName, getPopulation, lastSunday, nextStartOfDay, saveBootstrapState, setName, setServiceAccessor, setTariffMarket, startOfDay, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- ColdStorage
```
public ColdStorage()
```
  Default constructor, requires manual setting of name
- ColdStorage
```
public ColdStorage(String name)
```
  Constructor with name

Method Detail

initialize
```
public void initialize()
```
Overrides:

initialize in class org.powertac.customer.AbstractCustomer

getCustomerInfo
```
public org.powertac.common.CustomerInfo getCustomerInfo()
```
Specified by:

getCustomerInfo in interface org.powertac.common.interfaces.CustomerModelAccessor

step
```
public void step()
```
Specified by:

step in class org.powertac.customer.AbstractCustomer

evaluateTariffs
```
public void evaluateTariffs(List<org.powertac.common.Tariff> tariffs)
```
Specified by:

evaluateTariffs in class org.powertac.customer.AbstractCustomer

getCapacityProfile
```
public org.powertac.common.CapacityProfile getCapacityProfile(org.powertac.common.Tariff tariff)
```
Specified by:

getCapacityProfile in interface org.powertac.common.interfaces.CustomerModelAccessor

getBrokerSwitchFactor
```
public double getBrokerSwitchFactor(boolean isSuperseding)
```
Specified by:

getBrokerSwitchFactor in interface org.powertac.common.interfaces.CustomerModelAccessor

getTariffChoiceSample
```
public double getTariffChoiceSample()
```
Specified by:

getTariffChoiceSample in interface org.powertac.common.interfaces.CustomerModelAccessor

getInertiaSample
```
public double getInertiaSample()
```
Specified by:

getInertiaSample in interface org.powertac.common.interfaces.CustomerModelAccessor

getCurrentTemp
```
public double getCurrentTemp()
```

setCurrentTemp

@StateChange
public void setCurrentTemp(double temp)

getMinTemp
```
public double getMinTemp()
```

withMinTemp

@ConfigurableValue(valueType="Double",
                   description="minimum allowable temperature")
 @StateChange
public ColdStorage withMinTemp(double temp)

getMaxTemp
```
public double getMaxTemp()
```

withMaxTemp

@ConfigurableValue(valueType="Double",
                   description="maximum allowable temperature")
 @StateChange
public ColdStorage withMaxTemp(double temp)

getNominalTemp
```
public double getNominalTemp()
```

setShiftSag

@ConfigurableValue(valueType="Double",
                   description="allowable temperature change to save money on TOU tariffs")
 @StateChange
public void setShiftSag(double deltaT)

getShiftSag
```
public double getShiftSag()
```

setEvalEnvTemp

@ConfigurableValue(valueType="Double",
                   description="assumed outdoor temp for tariff evaluation")
 @StateChange
public void setEvalEnvTemp(double temp)

getEvalEnvTemp
```
public double getEvalEnvTemp()
```

withNominalTemp

@ConfigurableValue(valueType="Double",
                   description="nominal internal temperature")
 @StateChange
public ColdStorage withNominalTemp(double temp)

getNewStockTemp
```
public double getNewStockTemp()
```

withNewStockTemp

@ConfigurableValue(valueType="Double",
                   description="Temperature of incoming stock")
 @StateChange
public ColdStorage withNewStockTemp(double temp)

getStockCapacity
```
public double getStockCapacity()
```

withStockCapacity

@ConfigurableValue(valueType="Double",
                   description="Typical inventory in tonnes of H2O")
 @StateChange
public ColdStorage withStockCapacity(double value)

getTurnoverRatio
```
public double getTurnoverRatio()
```

withTurnoverRatio

@ConfigurableValue(valueType="Double",
                   description="Ratio of stock that gets replaced daily")
 @StateChange
public ColdStorage withTurnoverRatio(double ratio)

getRoofArea
```
public double getRoofArea()
```

withRoofArea

@ConfigurableValue(valueType="Double",
                   description="Area of roof")
 @StateChange
public ColdStorage withRoofArea(double area)

getRoofRValue
```
public double getRoofRValue()
```

withRoofRValue

@ConfigurableValue(valueType="Double",
                   description="R-value of roof insulation")
 @StateChange
public ColdStorage withRoofRValue(double value)

getWallArea
```
public double getWallArea()
```

withWallArea

@ConfigurableValue(valueType="Double",
                   description="Total area of outside walls")
 @StateChange
public ColdStorage withWallArea(double area)

getWallRValue
```
public double getWallRValue()
```

withWallRValue

@ConfigurableValue(valueType="Double",
                   description="R-value of wall insulation")
 @StateChange
public ColdStorage withWallRValue(double value)

getFloorRValue
```
public double getFloorRValue()
```

withFloorRValue

@ConfigurableValue(valueType="Double",
                   description="R-value of floor insulation")
 @StateChange
public ColdStorage withFloorRValue(double value)

getInfiltrationRatio
```
public double getInfiltrationRatio()
```

withInfiltrationRatio

@ConfigurableValue(valueType="Double",
                   description="Infiltration loss as proportion of wall + roof loss")
 @StateChange
public ColdStorage withInfiltrationRatio(double value)

getUnitSize
```
public double getUnitSize()
```

withUnitSize

@ConfigurableValue(valueType="Double",
                   description="Thermal capacity in tons of cooling plant")
 @StateChange
public ColdStorage withUnitSize(double cap)

getCop
```
public double getCop()
```

withCop

@ConfigurableValue(valueType="Double",
                   description="Coefficient of Performance of refrigeration unit")
 @StateChange
public ColdStorage withCop(double value)

getHysteresis
```
public double getHysteresis()
```

withHysteresis

@ConfigurableValue(valueType="Double",
                   description="Control range for refrigeration unit")
 @StateChange
public ColdStorage withHysteresis(double value)

getNonCoolingUsage
```
public double getNonCoolingUsage()
```

withNonCoolingUsage

@ConfigurableValue(valueType="Double",
                   description="Mean hourly energy usage for non-cooling purposes")
 @StateChange
public ColdStorage withNonCoolingUsage(double value)

getShiftingInconvenienceFactor
```
public double getShiftingInconvenienceFactor(org.powertac.common.Tariff tariff)
```
Specified by:

getShiftingInconvenienceFactor in interface org.powertac.common.interfaces.CustomerModelAccessor

Class ColdStorage

Field Summary

Fields inherited from class org.powertac.customer.AbstractCustomer

Constructor Summary

Method Summary

Methods inherited from class org.powertac.customer.AbstractCustomer

Methods inherited from class java.lang.Object

Constructor Detail

ColdStorage

ColdStorage

Method Detail

initialize

getCustomerInfo

step

evaluateTariffs

getCapacityProfile

getBrokerSwitchFactor

getTariffChoiceSample

getInertiaSample

getCurrentTemp

setCurrentTemp

getMinTemp

withMinTemp

getMaxTemp

withMaxTemp

getNominalTemp

setShiftSag

getShiftSag

setEvalEnvTemp

getEvalEnvTemp

withNominalTemp

getNewStockTemp

withNewStockTemp

getStockCapacity

withStockCapacity

getTurnoverRatio

withTurnoverRatio

getRoofArea

withRoofArea

getRoofRValue

withRoofRValue

getWallArea

withWallArea

getWallRValue

withWallRValue

getFloorRValue

withFloorRValue

getInfiltrationRatio

withInfiltrationRatio

getUnitSize

withUnitSize

getCop

withCop

getHysteresis

withHysteresis

getNonCoolingUsage

withNonCoolingUsage

getShiftingInconvenienceFactor