ALTADataSet Class: Difference between revisions
Jump to navigation
Jump to search
John Leavitt (talk | contribs) No edit summary |
John Leavitt (talk | contribs) No edit summary |
||
Line 5: | Line 5: | ||
=== Constructors === | === Constructors === | ||
*'''[[Sub New]]''' {{ | *'''[[Sub New]]''' {{APIComment|Creates a new class that can be used to fit a model from ALTA raw data.}} | ||
<br> | <br> | ||
Line 11: | Line 11: | ||
<br> | <br> | ||
=== Properties === | === Properties === | ||
*'''[[DatasetName]]''' {{ | *'''[[DatasetName]]''' {{APIComment|Gets or set the name of the data set.}} | ||
*'''[[GeneralSettings]]''' {{ | *'''[[GeneralSettings]]''' {{APIComment|General settings used when fitting the model or finding the best fit.}} | ||
*'''[[AnalysisSettings]]''' {{ | *'''[[AnalysisSettings]]''' {{APIComment|Settings used when fitting the model.}} | ||
*'''[[FittedModel]]''' {{APIComment|Model, fitted from the raw data. See cModel class for the list of its methods below.}} | |||
*'''[[FittedModel]]''' {{ | *'''[[FailureCount]]''' {{APIComment|Total number of failures in the data set.}} | ||
*'''[[FailureCount]]''' {{ | *'''[[SuspensionCount]]''' {{APIComment|Total number of suspensions in the data set.}} | ||
*'''[[SuspensionCount]]''' {{ | *'''[[NumStresses]]''' {{APIComment|Returns the number of stresses in the data set.}} | ||
*'''[[StressRelation]]''' {{APIComment|Returns the number of stresses in the data set.}} | |||
*'''[[UseStress]]''' {{APIComment|Gets or sets use stress value for a particular stress. This value is used in subsequent calculations and plots.}} | |||
== Events == | |||
*'''[[WeibullEvents]]''' {{APIComment|Reference to a class that contains overridable methods for handling ALTA solver events.}} | |||
*'''[[New ALTAEvents]]''' {{APIComment|Reference to a class that contains overridable methods for handling ALTA solver events}} | |||
== Methods == | == Methods == | ||
*'''[[ClearDataSet]]''' {{ | *'''[[ClearDataSet]]''' {{APIComment|Clears all data and fitted model. All analysis settings stay unchanged.}} | ||
*'''[[AddFailure]]''' {{ | *'''[[AddStressDefinition]]''' {{Adds a stress definition (column). The number of stresses in subsequent calls to AddFailure, AddSuspension etc. must be equal to the number of stress definitions in the data set.}} | ||
*'''[[AddSuspension]]''' {{ | *'''[[NumStresses]]''' {{APIComment|Returns the number of stresses in the data set.}} | ||
*'''[[AddFailureInterval]]''' {{ | *'''[[StresRelation]]''' {{APIComment|Sets or returns life-stress relationship for a particular stress.}} | ||
*'''[[AddSuspensionInterval]]''' {{ | *'''[[UseStress]]''' {{APIComment|Sets or returns use stress value for a particular stress. This value is used in subsequent calculations and plots.}} | ||
*'''[[ | *'''[[AddStressProfile]]''' {{APIComment|Adds a stress profile to the data set. It then can be used as a stress for Cumulative Damage model.}} | ||
*'''[[ | *'''[[AddFailure Stress()]]''' {{APIComment|Adds a failure data point to the collection of data points in the data set.}} | ||
*'''[[ | *'''[[AddFailure Stress1]]''' {{APIComment|Adds a failure data point to the collection of data points in the data set.}} | ||
*'''[[AddFailure Stress1,Stress2]]''' {{APIComment|Adds a failure data point to the collection of data points in the data set.}} | |||
*'''[[AddSuspension Stress()]]''' {{APIComment|Adds a suspension data point to the collection of data points in the data set.}} | |||
*'''[[AddSuspension Stress1]]''' {{APIComment|Adds a suspension data point to the collection of data points in the data set.}} | |||
*'''[[AddSuspension Stress1,Stress2]]''' {{APIComment|Adds a suspension data point to the collection of data points in the data set.}} | |||
*'''[[AddFailureInterval Stress ()]]''' {{APIComment|Adds a failure interval data point to the collection of data points in the data set.}} | |||
*'''[[AddFailureInterval Stress1]]''' {{APIComment|Adds a failure interval data point to the collection of data points in the data set.}} | |||
*'''[[AddFailureInterval Stress1,Stress2]]''' {{APIComment|Adds a failure interval data point to the collection of data points in the data set.}} | |||
*'''[[AddSuspensionInterval Stress()]]''' {{APIComment|Adds a suspension interval data point to the collection of data points in the data set.}} | |||
*'''[[AddSuspensionInterval Stress1]]''' {{APIComment|Adds a suspension interval data point to the collection of data points in the data set.}} | |||
*'''[[AddSuspensionInterval Stress1,Stress2]]''' {{APIComment|Adds a suspension interval data point to the collection of data points in the data set.}} | |||
*'''[[Calculate]]''' {{APIComment|Fits a model from the raw data previously entered in the data set. Sets FittedModel property if successful. Clears it (sets to Nothing) in case of an error.}} |
Revision as of 18:46, 3 September 2013
Instantiate this class to be able to fit an ALTA model from your raw data.
Constructors
- Sub New Creates a new class that can be used to fit a model from ALTA raw data.
Properties
- DatasetName Gets or set the name of the data set.
- GeneralSettings General settings used when fitting the model or finding the best fit.
- AnalysisSettings Settings used when fitting the model.
- FittedModel Model, fitted from the raw data. See cModel class for the list of its methods below.
- FailureCount Total number of failures in the data set.
- SuspensionCount Total number of suspensions in the data set.
- NumStresses Returns the number of stresses in the data set.
- StressRelation Returns the number of stresses in the data set.
- UseStress Gets or sets use stress value for a particular stress. This value is used in subsequent calculations and plots.
Events
- WeibullEvents Reference to a class that contains overridable methods for handling ALTA solver events.
- New ALTAEvents Reference to a class that contains overridable methods for handling ALTA solver events
Methods
- ClearDataSet Clears all data and fitted model. All analysis settings stay unchanged.
- AddStressDefinition Template:Adds a stress definition (column). The number of stresses in subsequent calls to AddFailure, AddSuspension etc. must be equal to the number of stress definitions in the data set.
- NumStresses Returns the number of stresses in the data set.
- StresRelation Sets or returns life-stress relationship for a particular stress.
- UseStress Sets or returns use stress value for a particular stress. This value is used in subsequent calculations and plots.
- AddStressProfile Adds a stress profile to the data set. It then can be used as a stress for Cumulative Damage model.
- AddFailure Stress() Adds a failure data point to the collection of data points in the data set.
- AddFailure Stress1 Adds a failure data point to the collection of data points in the data set.
- AddFailure Stress1,Stress2 Adds a failure data point to the collection of data points in the data set.
- AddSuspension Stress() Adds a suspension data point to the collection of data points in the data set.
- AddSuspension Stress1 Adds a suspension data point to the collection of data points in the data set.
- AddSuspension Stress1,Stress2 Adds a suspension data point to the collection of data points in the data set.
- AddFailureInterval Stress () Adds a failure interval data point to the collection of data points in the data set.
- AddFailureInterval Stress1 Adds a failure interval data point to the collection of data points in the data set.
- AddFailureInterval Stress1,Stress2 Adds a failure interval data point to the collection of data points in the data set.
- AddSuspensionInterval Stress() Adds a suspension interval data point to the collection of data points in the data set.
- AddSuspensionInterval Stress1 Adds a suspension interval data point to the collection of data points in the data set.
- AddSuspensionInterval Stress1,Stress2 Adds a suspension interval data point to the collection of data points in the data set.
- Calculate Fits a model from the raw data previously entered in the data set. Sets FittedModel property if successful. Clears it (sets to Nothing) in case of an error.