Class ChartActivityBase<T>

java.lang.Object
com.flexganttfx.model.activity.ActivityBase<T>
com.flexganttfx.model.activity.ChartActivityBase<T>
Type Parameters:
T - the type of the optional user object
All Implemented Interfaces:
Activity, ChartActivity
Direct Known Subclasses:
MutableChartActivityBase

public class ChartActivityBase<T>
extends ActivityBase<T>
implements ChartActivity
The base implementation of a chart activity, which defines an additional chart value attribute that can be utilized by the ChartLayout to create charts based on activities, e.g. for capacity usage / resource usage profiles.
Since:
1.0
See Also:
ChartLayout.getMinValue(), ChartLayout.getMaxValue()
  • Field Details

    • chartValue

      protected double chartValue
  • Constructor Details

    • ChartActivityBase

      public ChartActivityBase()
      Constructs a new chart activity. The initial start time will be set to Instant.now() and the end time will be equal to Instant.now() plus the value of ActivityBase.DEFAULT_DURATION. The chart value will be equal to zero.
      Since:
      1.0
    • ChartActivityBase

      public ChartActivityBase​(double value)
      Constructs a new chart activity with the given value. The initial start time will be set to Instant.now() and the end time will be equal to Instant.now() plus the value of ActivityBase.DEFAULT_DURATION.
      Parameters:
      value - the chart value of the activity
      Since:
      1.0
    • ChartActivityBase

      public ChartActivityBase​(double value, Instant time)
      Constructs a new chart activity with the given value. The start and end time will be equal to the given time.
      Parameters:
      value - the chart value of the activity
      time - the start and end time of the activity
      Since:
      1.0
    • ChartActivityBase

      public ChartActivityBase​(double value, Instant startTime, Instant endTime)
      Constructs a new chart activity with the given value. The start time and end time will be equal to the given times.
      Parameters:
      value - the chart value of the activity
      startTime - the start time of the activity
      endTime - the end time of the activity
      Since:
      1.0
  • Method Details

    • getChartValue

      public double getChartValue()
      Description copied from interface: ChartActivity
      Returns the chart value of the activity. The value can be positive or negative.
      Specified by:
      getChartValue in interface ChartActivity
      Returns:
      the chart value
    • toString

      public String toString()
      Overrides:
      toString in class ActivityBase<T>