Difference between revisions of "WAPlots.AddDataset"

From ReliaWiki
Jump to navigation Jump to search
m
 
(15 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:APIClass|WAPlots Class|WAPlots}}
+
{{Template:API}}{{Template:APIBreadcrumb|.[[WAPlots_Class|WAPlots]]}}
Add a WeibullDataSet or ALTADataSet to the WAPlot Class.
 
  
  
== Weibull Declaration  ==
+
<onlyinclude>Adds a [[WeibullDataSet Class|WeibullDataSet]] or [[ALTADataSet Class|ALTADataSet]] object to the plot.</onlyinclude>
  
{{APIName|AddDataSet(}}
 
{{APIPrefix|ByVal}}
 
{{APIName|DataSet}}
 
{{APIPrefix|As}}
 
{{APIName|[[WeibullDataSet]] )}}
 
  
{{APIComment|Adds Weibull data set for subsequent plotting.}}
+
'''Remarks''': Before adding the <code>WeibullDataSet</code> object to the plot, it must first be analyzed by using the [[WeibullDataSet.Calculate]] method; otherwise, the plot cannot be generated. Similarly, the <code>ALTADataSet</code> object must first be analyzed using the [[ALTADataSet.Calculate]] method.  
  
== ALTA Declaration  ==
+
== Syntax ==
 +
'''.AddDataSet'''(''DataSet'')
  
{{APIName|AddDataSet(}}
+
===Parameters===
{{APIPrefix|ByVal}}
+
''DataSet''
{{APIName|DataSet}}
+
:Required. The [[WeibullDataSet Class|WeibullDataSet]] or [[ALTADataSet Class|ALTADataSet]] object that the plot will be based on.
{{APIPrefix|As}}
 
{{APIName|[[ALTADataSet]] )}}
 
  
{{APIComment|Adds ALTA data set for subsequent plotting.}}
+
== Example ==
  
== Parameters ==
+
'''VBA'''
'''DataSet'''
+
The variable name of the WeibullDataSet or ALTADataSet object to add to the collection.
+
{{APIComment|'Declare a WeibullDataSet object.}}
 +
  {{APIPrefix|Dim}} WDS {{APIPrefix|As New}} WeibullDataSet
 +
 
 +
{{APIComment|'Add failures to the data set.}}
 +
  {{APIPrefix|Call}} WDS.AddFailure(1, 1)
 +
  {{APIPrefix|Call}} WDS.AddFailure(2, 1)
 +
  {{APIPrefix|Call}} WDS.AddFailure(3, 1)
 +
 +
{{APIComment|'Analyze the data set.}} 
 +
  {{APIPrefix|Call}} WDS.Calculate
 +
 +
{{APIComment|'Declare a new WAPlots object.}}
 +
  {{APIPrefix|Dim}} WeibullALTAPlot {{APIPrefix|As New}} WAPlots
 +
 +
{{APIComment|'Add the data set to the plot.}}
 +
  WeibullALTAPlot.AddDataset(WDS)
  
== Usage Example ==
+
'''VB.NET'''
{{APIComment|Create a new Weibull/ALTA Plot instance.}}
+
        Dim WeibullALTAPlot As New WAPlots
+
{{APIComment|'Declare a WeibullDataSet object.}}
 
+
  {{APIPrefix|Dim}} WDS {{APIPrefix|As New}} WeibullDataSet
{{APIComment|Declare a WeibullDataSet. See [[New WeibullDataSet]] for additional details.}}
+
 
        Dim WDS as New WeibullDataSet
+
{{APIComment|'Add failures to the data set.}}
 
+
  WDS.AddFailure(1, 1)
{{APIComment|Add values to the raw data. See [[WeibullDataSet.AddFailure]] for additional details.}}
+
  WDS.AddFailure(2, 1)
        WDS.AddFailure(1, 1)
+
  WDS.AddFailure(3, 1)
        WDS.AddFailure(2, 1)
+
 
        WDS.AddFailure(3, 1)
+
{{APIComment|'Analyze the data set.}} 
 
+
  WDS.Calculate
{{APIComment|Add the WeibullDataSet to the WAPlots.}}
+
        '''WeibullALTAPlot.AddDataset(WDS)'''
+
{{APIComment|'Declare a new WAPlots object.}}
 +
  {{APIPrefix|Dim}} WeibullALTAPlot {{APIPrefix|As New}} WAPlots
 +
 +
{{APIComment|'Add the data set to the plot.}}
 +
  WeibullALTAPlot.AddDataset(WDS)

Latest revision as of 00:56, 7 September 2016

APIWiki.png


Member of: SynthesisAPI.WAPlots


Adds a WeibullDataSet or ALTADataSet object to the plot.


Remarks: Before adding the WeibullDataSet object to the plot, it must first be analyzed by using the WeibullDataSet.Calculate method; otherwise, the plot cannot be generated. Similarly, the ALTADataSet object must first be analyzed using the ALTADataSet.Calculate method.

Syntax

.AddDataSet(DataSet)

Parameters

DataSet

Required. The WeibullDataSet or ALTADataSet object that the plot will be based on.

Example

VBA

 'Declare a WeibullDataSet object. 
  Dim WDS As New WeibullDataSet
 
 'Add failures to the data set. 
  Call WDS.AddFailure(1, 1)
  Call WDS.AddFailure(2, 1)
  Call WDS.AddFailure(3, 1)

 'Analyze the data set.   
  Call WDS.Calculate

 'Declare a new WAPlots object. 
  Dim WeibullALTAPlot As New WAPlots

 'Add the data set to the plot. 
  WeibullALTAPlot.AddDataset(WDS)
VB.NET

 'Declare a WeibullDataSet object. 
  Dim WDS As New WeibullDataSet
 
 'Add failures to the data set. 
  WDS.AddFailure(1, 1)
  WDS.AddFailure(2, 1)
  WDS.AddFailure(3, 1)
  
 'Analyze the data set.   
  WDS.Calculate

 'Declare a new WAPlots object. 
  Dim WeibullALTAPlot As New WAPlots

 'Add the data set to the plot. 
  WeibullALTAPlot.AddDataset(WDS)