Package org.goplanit.output.property

Class TimePeriodIdOutputProperty

java.lang.Object

org.goplanit.output.property.OutputProperty

org.goplanit.output.property.TimePeriodIdOutputProperty

All Implemented Interfaces:

Comparable<OutputProperty>

public final class TimePeriodIdOutputProperty
extends OutputProperty

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME

Constructor Summary

Constructors

Constructor	Description
TimePeriodIdOutputProperty()

Method Summary

Modifier and Type	Method	Description
OutputPropertyPriority	getColumnPriority()	Gets the column priority of the output property in output files The lower the column priority value of a property, the further to the left it is placed in the output file
DataType	getDataType()	Returns the data type of the output property
Unit	getDefaultUnit()	Returns the units of the output property
String	getName()	Returns the name of the output property
OutputPropertyType	getOutputPropertyType()	Return the value of the OutputProperty enumeration for this property
static Optional<Long>	getTimePeriodId(TimePeriod timePeriod)	Returns the current time period Id

Methods inherited from class org.goplanit.output.property.OutputProperty

compareTo, equals, getOverrideUnit, hashCode, isUnitOverride, of, of, setUnitOverride, supportsUnitOverride

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

TimePeriodIdOutputProperty

public TimePeriodIdOutputProperty()

Method Detail

getName

public String getName()

Description copied from class: OutputProperty

Returns the name of the output property

Specified by:

getName in class OutputProperty

Returns:

name of the output property

getDefaultUnit

public Unit getDefaultUnit()

Description copied from class: OutputProperty

Returns the units of the output property

Specified by:

getDefaultUnit in class OutputProperty

Returns:

units of the output property

getDataType

public DataType getDataType()

Description copied from class: OutputProperty

Returns the data type of the output property

Specified by:

getDataType in class OutputProperty

Returns:

data type of the output property

getOutputPropertyType

public OutputPropertyType getOutputPropertyType()

Description copied from class: OutputProperty

Return the value of the OutputProperty enumeration for this property

Specified by:

getOutputPropertyType in class OutputProperty

Returns:

the value of the OutputProperty enumeration for this property

getColumnPriority

public OutputPropertyPriority getColumnPriority()

Description copied from class: OutputProperty

Gets the column priority of the output property in output files The lower the column priority value of a property, the further to the left it is placed in the output file

Specified by:

getColumnPriority in class OutputProperty

Returns:

the column priority

getTimePeriodId

public static Optional<Long> getTimePeriodId(TimePeriod timePeriod)
                                      throws PlanItException

Returns the current time period Id

Parameters:

timePeriod - current time period

Returns:

the current time period Id

Throws:

PlanItException - thrown if there is an error