Aspose.Tasks for C++
Aspose::Tasks::TimephasedData Class Reference

Represents a time phased data. More...

#include <TimephasedData.h>

Inherits System::Object.

Public Member Functions

double get_ValueToUnits ()
 Gets double instance which represents string value of this object for unit-based time phased data. More...
 
int32_t get_Uid () const
 Gets the unique identifier of a time phased data More...
 
void set_Uid (int32_t value)
 Sets the unique identifier of a time phased data More...
 
System::DateTime get_Start () const
 Gets the start date of a time phased data period. More...
 
void set_Start (System::DateTime value)
 Sets the start date of a time phased data period. More...
 
System::DateTime get_Finish () const
 Gets the finish date of a time phased data period. More...
 
void set_Finish (System::DateTime value)
 Sets the finish date of a time phased data period. More...
 
TimeUnitType get_Unit () const
 Gets the time unit of a time phased data period. More...
 
void set_Unit (TimeUnitType value)
 Sets the time unit of a time phased data period. More...
 
Aspose::Tasks::TimephasedDataType get_TimephasedDataType () const
 Gets the type of a time phased data. More...
 
void set_TimephasedDataType (Aspose::Tasks::TimephasedDataType value)
 Sets the type of a time phased data. More...
 
System::String get_Value ()
 Gets the value per unit of time for a time phased data period. More...
 
void set_Value (const System::String &value)
 Sets the value per unit of time for a time phased data period. More...
 
System::TimeSpan get_ValueToDuration () const
 Gets TimeSpan instance which represents string value of this object. More...
 
double get_ValueToCost ()
 Gets double instance which represents string value of this object. More...
 
void set_ValueToCost (double value)
 Gets double instance which represents string value of this object. More...
 
 TimephasedData ()
 Initializes a new instance of the Aspose::Tasks::TimephasedData class. More...
 

Static Public Member Functions

static System::SharedPtr< TimephasedDataCreateWorkTimephased (int32_t uid, System::DateTime start, System::DateTime finish, System::TimeSpan value, TimeUnitType timeUnit, Aspose::Tasks::TimephasedDataType type)
 Creates and initializes a new instance of the Aspose::Tasks::TimephasedData class for work-based time phased data. More...
 
static System::SharedPtr< TimephasedDataCreateCostTimephased (int32_t uid, System::DateTime start, System::DateTime finish, double value, TimeUnitType timeUnit, Aspose::Tasks::TimephasedDataType type)
 Creates and initializes a new instance of the Aspose::Tasks::TimephasedData class for cost-based time phased data. More...
 
static System::SharedPtr< TimephasedDataCreateCostTimephased (int32_t uid, System::DateTime start, System::DateTime finish, double value, Aspose::Tasks::TimephasedDataType type)
 Creates and initializes a new instance of the Aspose::Tasks::TimephasedData class for cost-based time phased data. More...
 
static System::SharedPtr< TimephasedDataCreateUnitTimephased (int32_t uid, System::DateTime start, System::DateTime finish, double units, Aspose::Tasks::TimephasedDataType type)
 Creates and initializes a new instance of the Aspose::Tasks::TimephasedData class for unit-based time phased data of an assignment of a material resource. More...
 

Detailed Description

Represents a time phased data.

Constructor & Destructor Documentation

◆ TimephasedData()

Aspose::Tasks::TimephasedData::TimephasedData ( )

Initializes a new instance of the Aspose::Tasks::TimephasedData class.

Member Function Documentation

◆ CreateCostTimephased() [1/2]

static System::SharedPtr<TimephasedData> Aspose::Tasks::TimephasedData::CreateCostTimephased ( int32_t  uid,
System::DateTime  start,
System::DateTime  finish,
double  value,
Aspose::Tasks::TimephasedDataType  type 
)
static

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

Parameters
uidUID of the task.
startstart date-time.
finishFinish date-time.
valueCost value.
typeTime-phased data type.
Returns
A instance of the Aspose::Tasks::TimephasedData class for cost-based time phased data.
Exceptions
ArgumentExceptionIf negative cost value was specified.

◆ CreateCostTimephased() [2/2]

static System::SharedPtr<TimephasedData> Aspose::Tasks::TimephasedData::CreateCostTimephased ( int32_t  uid,
System::DateTime  start,
System::DateTime  finish,
double  value,
TimeUnitType  timeUnit,
Aspose::Tasks::TimephasedDataType  type 
)
static

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

Parameters
uidUID of the task.
startstart date-time.
finishFinish date-time.
valueCost value.
timeUnitTime unit type.
typeTime-phased data type.
Returns
A instance of the Aspose::Tasks::TimephasedData class for cost-based time phased data.
Exceptions
ArgumentExceptionIf negative cost value was specified.

◆ CreateUnitTimephased()

static System::SharedPtr<TimephasedData> Aspose::Tasks::TimephasedData::CreateUnitTimephased ( int32_t  uid,
System::DateTime  start,
System::DateTime  finish,
double  units,
Aspose::Tasks::TimephasedDataType  type 
)
static

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

Parameters
uidUID of the task.
startStart date-time.
finishFinish date-time.
unitsNumber of units.
typeTime-phased data type.
Returns
A instance of the Aspose::Tasks::TimephasedData class for cost-based time phased data.
Exceptions
ArgumentExceptionIf negative amount of units was specified.

◆ CreateWorkTimephased()

static System::SharedPtr<TimephasedData> Aspose::Tasks::TimephasedData::CreateWorkTimephased ( int32_t  uid,
System::DateTime  start,
System::DateTime  finish,
System::TimeSpan  value,
TimeUnitType  timeUnit,
Aspose::Tasks::TimephasedDataType  type 
)
static

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

Parameters
uidUID of the task.
startstart date-time.
finishFinish date-time.
valueTimespan value.
timeUnitTime unit type.
typeTime-phased data type.
Returns
A instance of the Aspose::Tasks::TimephasedData class for work-based time phased data.
Exceptions
ArgumentExceptionIf negative work value was specified.

◆ get_Finish()

System::DateTime Aspose::Tasks::TimephasedData::get_Finish ( ) const

Gets the finish date of a time phased data period.

◆ get_Start()

System::DateTime Aspose::Tasks::TimephasedData::get_Start ( ) const

Gets the start date of a time phased data period.

◆ get_TimephasedDataType()

Aspose::Tasks::TimephasedDataType Aspose::Tasks::TimephasedData::get_TimephasedDataType ( ) const

Gets the type of a time phased data.

Value property will be cleared, if it is not suitable for type, specified here.

◆ get_Uid()

int32_t Aspose::Tasks::TimephasedData::get_Uid ( ) const

Gets the unique identifier of a time phased data

◆ get_Unit()

TimeUnitType Aspose::Tasks::TimephasedData::get_Unit ( ) const

Gets the time unit of a time phased data period.

◆ get_Value()

System::String Aspose::Tasks::TimephasedData::get_Value ( )

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

Exceptions
TasksExceptionWhen value is incorrect for specified TimephasedDataType or have negative value.

◆ get_ValueToCost()

double Aspose::Tasks::TimephasedData::get_ValueToCost ( )

Gets double instance which represents string value of this object.

Returns
a floating point representation of the object.

◆ get_ValueToDuration()

System::TimeSpan Aspose::Tasks::TimephasedData::get_ValueToDuration ( ) const

Gets TimeSpan instance which represents string value of this object.

Returns
a time span representation of the object.

◆ get_ValueToUnits()

double Aspose::Tasks::TimephasedData::get_ValueToUnits ( )

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

Returns
a floating point representation of this object.

◆ set_Finish()

void Aspose::Tasks::TimephasedData::set_Finish ( System::DateTime  value)

Sets the finish date of a time phased data period.

◆ set_Start()

void Aspose::Tasks::TimephasedData::set_Start ( System::DateTime  value)

Sets the start date of a time phased data period.

◆ set_TimephasedDataType()

void Aspose::Tasks::TimephasedData::set_TimephasedDataType ( Aspose::Tasks::TimephasedDataType  value)

Sets the type of a time phased data.

Value property will be cleared, if it is not suitable for type, specified here.

◆ set_Uid()

void Aspose::Tasks::TimephasedData::set_Uid ( int32_t  value)

Sets the unique identifier of a time phased data

◆ set_Unit()

void Aspose::Tasks::TimephasedData::set_Unit ( TimeUnitType  value)

Sets the time unit of a time phased data period.

◆ set_Value()

void Aspose::Tasks::TimephasedData::set_Value ( const System::String &  value)

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

Exceptions
TasksExceptionWhen value is incorrect for specified TimephasedDataType or have negative value.

◆ set_ValueToCost()

void Aspose::Tasks::TimephasedData::set_ValueToCost ( double  value)

Gets double instance which represents string value of this object.

Parameters
valuea floating point representation of the object.