Package com.nomagic.magicdraw.simulation
Class SimulationProfile.HistogramStereotype
- java.lang.Object
-
- com.nomagic.profiles.ProfileImplementation.StereotypeWrapper
-
- com.nomagic.magicdraw.simulation.SimulationProfile.HistogramStereotype
-
- Enclosing class:
- SimulationProfile
public static class SimulationProfile.HistogramStereotype extends ProfileImplementation.StereotypeWrapper
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringANNOTATEFAILURESAnnotate requirement and constraint failures on charts in red.static java.lang.StringDYNAMICIf true, open the histogram during multiple runs which shows dynamic results, otherwise open the histogram at the end of all runs completion.static java.lang.StringFIXEDRANGETo specify whether a time series chart will automatically adjust the range in Y-axis.static java.lang.StringFIXEDTIMELENGTHSpecify the fixed range to the time axis of the chart.static java.lang.StringFIXEDTIMELOCATIONSpecify the starting time of the time axis shown in the time series chart.static java.lang.StringGRIDXTo show or hide a vertical grid line.static java.lang.StringGRIDYTo show or hide a horizontal grid line.static java.lang.StringKEEPOPENAFTERTERMINATIONIf true, the chart will keep open after termination of the simulation.static java.lang.StringLINEARINTERPOLATIONIf plot does (extra) interpolation or not is, it connecting 2 dots in time with a straight line or not.static java.lang.StringLOADCSVFILEA loaded CSV file that the Time Series Chart will load as a curved line graph.static java.lang.StringMAXVALUETo specify an upper bound value of Y-axis.static java.lang.StringMINVALUETo specify a lower bound value of Y-axis.static java.lang.StringNESTEDPROPERTYPATHSSpecify nested property pathsstatic java.lang.StringPLOTCOLORTo specify a plot color.static java.lang.StringRECORDPLOTDATAASResults shall be saved to a file as a selected format, if Result File is specified.static java.lang.StringREFRESHRATETo specify a time interval to refresh a time series chart.static java.lang.StringREPRESENTSSpecify the classifier represented by the configuration.static java.lang.StringRESULTFILEIf Result File is specified, results shall be saved to the file as a selected format in "Record Plot Data As" option.static java.lang.StringSOURCESpecify the implementation class for the UI component.static java.lang.StringSTEREOTYPE_NAMEstatic java.lang.StringTITLETo specify the title of a time series chart.static java.lang.StringVALUEStructural feature which value should be represented for the configuration.static java.lang.StringXLABELSpecify the label of x-axis of the chart.static java.lang.StringYLABELSpecify the label of y-axis of the chart.
-
Constructor Summary
Constructors Modifier Constructor Description protectedHistogramStereotype(SimulationProfile profile)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddLoadCSVFile(Element element, java.lang.String value)voidaddNestedPropertyPaths(Element element, java.lang.String value)voidaddPlotColor(Element element, java.lang.String value)voidaddValue(Element element, Element value)protected voidclear()voidclearAnnotateFailures(Element element)voidclearDynamic(Element element)voidclearFixedRange(Element element)voidclearFixedTimeLength(Element element)voidclearFixedTimeLocation(Element element)voidclearGridX(Element element)voidclearGridY(Element element)voidclearKeepOpenAfterTermination(Element element)voidclearLinearInterpolation(Element element)voidclearLoadCSVFile(Element element)voidclearMaxValue(Element element)voidclearMinValue(Element element)voidclearNestedPropertyPaths(Element element)voidclearPlotColor(Element element)voidclearRecordPlotDataAs(Element element)voidclearRefreshRate(Element element)voidclearRepresents(Element element)voidclearResultFile(Element element)voidclearSource(Element element)voidclearTitle(Element element)voidclearValue(Element element)voidclearXLabel(Element element)voidclearYLabel(Element element)PropertygetAnnotateFailuresProperty()PropertygetDynamicProperty()PropertygetFixedRangeProperty()java.lang.IntegergetFixedTimeLength(Element element)PropertygetFixedTimeLengthProperty()java.lang.IntegergetFixedTimeLocation(Element element)PropertygetFixedTimeLocationProperty()PropertygetGridXProperty()PropertygetGridYProperty()PropertygetKeepOpenAfterTerminationProperty()PropertygetLinearInterpolationProperty()java.util.List<java.lang.String>getLoadCSVFile(Element element)PropertygetLoadCSVFileProperty()java.lang.StringgetMaxValue(Element element)PropertygetMaxValueProperty()java.lang.StringgetMinValue(Element element)PropertygetMinValueProperty()java.util.List<java.lang.String>getNestedPropertyPaths(Element element)PropertygetNestedPropertyPathsProperty()java.util.List<java.lang.String>getPlotColor(Element element)PropertygetPlotColorProperty()SimulationProfile.DataRecordTypeEnumgetRecordPlotDataAs(Element element)PropertygetRecordPlotDataAsProperty()java.lang.IntegergetRefreshRate(Element element)PropertygetRefreshRateProperty()ElementgetRepresents(Element element)PropertygetRepresentsProperty()java.lang.StringgetResultFile(Element element)PropertygetResultFileProperty()java.lang.StringgetSource(Element element)PropertygetSourceProperty()StereotypegetStereotype()Returns stereotype for this wrapper.java.lang.StringgetTitle(Element element)PropertygetTitleProperty()java.util.List<Element>getValue(Element element)PropertygetValueProperty()java.lang.StringgetXLabel(Element element)PropertygetXLabelProperty()java.lang.StringgetYLabel(Element element)PropertygetYLabelProperty()booleanis(Element element)java.lang.BooleanisAnnotateFailures(Element element)java.lang.BooleanisDynamic(Element element)java.lang.BooleanisFixedRange(Element element)java.lang.BooleanisGridX(Element element)java.lang.BooleanisGridY(Element element)static booleanisInstance(Element element)java.lang.BooleanisKeepOpenAfterTermination(Element element)java.lang.BooleanisLinearInterpolation(Element element)voidremoveLoadCSVFile(Element element, java.lang.String value)voidremoveNestedPropertyPaths(Element element, java.lang.String value)voidremovePlotColor(Element element, java.lang.String value)voidremoveValue(Element element, Element value)voidsetAnnotateFailures(Element element, java.lang.Boolean value)voidsetDynamic(Element element, java.lang.Boolean value)voidsetFixedRange(Element element, java.lang.Boolean value)voidsetFixedTimeLength(Element element, java.lang.Integer value)voidsetFixedTimeLocation(Element element, java.lang.Integer value)voidsetGridX(Element element, java.lang.Boolean value)voidsetGridY(Element element, java.lang.Boolean value)voidsetKeepOpenAfterTermination(Element element, java.lang.Boolean value)voidsetLinearInterpolation(Element element, java.lang.Boolean value)voidsetLoadCSVFile(Element element, java.util.Collection<java.lang.String> value)voidsetMaxValue(Element element, java.lang.String value)voidsetMinValue(Element element, java.lang.String value)voidsetNestedPropertyPaths(Element element, java.util.Collection<java.lang.String> value)voidsetPlotColor(Element element, java.util.Collection<java.lang.String> value)voidsetRecordPlotDataAs(Element element, SimulationProfile.DataRecordTypeEnum value)voidsetRefreshRate(Element element, java.lang.Integer value)voidsetRepresents(Element element, Element value)voidsetResultFile(Element element, java.lang.String value)voidsetSource(Element element, java.lang.String value)voidsetTitle(Element element, java.lang.String value)voidsetValue(Element element, java.util.Collection<? extends Element> value)voidsetXLabel(Element element, java.lang.String value)voidsetYLabel(Element element, java.lang.String value)-
Methods inherited from class com.nomagic.profiles.ProfileImplementation.StereotypeWrapper
apply, isDerivedStereotype, isSameOrDerivedStereotype, unApply
-
-
-
-
Field Detail
-
STEREOTYPE_NAME
public static final java.lang.String STEREOTYPE_NAME
- See Also:
- Constant Field Values
-
DYNAMIC
public static final java.lang.String DYNAMIC
If true, open the histogram during multiple runs which shows dynamic results, otherwise open the histogram at the end of all runs completion.- See Also:
- Constant Field Values
-
FIXEDRANGE
public static final java.lang.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:
- Constant Field Values
-
MAXVALUE
public static final java.lang.String MAXVALUE
To specify an upper bound value of Y-axis.- See Also:
- Constant Field Values
-
MINVALUE
public static final java.lang.String MINVALUE
To specify a lower bound value of Y-axis.- See Also:
- Constant Field Values
-
REFRESHRATE
public static final java.lang.String REFRESHRATE
To specify a time interval to refresh a time series chart. The unit of refresh rate is specified by time unit tag definition of the execution config. If the time unit is unspecified, millisecond will be the unit of the refresh rate.- See Also:
- Constant Field Values
-
SOURCE
public static final java.lang.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:
- Constant Field Values
-
XLABEL
public static final java.lang.String XLABEL
Specify the label of x-axis of the chart.- See Also:
- Constant Field Values
-
ANNOTATEFAILURES
public static final java.lang.String ANNOTATEFAILURES
Annotate requirement and constraint failures on charts in red.- See Also:
- Constant Field Values
-
FIXEDTIMELENGTH
public static final java.lang.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:
- Constant Field Values
-
FIXEDTIMELOCATION
public static final java.lang.String FIXEDTIMELOCATION
Specify the starting time of the time axis shown in the time series chart. If the value is unspecified while the value of Fixed Time Length is specified, the time series 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:
- Constant Field Values
-
GRIDX
public static final java.lang.String GRIDX
To show or hide a vertical grid line.- See Also:
- Constant Field Values
-
GRIDY
public static final java.lang.String GRIDY
To show or hide a horizontal grid line.- See Also:
- Constant Field Values
-
KEEPOPENAFTERTERMINATION
public static final java.lang.String KEEPOPENAFTERTERMINATION
If true, the chart will keep open after termination of the simulation.- See Also:
- Constant Field Values
-
LINEARINTERPOLATION
public static final java.lang.String LINEARINTERPOLATION
If plot does (extra) interpolation or not is, it connecting 2 dots in time with a straight line or not.- See Also:
- Constant Field Values
-
LOADCSVFILE
public static final java.lang.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:
- Constant Field Values
-
PLOTCOLOR
public static final java.lang.String PLOTCOLOR
To specify a plot color.- See Also:
- Constant Field Values
-
RECORDPLOTDATAAS
public static final java.lang.String RECORDPLOTDATAAS
Results shall be saved to a file as a selected format, if Result File is specified.- See Also:
- Constant Field Values
-
RESULTFILE
public static final java.lang.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:
- Constant Field Values
-
TITLE
public static final java.lang.String TITLE
To specify the title of a time series chart.- See Also:
- Constant Field Values
-
YLABEL
public static final java.lang.String YLABEL
Specify the label of y-axis of the chart.- See Also:
- Constant Field Values
-
NESTEDPROPERTYPATHS
public static final java.lang.String NESTEDPROPERTYPATHS
Specify nested property paths- See Also:
- Constant Field Values
-
REPRESENTS
public static final java.lang.String REPRESENTS
Specify the classifier represented by the configuration.- See Also:
- Constant Field Values
-
VALUE
public static final java.lang.String VALUE
Structural feature which value should be represented for the configuration.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
HistogramStereotype
protected HistogramStereotype(SimulationProfile profile)
-
-
Method Detail
-
getStereotype
public Stereotype getStereotype()
Description copied from class:ProfileImplementation.StereotypeWrapperReturns stereotype for this wrapper.- Specified by:
getStereotypein classProfileImplementation.StereotypeWrapper- Returns:
- stereotype
-
getDynamicProperty
@CheckForNull public Property getDynamicProperty()
-
getFixedRangeProperty
@CheckForNull public Property getFixedRangeProperty()
-
getMaxValueProperty
@CheckForNull public Property getMaxValueProperty()
-
getMinValueProperty
@CheckForNull public Property getMinValueProperty()
-
getRefreshRateProperty
@CheckForNull public Property getRefreshRateProperty()
-
getSourceProperty
@CheckForNull public Property getSourceProperty()
-
getXLabelProperty
@CheckForNull public Property getXLabelProperty()
-
getAnnotateFailuresProperty
@CheckForNull public Property getAnnotateFailuresProperty()
-
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()
-
getPlotColorProperty
@CheckForNull public Property getPlotColorProperty()
-
getRecordPlotDataAsProperty
@CheckForNull public Property getRecordPlotDataAsProperty()
-
getResultFileProperty
@CheckForNull public Property getResultFileProperty()
-
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()
-
setDynamic
public void setDynamic(Element element, @CheckForNull java.lang.Boolean value)
-
clearDynamic
public void clearDynamic(Element element)
-
isDynamic
@CheckForNull public java.lang.Boolean isDynamic(Element element)
-
setFixedRange
public void setFixedRange(Element element, @CheckForNull java.lang.Boolean value)
-
clearFixedRange
public void clearFixedRange(Element element)
-
isFixedRange
@CheckForNull public java.lang.Boolean isFixedRange(Element element)
-
setMaxValue
public void setMaxValue(Element element, @CheckForNull java.lang.String value)
-
clearMaxValue
public void clearMaxValue(Element element)
-
getMaxValue
@CheckForNull public java.lang.String getMaxValue(Element element)
-
setMinValue
public void setMinValue(Element element, @CheckForNull java.lang.String value)
-
clearMinValue
public void clearMinValue(Element element)
-
getMinValue
@CheckForNull public java.lang.String getMinValue(Element element)
-
setRefreshRate
public void setRefreshRate(Element element, @CheckForNull java.lang.Integer value)
-
clearRefreshRate
public void clearRefreshRate(Element element)
-
getRefreshRate
@CheckForNull public java.lang.Integer getRefreshRate(Element element)
-
setSource
public void setSource(Element element, @CheckForNull java.lang.String value)
-
clearSource
public void clearSource(Element element)
-
getSource
@CheckForNull public java.lang.String getSource(Element element)
-
setXLabel
public void setXLabel(Element element, @CheckForNull java.lang.String value)
-
clearXLabel
public void clearXLabel(Element element)
-
getXLabel
@CheckForNull public java.lang.String getXLabel(Element element)
-
setAnnotateFailures
public void setAnnotateFailures(Element element, @CheckForNull java.lang.Boolean value)
-
clearAnnotateFailures
public void clearAnnotateFailures(Element element)
-
isAnnotateFailures
@CheckForNull public java.lang.Boolean isAnnotateFailures(Element element)
-
setFixedTimeLength
public void setFixedTimeLength(Element element, @CheckForNull java.lang.Integer value)
-
clearFixedTimeLength
public void clearFixedTimeLength(Element element)
-
getFixedTimeLength
@CheckForNull public java.lang.Integer getFixedTimeLength(Element element)
-
setFixedTimeLocation
public void setFixedTimeLocation(Element element, @CheckForNull java.lang.Integer value)
-
clearFixedTimeLocation
public void clearFixedTimeLocation(Element element)
-
getFixedTimeLocation
@CheckForNull public java.lang.Integer getFixedTimeLocation(Element element)
-
setGridX
public void setGridX(Element element, @CheckForNull java.lang.Boolean value)
-
clearGridX
public void clearGridX(Element element)
-
isGridX
@CheckForNull public java.lang.Boolean isGridX(Element element)
-
setGridY
public void setGridY(Element element, @CheckForNull java.lang.Boolean value)
-
clearGridY
public void clearGridY(Element element)
-
isGridY
@CheckForNull public java.lang.Boolean isGridY(Element element)
-
setKeepOpenAfterTermination
public void setKeepOpenAfterTermination(Element element, @CheckForNull java.lang.Boolean value)
-
clearKeepOpenAfterTermination
public void clearKeepOpenAfterTermination(Element element)
-
isKeepOpenAfterTermination
@CheckForNull public java.lang.Boolean isKeepOpenAfterTermination(Element element)
-
setLinearInterpolation
public void setLinearInterpolation(Element element, @CheckForNull java.lang.Boolean value)
-
clearLinearInterpolation
public void clearLinearInterpolation(Element element)
-
isLinearInterpolation
@CheckForNull public java.lang.Boolean isLinearInterpolation(Element element)
-
setLoadCSVFile
public void setLoadCSVFile(Element element, @CheckForNull java.util.Collection<java.lang.String> value)
-
clearLoadCSVFile
public void clearLoadCSVFile(Element element)
-
addLoadCSVFile
public void addLoadCSVFile(Element element, java.lang.String value)
-
removeLoadCSVFile
public void removeLoadCSVFile(Element element, java.lang.String value)
-
getLoadCSVFile
public java.util.List<java.lang.String> getLoadCSVFile(Element element)
-
setPlotColor
public void setPlotColor(Element element, @CheckForNull java.util.Collection<java.lang.String> value)
-
clearPlotColor
public void clearPlotColor(Element element)
-
addPlotColor
public void addPlotColor(Element element, java.lang.String value)
-
removePlotColor
public void removePlotColor(Element element, java.lang.String value)
-
getPlotColor
public java.util.List<java.lang.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)
-
setResultFile
public void setResultFile(Element element, @CheckForNull java.lang.String value)
-
clearResultFile
public void clearResultFile(Element element)
-
getResultFile
@CheckForNull public java.lang.String getResultFile(Element element)
-
setTitle
public void setTitle(Element element, @CheckForNull java.lang.String value)
-
clearTitle
public void clearTitle(Element element)
-
getTitle
@CheckForNull public java.lang.String getTitle(Element element)
-
setYLabel
public void setYLabel(Element element, @CheckForNull java.lang.String value)
-
clearYLabel
public void clearYLabel(Element element)
-
getYLabel
@CheckForNull public java.lang.String getYLabel(Element element)
-
setNestedPropertyPaths
public void setNestedPropertyPaths(Element element, @CheckForNull java.util.Collection<java.lang.String> value)
-
clearNestedPropertyPaths
public void clearNestedPropertyPaths(Element element)
-
addNestedPropertyPaths
public void addNestedPropertyPaths(Element element, java.lang.String value)
-
removeNestedPropertyPaths
public void removeNestedPropertyPaths(Element element, java.lang.String value)
-
getNestedPropertyPaths
public java.util.List<java.lang.String> getNestedPropertyPaths(Element element)
-
clearRepresents
public void clearRepresents(Element element)
-
setValue
public void setValue(Element element, @CheckForNull java.util.Collection<? extends Element> value)
-
clearValue
public void clearValue(Element element)
-
clear
protected void clear()
-
is
public boolean is(@CheckForNull Element element)
-
isInstance
public static boolean isInstance(@CheckForNull Element element)
-
-