Package com.nomagic.magicdraw.simulation

Class SimulationProfile.TimeSeriesChartStereotype

java.lang.Object
com.nomagic.profiles.ProfileImplementation.StereotypeWrapper
com.nomagic.magicdraw.simulation.SimulationProfile.TimeSeriesChartStereotype
Enclosing class:
SimulationProfile
public static class SimulationProfile.TimeSeriesChartStereotype extends ProfileImplementation.StereotypeWrapper

  • Field Details

    • STEREOTYPE_NAME

      public static final String STEREOTYPE_NAME
      See Also:

    • ANNOTATEFAILURES

      public static final String ANNOTATEFAILURES
      Annotate requirement and constraint failures on charts in red.
      See Also:

    • FIXEDRANGE

      public static final String FIXEDRANGE
      To specify whether a time series chart will automatically adjust the range in Y-axis. If the value is true, the range of Y-axis will be fixed; otherwise the range will be automatically changed.
      See Also:

    • FIXEDTIMELENGTH

      public static final String FIXEDTIMELENGTH
      Specify the fixed range to the time axis of the chart. If the value is specified, the range of the time axis will be fixed to the specified value. If the value of Fixed Time Location is unspecified, the plot(s) will move to the left if the time is greater than the maximum value of the time axis. The unit of fixed time length is specified by time unit tag definition of the execution config. If the time unit is unspecified, millisecond will be by default.
      See Also:

    • FIXEDTIMELOCATION

      public static final String FIXEDTIMELOCATION
      Specify the starting time of the time axis shown in the chart. If the value is unspecified while the value of Fixed Time Length is specified, the chart will work like an oscilloscope. The plot(s) will move to the left. The unit of fixed time location is specified by time unit tag definition of the execution config. If the time unit is unspecified, millisecond will be by default.
      See Also:

    • GRIDX

      public static final String GRIDX
      To show or hide a vertical grid line.
      See Also:

    • GRIDY

      public static final String GRIDY
      To show or hide a horizontal grid line.
      See Also:

    • KEEPOPENAFTERTERMINATION

      public static final String KEEPOPENAFTERTERMINATION
      If true, the chart will keep open after termination of the simulation.
      See Also:

    • LINEARINTERPOLATION

      public static final String LINEARINTERPOLATION
      If true, a curvilinear graph will be displayed. If false, a linear graph will be displayed.
      See Also:

    • LOADCSVFILE

      public static final String LOADCSVFILE
      A loaded CSV file that the Time Series Chart will load as a curved line graph. You can import multiple CSV files into the Time Series Chart and load them as curved line graphs. They will be represented with different colors and legend names (same as the filename extension) so that you can compare the differences between the actual results and the desired line graphs.
      See Also:

    • MAXVALUE

      public static final String MAXVALUE
      To specify an upper bound value of Y-axis.
      See Also:

    • MINVALUE

      public static final String MINVALUE
      To specify a lower bound value of Y-axis.
      See Also:

    • PLOTCOLOR

      public static final String PLOTCOLOR
      To specify a plot color.
      See Also:

    • RECORDPLOTDATAAS

      public static final String RECORDPLOTDATAAS
      Results shall be saved to a file as a selected format, if Result File is specified.
      See Also:

    • REFRESHRATE

      public static final String REFRESHRATE
      Specify the time intervals at which the time series chart should be refreshed. The unit of the refresh rate is the same as the Time Unit property value of the Simulation Configuration. If the time unit is not specified, the refresh rate is measured in milliseconds. If the refresh rate is not specified, the value of 1000 is used. Specify 0 to refresh the chart every time the value is changed.
      See Also:

    • RESULTFILE

      public static final String RESULTFILE
      If Result File is specified, results shall be saved to the file as a selected format in "Record Plot Data As" option. Otherwise, results shall be saved into the results model element.
      See Also:

    • SOURCE

      public static final String SOURCE
      Specify the implementation class for the UI component. It must be a Java class that implements the com.nomagic.magicdraw.simulation.uiprototype.Mockup interface.
      See Also:

    • TITLE

      public static final String TITLE
      To specify the title of a chart.
      See Also:

    • YLABEL

      public static final String YLABEL
      Specify the label of y-axis of the chart.
      See Also:

    • NESTEDPROPERTYPATHS

      public static final String NESTEDPROPERTYPATHS
      Specify nested property paths
      See Also:

    • REPRESENTS

      public static final String REPRESENTS
      Specify the classifier represented by the configuration.
      See Also:

    • VALUE

      public static final String VALUE
      Structural feature which value should be represented for the configuration.
      See Also:

  • Constructor Details

    • TimeSeriesChartStereotype

      protected TimeSeriesChartStereotype(SimulationProfile profile)

  • Method Details

    • getStereotype

      public Stereotype getStereotype()
      Description copied from class: ProfileImplementation.StereotypeWrapper
      Returns stereotype for this wrapper.
      Specified by:
      getStereotype in class ProfileImplementation.StereotypeWrapper
      Returns:
      stereotype

    • getAnnotateFailuresProperty

      @CheckForNull public Property getAnnotateFailuresProperty()

    • getFixedRangeProperty

      @CheckForNull public Property getFixedRangeProperty()

    • getFixedTimeLengthProperty

      @CheckForNull public Property getFixedTimeLengthProperty()

    • getFixedTimeLocationProperty

      @CheckForNull public Property getFixedTimeLocationProperty()

    • getGridXProperty

      @CheckForNull public Property getGridXProperty()

    • getGridYProperty

      @CheckForNull public Property getGridYProperty()

    • getKeepOpenAfterTerminationProperty

      @CheckForNull public Property getKeepOpenAfterTerminationProperty()

    • getLinearInterpolationProperty

      @CheckForNull public Property getLinearInterpolationProperty()

    • getLoadCSVFileProperty

      @CheckForNull public Property getLoadCSVFileProperty()

    • getMaxValueProperty

      @CheckForNull public Property getMaxValueProperty()

    • getMinValueProperty

      @CheckForNull public Property getMinValueProperty()

    • getPlotColorProperty

      @CheckForNull public Property getPlotColorProperty()

    • getRecordPlotDataAsProperty

      @CheckForNull public Property getRecordPlotDataAsProperty()

    • getRefreshRateProperty

      @CheckForNull public Property getRefreshRateProperty()

    • getResultFileProperty

      @CheckForNull public Property getResultFileProperty()

    • getSourceProperty

      @CheckForNull public Property getSourceProperty()

    • getTitleProperty

      @CheckForNull public Property getTitleProperty()

    • getYLabelProperty

      @CheckForNull public Property getYLabelProperty()

    • getNestedPropertyPathsProperty

      @CheckForNull public Property getNestedPropertyPathsProperty()

    • getRepresentsProperty

      @CheckForNull public Property getRepresentsProperty()

    • getValueProperty

      @CheckForNull public Property getValueProperty()

    • setAnnotateFailures

      public void setAnnotateFailures(Element element, @CheckForNull Boolean value)

    • clearAnnotateFailures

      public void clearAnnotateFailures(Element element)

    • isAnnotateFailures

      @CheckForNull public Boolean isAnnotateFailures(Element element)

    • setFixedRange

      public void setFixedRange(Element element, @CheckForNull Boolean value)

    • clearFixedRange

      public void clearFixedRange(Element element)

    • isFixedRange

      @CheckForNull public Boolean isFixedRange(Element element)

    • setFixedTimeLength

      public void setFixedTimeLength(Element element, @CheckForNull Integer value)

    • clearFixedTimeLength

      public void clearFixedTimeLength(Element element)

    • getFixedTimeLength

      @CheckForNull public Integer getFixedTimeLength(Element element)

    • setFixedTimeLocation

      public void setFixedTimeLocation(Element element, @CheckForNull Integer value)

    • clearFixedTimeLocation

      public void clearFixedTimeLocation(Element element)

    • getFixedTimeLocation

      @CheckForNull public Integer getFixedTimeLocation(Element element)

    • setGridX

      public void setGridX(Element element, @CheckForNull Boolean value)

    • clearGridX

      public void clearGridX(Element element)

    • isGridX

      @CheckForNull public Boolean isGridX(Element element)

    • setGridY

      public void setGridY(Element element, @CheckForNull Boolean value)

    • clearGridY

      public void clearGridY(Element element)

    • isGridY

      @CheckForNull public Boolean isGridY(Element element)

    • setKeepOpenAfterTermination

      public void setKeepOpenAfterTermination(Element element, @CheckForNull Boolean value)

    • clearKeepOpenAfterTermination

      public void clearKeepOpenAfterTermination(Element element)

    • isKeepOpenAfterTermination

      @CheckForNull public Boolean isKeepOpenAfterTermination(Element element)

    • setLinearInterpolation

      public void setLinearInterpolation(Element element, @CheckForNull Boolean value)

    • clearLinearInterpolation

      public void clearLinearInterpolation(Element element)

    • isLinearInterpolation

      @CheckForNull public Boolean isLinearInterpolation(Element element)

    • setLoadCSVFile

      public void setLoadCSVFile(Element element, @CheckForNull Collection<String> value)

    • clearLoadCSVFile

      public void clearLoadCSVFile(Element element)

    • addLoadCSVFile

      public void addLoadCSVFile(Element element, String value)

    • removeLoadCSVFile

      public void removeLoadCSVFile(Element element, String value)

    • getLoadCSVFile

      public List<String> getLoadCSVFile(Element element)

    • setMaxValue

      public void setMaxValue(Element element, @CheckForNull String value)

    • clearMaxValue

      public void clearMaxValue(Element element)

    • getMaxValue

      @CheckForNull public String getMaxValue(Element element)

    • setMinValue

      public void setMinValue(Element element, @CheckForNull String value)

    • clearMinValue

      public void clearMinValue(Element element)

    • getMinValue

      @CheckForNull public String getMinValue(Element element)

    • setPlotColor

      public void setPlotColor(Element element, @CheckForNull Collection<String> value)

    • clearPlotColor

      public void clearPlotColor(Element element)

    • addPlotColor

      public void addPlotColor(Element element, String value)

    • removePlotColor

      public void removePlotColor(Element element, String value)

    • getPlotColor

      public List<String> getPlotColor(Element element)

    • setRecordPlotDataAs

      public void setRecordPlotDataAs(Element element, @CheckForNull SimulationProfile.DataRecordTypeEnum value)

    • clearRecordPlotDataAs

      public void clearRecordPlotDataAs(Element element)

    • getRecordPlotDataAs

      @CheckForNull public SimulationProfile.DataRecordTypeEnum getRecordPlotDataAs(Element element)

    • setRefreshRate

      public void setRefreshRate(Element element, @CheckForNull Integer value)

    • clearRefreshRate

      public void clearRefreshRate(Element element)

    • getRefreshRate

      @CheckForNull public Integer getRefreshRate(Element element)

    • setResultFile

      public void setResultFile(Element element, @CheckForNull String value)

    • clearResultFile

      public void clearResultFile(Element element)

    • getResultFile

      @CheckForNull public String getResultFile(Element element)

    • setSource

      public void setSource(Element element, @CheckForNull String value)

    • clearSource

      public void clearSource(Element element)

    • getSource

      @CheckForNull public String getSource(Element element)

    • setTitle

      public void setTitle(Element element, @CheckForNull String value)

    • clearTitle

      public void clearTitle(Element element)

    • getTitle

      @CheckForNull public String getTitle(Element element)

    • setYLabel

      public void setYLabel(Element element, @CheckForNull String value)

    • clearYLabel

      public void clearYLabel(Element element)

    • getYLabel

      @CheckForNull public String getYLabel(Element element)

    • setNestedPropertyPaths

      public void setNestedPropertyPaths(Element element, @CheckForNull Collection<String> value)

    • clearNestedPropertyPaths

      public void clearNestedPropertyPaths(Element element)

    • addNestedPropertyPaths

      public void addNestedPropertyPaths(Element element, String value)

    • removeNestedPropertyPaths

      public void removeNestedPropertyPaths(Element element, String value)

    • getNestedPropertyPaths

      public List<String> getNestedPropertyPaths(Element element)

    • setRepresents

      public void setRepresents(Element element, @CheckForNull Element value)

    • clearRepresents

      public void clearRepresents(Element element)

    • getRepresents

      @CheckForNull public Element getRepresents(Element element)

    • setValue

      public void setValue(Element element, @CheckForNull Collection<? extends Element> value)

    • clearValue

      public void clearValue(Element element)

    • addValue

      public void addValue(Element element, Element value)

    • removeValue

      public void removeValue(Element element, Element value)

    • getValue

      public List<Element> getValue(Element element)

    • clear

      protected void clear()

    • is

      public boolean is(@CheckForNull Element element)

    • isInstance

      public static boolean isInstance(@CheckForNull Element element)