IlvCriticalPathCalculator (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.gantt.model.IlvCriticalPathCalculator

public class IlvCriticalPathCalculator
extends Object

IlvCriticalPathCalculator applies the critical path method to a Gantt data model. This is done by invoking the computeSchedule() method. Activities are rescheduled to start as soon as possible after the project start time, based upon their preceding and succeeding constraints. The project start time can be set explicitly or else the earliest start time of all activities in the data model will be used. Note, that activity reservations are not taken into account by the critical path computations and resource leveling is not performed.

After the schedule is recomputed, all activities will have their start and end times updated to the earliest start and earliest finish times computed by the critical path method. In addition, all activities that are instances of IlvGeneralActivity will have the following configurable properties set on them:

CPM Attribute	Default Activity Property Name	Property Name Setter
Earliest Start Time	`"earliestStart"`	`setEarliestStartProperty(java.lang.String)`
Earliest Finish Time	`"earliestFinish"`	`setEarliestFinishProperty(java.lang.String)`
Latest Start Time	`"latestStart"`	`setLatestStartProperty(java.lang.String)`
Latest Finish Time	`"latestFinish"`	`setLatestFinishProperty(java.lang.String)`
Total Slack Duration	`"totalSlack"`	`setTotalSlackProperty(java.lang.String)`

IlvCriticalPathCalculator does not automatically recompute the critical path when the data model changes. For this capability, look at the IlvGanttModelScheduler class. Also note that IlvCriticalPathCalculator will disable the autoCalcTimeIntervalFromChildren property of all activities in the data model. This is to ensure that this simplistic technique of updating parent activities from their children will not conflict with the critical path method's updates to the data model.

Since:: JViews 7.5

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_CRITICAL_PROPERTY` The default critical boolean property for activities in the data model.
`static String`	`DEFAULT_EARLIEST_FINISH_PROPERTY` The default earliest finish time property for activities in the data model.
`static String`	`DEFAULT_EARLIEST_START_PROPERTY` The default earliest start time property for activities in the data model.
`static String`	`DEFAULT_LATEST_FINISH_PROPERTY` The default latest finish time property for activities in the data model.
`static String`	`DEFAULT_LATEST_START_PROPERTY` The default latest start time property for activities in the data model.
`static String`	`DEFAULT_TOTAL_SLACK_PROPERTY` The default total slack duration property for activities in the data model.

Constructor Summary

Constructors
Constructor and Description
`IlvCriticalPathCalculator()` Creates a new critical path calculator.
`IlvCriticalPathCalculator(IlvGanttModel ganttModel)` Creates a new critical path calculator for the specified data model.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCriticalPathListener(CriticalPathListener listener)` Adds the specified listener to receive critical path computation events.
`void`	`computeSchedule()` Computes the schedule of the Gantt data model by applying the critical path method.
`String`	`getCriticalProperty()` Returns the name of the critical boolean property for activities in the data model.
`IlvDuration`	`getCriticalThreshold()` Returns the critical threshold.
`String`	`getEarliestFinishProperty()` Returns the name of the earliest finish time property for activities in the data model.
`String`	`getEarliestStartProperty()` Returns the name of the earliest start time property for activities in the data model.
`IlvGanttModel`	`getGanttModel()` Returns the Gantt data model for which this calculator is computing the critical path.
`String`	`getLatestFinishProperty()` Returns the name of the latest finish time property for activities in the data model.
`String`	`getLatestStartProperty()` Returns the name of the latest start time property for activities in the data model.
`Date`	`getProjectStart()` Returns the data model's project start date.
`String`	`getTotalSlackProperty()` Returns the name of the total slack duration property for activities in the data model.
`void`	`removeCriticalPathListener(CriticalPathListener listener)` Removes the specified listener so that it no longer receives critical path computation events.
`void`	`setCriticalProperty(String propertyName)` Sets the name of the critical boolean property for activities in the data model.
`void`	`setCriticalThreshold(IlvDuration threshold)` Sets the critical threshold.
`void`	`setEarliestFinishProperty(String propertyName)` Sets the name of the earliest finish time property for activities in the data model.
`void`	`setEarliestStartProperty(String propertyName)` Sets the name of the earliest start time property for activities in the data model.
`void`	`setGanttModel(IlvGanttModel ganttModel)` Sets the Gantt data model for which this calculator will compute the critical path.
`void`	`setLatestFinishProperty(String propertyName)` Sets the name of the latest finish time property for activities in the data model.
`void`	`setLatestStartProperty(String propertyName)` Sets the name of the latest start time property for activities in the data model.
`void`	`setProjectStart(Date projectStart)` Sets the data model's project start date.
`void`	`setTotalSlackProperty(String propertyName)` Sets the name of the total slack duration property for activities in the data model.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_EARLIEST_START_PROPERTY
```
public static final String DEFAULT_EARLIEST_START_PROPERTY
```
    The default earliest start time property for activities in the data model. The value is "earliestStart".
    
    See Also:
    
    Constant Field Values
  - DEFAULT_EARLIEST_FINISH_PROPERTY
```
public static final String DEFAULT_EARLIEST_FINISH_PROPERTY
```
    The default earliest finish time property for activities in the data model. The value is "earliestFinish".
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LATEST_START_PROPERTY
```
public static final String DEFAULT_LATEST_START_PROPERTY
```
    The default latest start time property for activities in the data model. The value is "latestStart".
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LATEST_FINISH_PROPERTY
```
public static final String DEFAULT_LATEST_FINISH_PROPERTY
```
    The default latest finish time property for activities in the data model. The value is "latestFinish".
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TOTAL_SLACK_PROPERTY
```
public static final String DEFAULT_TOTAL_SLACK_PROPERTY
```
    The default total slack duration property for activities in the data model. The value is "totalSlack".
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CRITICAL_PROPERTY
```
public static final String DEFAULT_CRITICAL_PROPERTY
```
    The default critical boolean property for activities in the data model. The value is "critical".
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IlvCriticalPathCalculator
```
public IlvCriticalPathCalculator()
```
    Creates a new critical path calculator. Call the setGanttModel(ilog.views.gantt.IlvGanttModel) method to associate the data model whose critical path will be computed.
  - IlvCriticalPathCalculator
```
public IlvCriticalPathCalculator(IlvGanttModel ganttModel)
```
    Creates a new critical path calculator for the specified data model.
    
    Parameters:
    
    ganttModel - The Gantt data model.
- Method Detail
  - getGanttModel
```
public IlvGanttModel getGanttModel()
```
    Returns the Gantt data model for which this calculator is computing the critical path.
    
    Returns:
    
    The Gantt data model.
    
    See Also:
    
    setGanttModel(ilog.views.gantt.IlvGanttModel)
  - setGanttModel
```
public void setGanttModel(IlvGanttModel ganttModel)
```
    Sets the Gantt data model for which this calculator will compute the critical path.
    
    Parameters:
    
    ganttModel - The Gantt data model.
    
    See Also:
    
    getGanttModel()
  - getProjectStart
```
public Date getProjectStart()
```
    Returns the data model's project start date. If a project start date has been explicitly set, then that value is returned. Otherwise, the earliest start time of all activities in the data model is used.
    
    Returns:
    
    The project start date of the data model.
    
    See Also:
    
    setProjectStart(java.util.Date)
  - setProjectStart
```
public void setProjectStart(Date projectStart)
```
    Sets the data model's project start date.
    
    Parameters:
    
    projectStart - The project start date of the data model. If null, then the earliest start time of all activities in the data model will be used.
    
    See Also:
    
    getProjectStart()
  - getCriticalThreshold
```
public IlvDuration getCriticalThreshold()
```
    Returns the critical threshold. Activities that have a total slack time less than or equal to this threshold will be flagged as critical. The default value is a duration of zero, meaning that activities must have no slack in order to be considered critical.
    
    Returns:
    
    The critical duration threshold.
    
    See Also:
    
    setCriticalThreshold(ilog.views.gantt.IlvDuration)
  - setCriticalThreshold
```
public void setCriticalThreshold(IlvDuration threshold)
```
    Sets the critical threshold. Activities that have a total slack time less than or equal to this threshold will be flagged as critical.
    
    Parameters:
    
    threshold - The critical duration threshold.
    
    See Also:
    
    getCriticalThreshold()
  - getEarliestStartProperty
```
public String getEarliestStartProperty()
```
    Returns the name of the earliest start time property for activities in the data model. The default is "earliestStart".
    
    Returns:
    
    The name of the earliest start time property.
    
    See Also:
    
    setEarliestStartProperty(java.lang.String)
  - setEarliestStartProperty
```
public void setEarliestStartProperty(String propertyName)
```
    Sets the name of the earliest start time property for activities in the data model.
    
    Parameters:
    
    propertyName - The name of the earliest start time property.
    
    See Also:
    
    getEarliestStartProperty()
  - getEarliestFinishProperty
```
public String getEarliestFinishProperty()
```
    Returns the name of the earliest finish time property for activities in the data model. The default is "earliestFinish".
    
    Returns:
    
    The name of the earliest finish time property.
    
    See Also:
    
    setEarliestFinishProperty(java.lang.String)
  - setEarliestFinishProperty
```
public void setEarliestFinishProperty(String propertyName)
```
    Sets the name of the earliest finish time property for activities in the data model.
    
    Parameters:
    
    propertyName - The name of the earliest finish time property.
    
    See Also:
    
    getEarliestFinishProperty()
  - getLatestStartProperty
```
public String getLatestStartProperty()
```
    Returns the name of the latest start time property for activities in the data model. The default is "latestStart".
    
    Returns:
    
    The name of the latest start time property.
    
    See Also:
    
    setLatestStartProperty(java.lang.String)
  - setLatestStartProperty
```
public void setLatestStartProperty(String propertyName)
```
    Sets the name of the latest start time property for activities in the data model.
    
    Parameters:
    
    propertyName - The name of the latest start time property.
    
    See Also:
    
    getLatestStartProperty()
  - getLatestFinishProperty
```
public String getLatestFinishProperty()
```
    Returns the name of the latest finish time property for activities in the data model. The default is "latestFinish".
    
    Returns:
    
    The name of the latest finish time property.
    
    See Also:
    
    setLatestFinishProperty(java.lang.String)
  - setLatestFinishProperty
```
public void setLatestFinishProperty(String propertyName)
```
    Sets the name of the latest finish time property for activities in the data model.
    
    Parameters:
    
    propertyName - The name of the latest finish time property.
    
    See Also:
    
    getLatestFinishProperty()
  - getTotalSlackProperty
```
public String getTotalSlackProperty()
```
    Returns the name of the total slack duration property for activities in the data model. The default is "totalSlack".
    
    Returns:
    
    The name of the total slack duration property.
    
    See Also:
    
    setTotalSlackProperty(java.lang.String)
  - setTotalSlackProperty
```
public void setTotalSlackProperty(String propertyName)
```
    Sets the name of the total slack duration property for activities in the data model.
    
    Parameters:
    
    propertyName - The name of the total slack duration property.
    
    See Also:
    
    getTotalSlackProperty()
  - getCriticalProperty
```
public String getCriticalProperty()
```
    Returns the name of the critical boolean property for activities in the data model. The default is "critical".
    
    Returns:
    
    The name of the critical boolean property.
    
    See Also:
    
    setCriticalProperty(java.lang.String)
  - setCriticalProperty
```
public void setCriticalProperty(String propertyName)
```
    Sets the name of the critical boolean property for activities in the data model.
    
    Parameters:
    
    propertyName - The name of the critical boolean property.
    
    See Also:
    
    getCriticalProperty()
  - computeSchedule
```
public void computeSchedule()
                     throws IlvConstraintCycleException
```
    Computes the schedule of the Gantt data model by applying the critical path method.
    Note that this will disable the autoCalcTimeIntervalFromChildren property of all activities in the data model. This is to ensure that this simplistic technique of updating parent activities from their children will not conflict with the critical path method's updates to the data model.
    
    Throws:
    
    IlvConstraintCycleException - if a constraint cycle is detected in the data model.
  - addCriticalPathListener
```
public void addCriticalPathListener(CriticalPathListener listener)
```
    Adds the specified listener to receive critical path computation events.
    
    Parameters:
    
    listener - The listener that will be subscribed to subsequent CriticalPathListener events.
    
    See Also:
    
    removeCriticalPathListener(ilog.views.gantt.event.CriticalPathListener)
  - removeCriticalPathListener
```
public void removeCriticalPathListener(CriticalPathListener listener)
```
    Removes the specified listener so that it no longer receives critical path computation events.
    
    Parameters:
    
    listener - The listener that will be unsubscribed from receiving CriticalPathListener events.
    
    See Also:
    
    addCriticalPathListener(ilog.views.gantt.event.CriticalPathListener)

Class IlvCriticalPathCalculator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_EARLIEST_START_PROPERTY

DEFAULT_EARLIEST_FINISH_PROPERTY

DEFAULT_LATEST_START_PROPERTY

DEFAULT_LATEST_FINISH_PROPERTY

DEFAULT_TOTAL_SLACK_PROPERTY

DEFAULT_CRITICAL_PROPERTY

Constructor Detail

IlvCriticalPathCalculator

IlvCriticalPathCalculator

Method Detail

getGanttModel

setGanttModel

getProjectStart

setProjectStart

getCriticalThreshold

setCriticalThreshold

getEarliestStartProperty

setEarliestStartProperty

getEarliestFinishProperty

setEarliestFinishProperty

getLatestStartProperty

setLatestStartProperty

getLatestFinishProperty

setLatestFinishProperty

getTotalSlackProperty

setTotalSlackProperty

getCriticalProperty

setCriticalProperty

computeSchedule

addCriticalPathListener

removeCriticalPathListener