Bexel Manager API Documentation
Bexel.Api.Scheduling.TaskCost Class Reference

More...

Inheritance diagram for Bexel.Api.Scheduling.TaskCost:
Bexel.Api.Scheduling.IAggregatedElementProgressValueProvider Bexel.Api.IAggregatedElementValueProvider

Public Member Functions

double GetValue (IEnumerable< int > internalElementIDs=null)
 Returns an aggregated value for the specified elements. More...
 

Properties

IAggregatedElementValueProvider Actual [get]
 Returns the cost incurred for work already performed on the task. More...
 
IAggregatedElementValueProvider Remaining [get]
 Returns the cost that will be incurred in completing the remaining work on the task. More...
 
double CompletionPercentage [get]
 Returns cost completion percentage of work already performed. The value is in the range between 0 and 1. More...
 
- Properties inherited from Bexel.Api.Scheduling.IAggregatedElementProgressValueProvider
IAggregatedElementValueProvider Actual [get]
 Returns the aggregated value of work that is already performed on the elements. More...
 
IAggregatedElementValueProvider Remaining [get]
 Returns the aggregated value of work that is not yet performed on the elements. More...
 

Detailed Description

Member Function Documentation

◆ GetValue()

double Bexel.Api.Scheduling.TaskCost.GetValue ( IEnumerable< int >  internalElementIDs = null)

Returns an aggregated value for the specified elements.

Parameters
internalElementIDsThe collection of element internal ids.
Returns
An aggregated cost or quantity for specified element internal ids.

Implements Bexel.Api.IAggregatedElementValueProvider.

Property Documentation

◆ Actual

IAggregatedElementValueProvider Bexel.Api.Scheduling.TaskCost.Actual
get

Returns the cost incurred for work already performed on the task.

◆ CompletionPercentage

double Bexel.Api.Scheduling.TaskCost.CompletionPercentage
get

Returns cost completion percentage of work already performed. The value is in the range between 0 and 1.

◆ Remaining

IAggregatedElementValueProvider Bexel.Api.Scheduling.TaskCost.Remaining
get

Returns the cost that will be incurred in completing the remaining work on the task.