public class TimephasedData extends Object
Represents a time phased data.
Constructor and Description |
---|
TimephasedData()
Initializes a new instance of the
TimephasedData class. |
Modifier and Type | Method and Description |
---|---|
static TimephasedData |
createCostTimephased(int uid,
Date start,
Date finish,
double value,
int timeUnit,
int type)
Creates and initializes a new instance of the
TimephasedData class for cost-based time phased data. |
static TimephasedData |
createUnitTimephased(int uid,
Date start,
Date finish,
double units,
int type)
Creates and initializes a new instance of the
TimephasedData class for unit-based time phased data of an
assignment of a material resource. |
static TimephasedData |
createWorkTimephased(int uid,
Date start,
Date finish,
double value,
int timeUnit,
int type)
Creates and initializes a new instance of the
TimephasedData class for work-based time phased data. |
Date |
getFinish()
Returns the finish date of a timephased data period.
|
Date |
getStart()
Returns the start date of a timephased data period.
|
int |
getTimephasedDataType()
Returns the type of a time phased data.
|
int |
getUid()
Gets the unique identifier of a time phased data
Read/write
int . |
int |
getUnit()
Gets the time unit of a time phased data period.
|
String |
getValue()
Gets the value per unit of time for a time phased data period.
|
double |
getValueToCost()
Gets
double instance which represents string value of this object. |
double |
getValueToDuration()
Gets
double instance which represents string value of this object. |
double |
getValueToUnits()
Gets
double instance which represents string value of this object for unit-based time phased data. |
void |
setFinish(Date value)
Sets the finish date of a timephased data period.
|
void |
setStart(Date value)
Sets the start date of a timephased data period.
|
void |
setTimephasedDataType(int value)
Sets the type of a timephased data.
|
void |
setUid(int value)
Sets the unique identifier of a time phased data
Read/write
int . |
void |
setUnit(int value)
Sets the time unit of a time phased data period.
|
void |
setValue(String value)
Sets the value per unit of time for a timephased data period.
|
public TimephasedData()
Initializes a new instance of the TimephasedData
class.
public static TimephasedData createCostTimephased(int uid, Date start, Date finish, double value, int timeUnit, int type)
Creates and initializes a new instance of the TimephasedData
class for cost-based time phased data.
uid
- UID of the task.start
- start date-time.finish
- Finish date-time.value
- Cost value.timeUnit
- Time unit type.type
- Time-phased data type.TimephasedData
class for cost-based time phased data.public static TimephasedData createUnitTimephased(int uid, Date start, Date finish, double units, int type)
Creates and initializes a new instance of the TimephasedData
class for unit-based time phased data of an
assignment of a material resource.
uid
- UID of the task.start
- Start date-time.finish
- Finish date-time.units
- Number of units.type
- Time-phased data type.TimephasedData
class for cost-based time phased data.public static TimephasedData createWorkTimephased(int uid, Date start, Date finish, double value, int timeUnit, int type)
Creates and initializes a new instance of the TimephasedData
class for work-based time phased data.
uid
- UID of the task.start
- start date-time.finish
- Finish date-time.value
- Duration value in milliseconds.timeUnit
- Time unit type.type
- Time-phased data type.TimephasedData
instance created.public final Date getFinish()
Date
).public final void setFinish(Date value)
value
- the finish date of a timephased data period (Date
).public final Date getStart()
Date
).public final void setStart(Date value)
value
- the start date of a timephased data period (Date
).public final int getTimephasedDataType()
TimephasedDataType
).public final void setTimephasedDataType(int value)
Sets the type of a timephased data.
Read/write TimephasedDataType
.
Value
(getValue()
/setValue(String)
) property will be cleared, if it is not
suitable for type, specified here. value
- the type of a time phased data.public final int getUid()
Gets the unique identifier of a time phased data
Read/write int
.
int
.public final void setUid(int value)
Sets the unique identifier of a time phased data
Read/write int
.
value
- the unique identifier of a time phased data
Read/write int
.public final int getUnit()
Gets the time unit of a time phased data period.
Read/write TimeUnitType
.
public final void setUnit(int value)
Sets the time unit of a time phased data period.
Read/write TimeUnitType
.
value
- the time unit of a time phased data period.public final String getValue()
Gets the value per unit of time for a time phased data period.
Read/write String
.
TasksException
- When value is incorrect for specified TimephasedDataType
(getTimephasedDataType()
/setTimephasedDataType(int)
).public final void setValue(String value)
Sets the value per unit of time for a timephased data period.
Read/write String
.
value
- the value per unit of time for a time phased data period.TasksException
- When value is incorrect for specified TimephasedDataType
(getTimephasedDataType()
/setTimephasedDataType(int)
).public final double getValueToCost()
Gets double
instance which represents string value of this object.
double
representation of this object.public final double getValueToDuration()
Gets double
instance which represents string value of this object.
double
representation of this object.public final double getValueToUnits()
Gets double
instance which represents string value of this object for unit-based time phased data.
double
representation of this object.