ALTADataSet Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(99 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:APIClass|Global_ALTA|Global ALTA}}
{{Template:API}}{{Template:APIBreadcrumb}}<div style="border:1px solid #D0CDE8; background:#EEEDF7; border-radius:10px; width:auto; margin:0 0 1em 1em; padding:1em; float:right;"><span style="font-family:arial;font-size:5;color:#585858">Other Versions: [[ALTADataSet Class 10|Version 10]]</span></div>
Provides {{Template:ALTADataSet Class.Cmt}} <!--Also used in Synthesis_API_Reference-->  
{{Template:PlotsNote.Cmt}}


A usage example for this class is available [[ALTADataSet_Class_Example|here]].


== Constructors ==
<onlyinclude>Represents a data set for accelerated life testing data analysis. </onlyinclude>
*{{APIName|ALTADataSet()}} {{APIComment|Initializes a new instance of the ALTADataSet class with a system-supplied data set name.}}
*{{APIName|ALTADataSet(}} {{APIPrefix|ByVal}}{{APIName| Name }}{{APIPrefix|As String}}{{APIName|)}}{{APIComment|Initializes a new instance of the ALTADataSet class with a specified [[ALTADataSet.DatasetName|data set name]].}}
Parameters
:''Name'': The name of the data set.


== Methods  ==
==Constructor==
Use these methods to enter data points into a data sheet and analyze them. The settings for the analysis are specified with this class's properties.
{| {{APITable}}
|-
| style="width: 200px;"|ALTADataSet||Creates an instance of the ALTADataSet class.  
|-
|[[ALTADataSet_Constructors|ALTADataSet()]]||{{:ALTADataSet_Constructors}}
|}


'''Add/Remove Data'''
*'''[[ALTADataSet.AddFailure|AddFailure]]''' {{APIComment|{{Template:ALTADataSet.AddFailure.Cmt}}}}
*'''[[ALTADataSet.AddSuspension|AddSuspension]]''' {{APIComment|{{Template:ALTADataSet.AddSuspension.Cmt}}}}
*'''[[ALTADataSet.AddFailureInterval|AddFailureInterval]]''' {{APIComment|{{Template:ALTADataSet.AddFailureInterval.Cmt}}}}
*'''[[ALTADataSet.AddSuspensionInterval|AddSuspensionInterval]]'''{{APIComment|{{Template:ALTADataSet.AddSuspensionInterval.Cmt}}}}
*'''[[ALTADataSet.AddStressDefinition|AddStressDefinition]]''' {{APIComment|{{Template:ALTADataSet.AddStressDefinition.Cmt}}}}
*'''[[ALTADataSet.AddStressProfile|AddStressProfile]]''' {{APIComment|{{Template:ALTADataSet.AddStressProfile.Cmt}}}}
*'''[[ALTADataSet.ClearDataSet|ClearDataSet]]''' {{APIComment|{{Template:WeibullDataSet.ClearDataSet.Cmt}}}}


'''Analyze Data'''
==Method==
*'''[[ALTADataSet.Calculate|Calculate]]''' {{APIComment|{{Template:ALTADataSet.Calculate.Cmt}}}}
{| {{APITable}}
|-
| style="width: 200px;"|[[ALTADataSet.AddFailure|AddFailure]]||{{:ALTADataSet.AddFailure}}
|-
|[[ALTADataSet.AddFailureInterval|AddFailureInterval]]||{{:ALTADataSet.AddFailureInterval}}
|-
|[[ALTADataSet.AddFreeForm|AddFreeForm]]||{{:ALTADataSet.AddFreeForm}}
|-
|[[ALTADataSet.AddStressDefinition|AddStressDefinition]]||{{:ALTADataSet.AddStressDefinition}}
|-
|[[ALTADataSet.AddStressProfile|AddStressProfile]]||{{:ALTADataSet.AddStressProfile}}
|-
|[[ALTADataSet.AddSuspension|AddSuspension]]||{{:ALTADataSet.AddSuspension}}
|-
|[[ALTADataSet.AddSuspensionInterval|AddSuspensionInterval]]||{{:ALTADataSet.AddSuspensionInterval}}
|-
|[[ALTADataSet.Calculate|Calculate]]||{{:ALTADataSet.Calculate}}
|-
|[[ALTADataSet.ClearDataSet|ClearDataSet]]||{{:ALTADataSet.ClearDataSet}}
|}


== Properties  ==
Use these properties to specify analysis settings and view analysis results, as well as view or edit properties of the data set.


'''Analysis Settings'''
==Properties==
*'''[[ALTADataSet.AnalysisSettings|AnalysisSettings]]''' {{APIComment|{{Template:ALTADataSet.AnalysisSettings.Cmt}}}}
{| {{APITable}}
*'''[[ALTADataSet.GeneralSettings|GeneralSettings]]''' {{APIComment|{{Template:ALTADataSet.GeneralSettings.Cmt}}}}
|-
*'''[[ALTADataSet.PlotUseStress|PlotUseStress]]''' {{APIComment|{{Template:ALTADataSet.PlotUseStress.Cmt}}}}
| style="width: 200px;"|AnalysisResults||Gets the '''[[ALTAAnalysisResults_Class|ALTAAnalysisResults]]''' object that represents the likelihood function value estimated from the accelerated life testing data analysis.
*'''[[ALTADataSet.StressRelation|StressRelation]]''' {{APIComment|{{Template:ALTADataSet.StressRelation.Cmt}}}}
|-
|Calculated||Indicates whether the data set has been analyzed. '''Boolean'''. Read only.
|-
|DatasetName||Gets or sets the name of the data set. '''String'''. If no name has been specified, the default name is "Set 1."
|-
|FailureCount|| Gets the total number of failures in the data set. '''Integer'''.
|-
|FittedModel||References the '''[[cModel Class|cModel]]''' object that represents the fitted model of the accelerated life testing data analysis. From the cModel object, you can obtain results such as the reliability, mean time, failure rate, etc.  
|-
|NumStresses||Gets the total number of stresses in the data set. '''Integer'''.
|-
|[[ALTADataSet.PlotUseStress|PlotUseStress]]||{{:ALTADataSet.PlotUseStress}}  
|-
|StressRelation(''Index'')||Gets or sets a value from the '''[[ALTASolverLSR_Enumeration|ALTASolverLSR]]''' enumeration, which specifies the stress transformation of a particular stress. Default value = 0 (exponential life-stress relationship). The ''Index'' parameter is an integer that specifies the stress index, where 0 = first stress, 1 = second stress, etc. This property applies to the general log-linear (GLL) or cumulative damage (CD) model only.
|-
|SuspensionCount||Gets the total number of suspensions in the data set. '''Integer'''.
|-
|UseCalculationProgress||Indicates whether to display the progress bar while analyzing the data set. '''Boolean'''. Default value = True.
|-
|UseEvents||Indicates whether to enable user-defined event procedures for the <code>ALTADataSet</code> object. '''Boolean'''. Default value = False.
|}


'''Analysis Results'''
*'''[[ALTADataSet.FittedModel|FittedModel]]''' {{APIComment|{{Template:ALTADataSet.FittedModel.Cmt}}}}
*'''[[ALTADataSet.AnalysisResults|AnalysisResults]]''' {{APIComment|{{Template:ALTADataSet.AnalysisResults.Cmt}}}}


'''Data Set Properties'''
==Fields==
*'''[[ALTADataSet.DatasetName|DatasetName]]''' {{APIComment|{{Template:ALTADataSet.DatasetName.Cmt}}}}
{| {{APITable}}
*'''[[ALTADataSet.FailureCount|FailureCount]]''' {{APIComment|{{Template:ALTADataSet.FailureCount.Cmt}}}}
|-
*'''[[ALTADataSet.SuspensionCount|SuspensionCount]]''' {{APIComment|{{Template:ALTADataSet.SuspensionCount.Cmt}}}}
| style="width: 200px;"|AnalysisSettings||References the '''[[ALTAAnalysisOptions_Class|ALTAAnalysisOptions]]''' object, which represents the analysis settings of the accelerated life testing data analysis. Read-Only.
*'''[[ALTADataSet.NumStresses|NumStresses]]''' {{APIComment|{{Template:ALTADataSet.NumStresses.Cmt}}}}
|-
|GeneralSettings||References the '''[[ALTAGeneralOptions_Class|ALTAGeneralOptions]]''' object, which represents the calculation settings for the cumulative damage life-stress model. Read-Only.
|}


== Events ==
 
*'''[[ALTAEvents Class]]''' {{APIComment|{{Template:ALTAEvents Class.Cmt}}}}<br>
==Events==
{| {{APITable}}
|-
| style="width: 200px;"|[[ALTADataSet.HideCalculationProgress|HideCalculationProgress]]||{{:ALTADataSet.HideCalculationProgress}}
|-
|[[ALTADataSet.Message|Message]]||{{:ALTADataSet.Message}}
|-
|[[ALTADataSet.ShowCalculationProgress|ShowCalculationProgress]]||{{:ALTADataSet.ShowCalculationProgress}}
|-
|[[ALTADataSet.UpdateCalculationProgress|UpdateCalculationProgress]]||{{:ALTADataSet.UpdateCalculationProgress}}
|}

Latest revision as of 17:11, 12 March 2019

APIWiki.png


Member of: SynthesisAPI

Other Versions: Version 10


Represents a data set for accelerated life testing data analysis.

Constructor

Name Description
ALTADataSet Creates an instance of the ALTADataSet class.
ALTADataSet() A parameterized constructor for the ALTADataSet class (.NET only)


Method

Name Description
AddFailure Adds a failure time to the data set.
AddFailureInterval Adds interval censored failures to the data set.
AddFreeForm Adds a failure time at the specified percent to the data set.
AddStressDefinition Adds a stress type to the data set.
AddStressProfile Adds a cProfile object, which represents a time-dependent stress profile, to the data set. Applies to the cumulative damage (CD) model only.
AddSuspension Adds suspensions to the data set.
AddSuspensionInterval Adds interval censored suspensions to the data set.
Calculate Fits a life distribution and life-stress relationship to the current data set, and creates a cModel object that represents the fitted model.
ClearDataSet Clears all data in the data set and removes the fitted model, if any.


Properties

Name Description
AnalysisResults Gets the ALTAAnalysisResults object that represents the likelihood function value estimated from the accelerated life testing data analysis.
Calculated Indicates whether the data set has been analyzed. Boolean. Read only.
DatasetName Gets or sets the name of the data set. String. If no name has been specified, the default name is "Set 1."
FailureCount Gets the total number of failures in the data set. Integer.
FittedModel References the cModel object that represents the fitted model of the accelerated life testing data analysis. From the cModel object, you can obtain results such as the reliability, mean time, failure rate, etc.
NumStresses Gets the total number of stresses in the data set. Integer.
PlotUseStress Sets the use stress value to be plotted (does not affect results of calculations). Double. The Index parameter is an integer that specifies the stress index, where 0 = first stress, 1 = second stress, etc.
StressRelation(Index) Gets or sets a value from the ALTASolverLSR enumeration, which specifies the stress transformation of a particular stress. Default value = 0 (exponential life-stress relationship). The Index parameter is an integer that specifies the stress index, where 0 = first stress, 1 = second stress, etc. This property applies to the general log-linear (GLL) or cumulative damage (CD) model only.
SuspensionCount Gets the total number of suspensions in the data set. Integer.
UseCalculationProgress Indicates whether to display the progress bar while analyzing the data set. Boolean. Default value = True.
UseEvents Indicates whether to enable user-defined event procedures for the ALTADataSet object. Boolean. Default value = False.


Fields

Name Description
AnalysisSettings References the ALTAAnalysisOptions object, which represents the analysis settings of the accelerated life testing data analysis. Read-Only.
GeneralSettings References the ALTAGeneralOptions object, which represents the calculation settings for the cumulative damage life-stress model. Read-Only.


Events

Name Description
HideCalculationProgress Occurs when the calculation process is running. Hides the progress bar.
Message Occurs when an error is produced. Displays an error message.
ShowCalculationProgress Occurs when the calculation process is running. Displays a progress bar.
UpdateCalculationProgress Occurs when the calculation process is running. Displays messages regarding the progress of the calculations.
Retrieved from "https://www.reliawiki.com/index.php?title=ALTADataSet_Class&oldid=65437"