TimephasedData

Inheritance: java.lang.Object

public class TimephasedData

Represents a time phased data.

Constructors

ConstructorDescription
TimephasedData()Initializes a new instance of the TimephasedData class.

Methods

MethodDescription
createCostTimephased(int uid, Date start, Date finish, double value, byte type)Creates and initializes a new instance of the TimephasedData class for cost-based time phased data.
createCostTimephased(int uid, Date start, Date finish, double value, byte timeUnit, byte type)Creates and initializes a new instance of the TimephasedData class for cost-based time phased data.
createUnitTimephased(int uid, Date start, Date finish, double units, byte type)Creates and initializes a new instance of the TimephasedData class for unit-based time phased data of an assignment of a material resource.
createWorkTimephased(int uid, Date start, Date finish, double value, byte timeUnit, byte type)Creates and initializes a new instance of the TimephasedData class for work-based time phased data.
getFinish()Gets the finish date of a time phased data period.
getStart()Gets the start date of a time phased data period.
getTimephasedDataType()Gets the type of a time phased data.
getUid()Gets the unique identifier of a time phased data
getUnit()Gets the time unit of a time phased data period.
getValue()Gets the value per unit of time for a time phased data period.
getValueToCost()Gets double instance which represents string value of this object.
getValueToDuration()Gets double instance which represents string value of this object.
getValueToUnits()Gets double instance which represents string value of this object for unit-based time phased data.
setFinish(Date value)Sets the finish date of a time phased data period.
setStart(Date value)Sets the start date of a time phased data period.
setTimephasedDataType(byte value)Sets the type of a time phased data.
setUid(int value)Sets the unique identifier of a time phased data
setUnit(byte value)Sets the time unit of a time phased data period.
setValue(String value)Sets the value per unit of time for a time phased data period.
setValueToCost(double value)double instance which represents string value of this object.

TimephasedData()

public TimephasedData()

Initializes a new instance of the TimephasedData class.

createCostTimephased(int uid, Date start, Date finish, double value, byte type)

public static TimephasedData createCostTimephased(int uid, Date start, Date finish, double value, byte type)

Creates and initializes a new instance of the TimephasedData class for cost-based time phased data.

Parameters:

ParameterTypeDescription
uidintUID of the task.
startjava.util.Datestart date-time.
finishjava.util.DateFinish date-time.
valuedoubleCost value.
typebyteTime-phased data type.

Returns: TimephasedData - A instance of the TimephasedData class for cost-based time phased data.

createCostTimephased(int uid, Date start, Date finish, double value, byte timeUnit, byte type)

public static TimephasedData createCostTimephased(int uid, Date start, Date finish, double value, byte timeUnit, byte type)

Creates and initializes a new instance of the TimephasedData class for cost-based time phased data.

Parameters:

ParameterTypeDescription
uidintUID of the task.
startjava.util.Datestart date-time.
finishjava.util.DateFinish date-time.
valuedoubleCost value.
timeUnitbyteTime unit type.
typebyteTime-phased data type.

Returns: TimephasedData - A instance of the TimephasedData class for cost-based time phased data.

createUnitTimephased(int uid, Date start, Date finish, double units, byte type)

public static TimephasedData createUnitTimephased(int uid, Date start, Date finish, double units, byte type)

Creates and initializes a new instance of the TimephasedData class for unit-based time phased data of an assignment of a material resource.

Parameters:

ParameterTypeDescription
uidintUID of the task.
startjava.util.DateStart date-time.
finishjava.util.DateFinish date-time.
unitsdoubleNumber of units.
typebyteTime-phased data type.

Returns: TimephasedData - A instance of the TimephasedData class for cost-based time phased data.

createWorkTimephased(int uid, Date start, Date finish, double value, byte timeUnit, byte type)

public static TimephasedData createWorkTimephased(int uid, Date start, Date finish, double value, byte timeUnit, byte type)

Creates and initializes a new instance of the TimephasedData class for work-based time phased data.

Parameters:

ParameterTypeDescription
uidintUID of the task.
startjava.util.Datestart date-time.
finishjava.util.DateFinish date-time.
valuedoubleTimespan value.
timeUnitbyteTime unit type.
typebyteTime-phased data type.

Returns: TimephasedData - A instance of the TimephasedData class for work-based time phased data.

getFinish()

public final Date getFinish()

Gets the finish date of a time phased data period.

Returns: java.util.Date - the finish date of a time phased data period.

getStart()

public final Date getStart()

Gets the start date of a time phased data period.

Returns: java.util.Date - the start date of a time phased data period.

getTimephasedDataType()

public final byte getTimephasedDataType()

Gets the type of a time phased data.


Value (getValue()/setValue(String)) property will be cleared, if it is not suitable for type, specified here.

Returns: byte - the type of a time phased data.

getUid()

public final int getUid()

Gets the unique identifier of a time phased data

Returns: int - the unique identifier of a time phased data

getUnit()

public final byte getUnit()

Gets the time unit of a time phased data period.

Returns: byte - the time unit of a time phased data period.

getValue()

public final String getValue()

Gets the value per unit of time for a time phased data period.

Returns: java.lang.String - the value per unit of time for a time phased data period.

getValueToCost()

public final double getValueToCost()

Gets double instance which represents string value of this object.

Returns: double - a floating point representation of the object.

getValueToDuration()

public final double getValueToDuration()

Gets double instance which represents string value of this object.

Returns: double - a time span representation of the object.

getValueToUnits()

public final double getValueToUnits()

Gets double instance which represents string value of this object for unit-based time phased data.

Returns: double - a floating point representation of this object.

setFinish(Date value)

public final void setFinish(Date value)

Sets the finish date of a time phased data period.

Parameters:

ParameterTypeDescription
valuejava.util.Datethe finish date of a time phased data period.

setStart(Date value)

public final void setStart(Date value)

Sets the start date of a time phased data period.

Parameters:

ParameterTypeDescription
valuejava.util.Datethe start date of a time phased data period.

setTimephasedDataType(byte value)

public final void setTimephasedDataType(byte value)

Sets the type of a time phased data.


Value (getValue()/setValue(String)) property will be cleared, if it is not suitable for type, specified here.

Parameters:

ParameterTypeDescription
valuebytethe type of a time phased data.

setUid(int value)

public final void setUid(int value)

Sets the unique identifier of a time phased data

Parameters:

ParameterTypeDescription
valueintthe unique identifier of a time phased data

setUnit(byte value)

public final void setUnit(byte value)

Sets the time unit of a time phased data period.

Parameters:

ParameterTypeDescription
valuebytethe time unit of a time phased data period.

setValue(String value)

public final void setValue(String value)

Sets the value per unit of time for a time phased data period.

Parameters:

ParameterTypeDescription
valuejava.lang.Stringthe value per unit of time for a time phased data period.

setValueToCost(double value)

public final void setValueToCost(double value)

double instance which represents string value of this object.

Parameters:

ParameterTypeDescription
valuedoubledouble instance which represents string value of this object.