WAPlots Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:APIClass|Global_Plots|Global Plots}}
{{Template:API}}{{Template:APIBreadcrumb}}


{{Template:WAPlots Class.Cmt}}
 
Represents a plot based on a [[CModel Class|cModel]], [[WeibullDataSet Class|WeibullDataSet]], or [[ALTADataSet Class|ALTADataSet]] object.


== Constructors==
== Constructors==
*'''[[New WAPlots]]''' {{APIComment|Create an Weibull or ALTA plot Class.}}
{| {{APITable}}
|-
| style="width: 180px;"|WAPlots||Creates an instance of the WAPlots class.
|}
 


== Methods  ==
== Methods  ==
*'''[[WAPlots.Clear|Clear]]''' {{APIComment|Removes all data sets from plotting collection.}}
{| {{APITable}}
*'''[[WAPlots.AddDataset|AddDataset]]''' {{APIComment|Adds Weibull or ALTA data set for subsequent plotting.}}
|-
*'''[[WAPlots.CreatePlot|CreatePlot]]''' {{APIComment|Creates a bitmap containing the plot image.}}
| style="width: 180px;"|[[WAPlots.AddDataset|AddDataset]]||{{:WAPlots.AddDataset}}
*'''[[WAPlots.CreatePlotVB6|CreatePlotVB6]]''' {{APIComment|For VB6/VBA users only - use it instead of CreatePlot. Returns the picture containing the image of the plot.}}
|-
|[[WAPlots.AddModel|AddModel]]||{{:WAPlots.AddModel}}
|-
|[[WAPlots.Clear|Clear]]||{{:WAPlots.Clear}}
|-
|[[WAPlots.CreatePlot|CreatePlot]]||{{:WAPlots.CreatePlot}}
|-
|[[WAPlots.CreatePlotVB6|CreatePlotVB6]]||{{:WAPlots.CreatePlotVB6}}
|}
 


== Properties ==
== Properties ==
*'''[[WAPlots.ErrorHappened|ErrorHappened]]''' {{APIComment|Whether an error happened during the last plotting.}}
{| {{APITable}}
*'''[[WAPlots.ErrorMessage|ErrorMessage]]''' {{APIComment|The error that happened during the last plotting. Only set if ErrorHappened returns true.}}
|-
 
| style="width: 180px;"|ErrorHappened||Indicates whether an error occurred during the creation of the plot. '''Boolean'''. Read-only.
== Formatted Usage Example ==
|-
{{APIComment|Create a new Weibull/ALTA Plot instance. See [[WAPlots.CreatePlot|CreatePlot]] for additional details.}}
|ErrorMessage||Gets the description of the error that occurred during the creation of the plot. Applies only if <code>ErrorHappened</code> is true. '''String'''.
        Dim WeibullALTAPlot As New WAPlots
|}
 
{{APIComment|Declare a WeibullDataSet. See [[New WeibullDataSet]] for additional details.}}
        Dim WDS As New WeibullDataSet
 
{{APIComment|Add values to the raw data. See [[WeibullDataSet.AddFailure|AddFailure]] for additional details.}}
        WDS.AddFailure(1, 1)
        WDS.AddFailure(2, 1)
        WDS.AddFailure(3, 1)
 
{{APIComment|Add the WeibullDataSet to the WAPlots. See [[WeibullDataSet Class.New WeibulDataSet|New WeibulDataSet]] for additional details.}}
        WeibullALTAPlot.AddDataset(WDS)
 
{{APIComment|Create the WAPlot.  In this example, it will create a Probability plot. See [[WAPlotType|WAPlotType]] for additional details.}}
        Dim FinalPlot As Bitmap = WeibullALTAPlot.CreatePlot(WAPlotType.Probability)
 
{{APIComment|If there were any issues creating the plot, [[WAPlots.ErrorHappened|ErrorHappened]] would be True, and ErrorString will display the reason.}}
        Dim ErrorString as String
        If WeibullALTAPlot.[[WAPlots.ErrorHappened|ErrorHappened]] Then
            ErrorString = '''WeibullALTAPlot.ErrorMessage'''
        End If

Latest revision as of 15:25, 6 July 2016

APIWiki.png


Member of: SynthesisAPI


Represents a plot based on a cModel, WeibullDataSet, or ALTADataSet object.

Constructors

Name Description
WAPlots Creates an instance of the WAPlots class.


Methods

Name Description
AddDataset Adds a WeibullDataSet or ALTADataSet object to the plot.
AddModel Adds a cModel object to the plot.
Clear Removes the object that was added to the plot, which is required before a new object can be added.
CreatePlot Returns a bitmap object that represents the plot. (.NET only)
CreatePlotVB6 Returns a bitmap object that represents the plot. (VBA/VB6 only.)


Properties

Name Description
ErrorHappened Indicates whether an error occurred during the creation of the plot. Boolean. Read-only.
ErrorMessage Gets the description of the error that occurred during the creation of the plot. Applies only if ErrorHappened is true. String.
Retrieved from "https://www.reliawiki.com/index.php?title=WAPlots_Class&oldid=64449"