RawDataSet Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(20 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb|9}}
{{Template:API}}{{Template:APIBreadcrumb}}




<onlyinclude>Represents a Synthesis Data Warehouse (SDW) data collection, which contains data points (represented by [[RawData Class|RawData]] objects).</onlyinclude>  
<onlyinclude>Represents a Synthesis Data Warehouse (SDW) data collection.</onlyinclude>  
 
Applies to Weibull++, ALTA and RGA only. You can view a list of all available data collections in a repository by choosing '''Home > Synthesis Synthesis Data Warehouse'''. (In Version 9, this is '''Project > Synthesis  > XFRACAS to RDW'''.)


==Constructor==
==Constructor==
{| {{APITable}}
{| {{APITable}}
!Name
!Description
|-
|-
| style="width: 150px;"|RawDataSet||Creates an instance of the RawDataSet class.
| style="width: 150px;"|RawDataSet||Creates an instance of the RawDataSet class.
Line 17: Line 13:
== Methods ==
== Methods ==
{| {{APITable}}
{| {{APITable}}
!Name
!Description
|-
|-
| style="width: 150px;"|[[RawDataSet.AddDataRow|AddDataRow]]||{{:RawDataSet.AddDataRow}}
| style="width: 150px;"|[[AddDataRow Method|AddDataRow]]||{{:AddDataRow Method}}
|-
|-
|Clear||Clears all data points saved in the RawDataSet object.
|Clear||Clears all data points saved in the RawDataSet object.
Line 28: Line 22:
== Properties ==
== Properties ==
{| {{APITable}}
{| {{APITable}}
!Name
!Description
|-
|-
| style="width: 150px;"|ExtractedName||''String''. The name of the SDW data collection.
| style="width: 150px;"|ExtractedBy||Gets or sets the display name of the database user who brought the data collection into the SDW. '''String'''.  
|-
|ExtractedDate||Gets or sets the date when the data collection was brought into the SDW. '''Date'''.
|-
|-
|ExtractedDate||''Date''. The date when the data set was extracted.
|ExtractedName||Gets or sets the name of the data collection. '''String'''.  
|-
|-
|ExtractedBy||''String''. The name of the person who extracted the data set.
|ExtractedType||Gets or sets a value from the '''[[RawDataSetType Enumeration|RawDataSetType]]''' enumeration, which specifies whether the data set is for use with Weibull++ or RGA. Default value = 1 (use with Weibull++).
|-
|-
|ExtractedType||Gets or sets one of the constants of the '''[[AnalyticalDataSetType Enumeration|AnalyticalDataSetType]]''' enumeration, which specifies whether the data set is for use with Weibull++ or RGA.
|SourceID||Gets or sets the numeric ID of the data set. '''Integer'''.
|}
|}




== Example ==
This usage example demonstrates how to create a simple raw data set and add it to a repository's Synthesis Data Warehouse (SDW).


{{APIComment|'Create a new RawDataSet object.}}
 
  Dim rawDS As New RawDataSet
 
==See Also==
{{APIComment|'Give rawDS a name and specify that it is for use with Weibull++.}}
*[[Repository.DataWarehouse.SaveRawDataSet]]
  rawDS.ExtractedName = "Example for RDW"
  rawDS.ExtractedType = RawDataSetType.Weibull
{{APIComment|'Create two new RawData objects, each containing a failure time. See [[RawData Class|RawData]].}}
  Dim row1 As New RawData
  row1.StateFS = "F"
  row1.StateTime = "100"
  Dim row2 As New RawData
  row2.StateFS = "F"
  row2.StateTime = "120"
{{APIComment|'Add the two failure times as two rows in rawDS.}}
  rawDS.AddDataRow(row1)
  rawDS.AddDataRow(row2)
{{APIComment|'Connect to a Synthesis repository. See [[Repository Class|Repository]].}}
  Dim MyRepository As New Repository
  MyRepository.ConnectToRepository("C:\Users\ckahn\Documents\ReliaSoft\Files\APITesting.rsr9")
 
{{APIComment|'Add rawDS to the Raw Data Warehouse in the repository.}}
  MyRepository.SaveRawDataSet(rawDS)
{{APIComment|'Disconnect from repository.}}
  MyRepository.DisconnectFromRepository()

Latest revision as of 22:21, 29 April 2016

APIWiki.png


Member of: SynthesisAPI


Represents a Synthesis Data Warehouse (SDW) data collection.

Constructor

Name Description
RawDataSet Creates an instance of the RawDataSet class.


Methods

Name Description
AddDataRow Adds a new RawData object, which represents a data point, to the SDW data collection.
Clear Clears all data points saved in the RawDataSet object.


Properties

Name Description
ExtractedBy Gets or sets the display name of the database user who brought the data collection into the SDW. String.
ExtractedDate Gets or sets the date when the data collection was brought into the SDW. Date.
ExtractedName Gets or sets the name of the data collection. String.
ExtractedType Gets or sets a value from the RawDataSetType enumeration, which specifies whether the data set is for use with Weibull++ or RGA. Default value = 1 (use with Weibull++).
SourceID Gets or sets the numeric ID of the data set. Integer.



See Also