RawData Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 12: Line 12:


== Properties  ==
== Properties  ==
'''Failure Data'''
 
{| {{APITable}}
{| {{APITable}}
|-
|-
| style="width: 170px;"|StateFS||Sets or gets whether the data point is a failure ("F") or suspension ("S"), equivalent to the "State F or S" column in a Weibull++ folio with suspensions. '''String'''.  
| style="width: 170px;"|AddressLocation||Gets or sets the Address Location of this RawData; equivalent to the Address Location field in an XFRACAS Contact. '''String'''.
|-
|Category||Sets or gets the category of this RawData; equivalent to the Category field in an XFRACAS incident. '''String'''.
|-
|Chargeable||Sets or gets the chargeable code value (0,1) for this RawData; equivalent to the Category Chargeable and Category Non-Chargeable Lookup Lists in the XFRACAS Admin configuration List. This is to be used to calculate the failure state (StateFS). XFRACAS categories can also be viewed within an XFRACAS Incident. '''Integer'''.
|-
|CompanyOwner||Sets or gets the company owner of this RawData; equivalent to the Company filed in an XFRACAS Contact. '''String'''.
|-
|IsLRU||Sets or gets the line replaceable unit (LRU) of this RawData. '''Integer'''.
|-
|ReportType||Sets or gets the report type the of this RawData; equivalent to the Report Type field in an XFRACAS incident. '''String'''.
|-
|RootCause||Sets or gets the RootCause assigned to the resource. '''String'''.
|-
|TimeMetric||Sets or gets the TimeMetric code value of RawData; equivalent to the Time Metric fields in an XFRACAS incident. '''Integer'''.
|-
| style="border-bottom:1pt solid #585858; color:#585858;"|
|-
|-
|StateTime||Sets or gets the failure/suspension time, equivalent to the "Time to F or S" or "Time Failed" columns in a Weibull++ folio. '''Double'''.  
|NumberInState||For grouped failure data, gets or sets the number of failed units in a group. '''Double'''.
|-
|-
|StateTimeRestore||Sets or gets the StateTimeRestore assigned to the resource. '''Double'''.
|FailureMode||Gets or sets the description of the failure mode. '''String'''.
|-
|LastInspectedTime||For interval or left-censored data, gets or sets the time of last inspection. '''Double'''.
|-
|StateFS||Gets or sets whether the data point is a failure ("F") or suspension ("S"). '''String'''.  
|-
|-
|LastInspectedTime||Sets or gets the time of last inspection, equivalent to the "Last Inspected" column in a Weibull++ folio with interval censored data. '''Double'''.
|StateTime||Gets or sets the time-to-failure or time-to-suspension of the data point. '''Double'''.  
|-
|-
|NumberInState||Sets or gets the number of data points in a group, equivalent to the "Number in State" column in a Weibull++ folio with grouped data. '''Double'''.
|StateTimeRestore||Sets or gets the StateTimeRestore assigned to the resource. '''Double'''.
|-
|-
|FailureMode||Sets or gets the failure mode, equivalent to the Failure Mode field in an XFRACAS incident. '''String'''.
| style="border-bottom:1pt solid #585858; color:#585858;"|
|}
 
 
'''Incident'''
{| {{APITable}}
|-
|-
| style="width: 170px;"|IncidentAction||Sets or gets the IncidentAction the resource belongs to and allows the user to see what action occurred within the incident to a part or resource. '''String'''.
|IncidentAction||Sets or gets the IncidentAction the resource belongs to and allows the user to see what action occurred within the incident to a part or resource. '''String'''.
|-
|-
|IncidentEntityDisplayID||Sets or gets the IncidentEntityDisplayID the resource belongs to by showing the incident record prefix along with the incident display ID. '''String'''.
|IncidentEntityDisplayID||Sets or gets the IncidentEntityDisplayID the resource belongs to by showing the incident record prefix along with the incident display ID. '''String'''.
Line 43: Line 58:
|-
|-
|IncidentResolution||Sets or gets the incident resolution of this RawData; equivalent to the Incident Resolution field in an XFRACAS incident. '''String'''.
|IncidentResolution||Sets or gets the incident resolution of this RawData; equivalent to the Incident Resolution field in an XFRACAS incident. '''String'''.
|}
'''Parent Part'''
{| {{APITable}}
|-
|-
| style="width: 170px;"|ParentPartID||Sets or gets the part's parent ID of this RawData; equivalent to the Part Part ID field in an XFRACAS system. '''Integer'''.
| style="border-bottom:1pt solid #585858; color:#585858;"|
|-
|ParentPartID||Sets or gets the part's parent ID of this RawData; equivalent to the Part Part ID field in an XFRACAS system. '''Integer'''.
|-
|-
|ParentPartName||Sets or gets the part's parent's name of this RawData; equivalent to the ParentParentName field in an XFRACAS incident. '''String'''.
|ParentPartName||Sets or gets the part's parent's name of this RawData; equivalent to the ParentParentName field in an XFRACAS incident. '''String'''.
Line 56: Line 68:
|-
|-
|ParentPartVersion||Sets or gets the part's parent part version of this RawData; equivalent to the Parent Part Version field in an XFRACAS system. '''String'''.
|ParentPartVersion||Sets or gets the part's parent part version of this RawData; equivalent to the Parent Part Version field in an XFRACAS system. '''String'''.
|}
'''Part'''
{| {{APITable}}
|-
|-
| style="width: 170px;"|PartHID||Sets or gets the part hierarchy identification number of this RawData; equivalent to the HID field in XFRACAS system information. '''Integer'''.
| style="border-bottom:1pt solid #585858; color:#585858;"|
|-
|PartHID||Sets or gets the part hierarchy identification number of this RawData; equivalent to the HID field in XFRACAS system information. '''Integer'''.
|-
|-
|PartID||Sets or gets the part ID the of this RawData; equivalent to the Part ID field in an XFRACAS incident. '''Integer'''.
|PartID||Sets or gets the part ID the of this RawData; equivalent to the Part ID field in an XFRACAS incident. '''Integer'''.
Line 79: Line 88:
|-
|-
|PartVersion||Sets or gets the part version of this RawData; equivalent to the Version field in an XFRACAS incident. '''String'''.
|PartVersion||Sets or gets the part version of this RawData; equivalent to the Version field in an XFRACAS incident. '''String'''.
|}
'''Top Level'''
{| {{APITable}}
|-
|-
| style="width: 170px;"|TopLevelCommissionDate||Sets or gets the selected part/resource's top level commission date. '''Date'''.
| style="border-bottom:1pt solid #585858; color:#585858;"|
|-
|TopLevelCommissionDate||Sets or gets the selected part/resource's top level commission date. '''Date'''.
|-
|-
|TopLevelPartID||Sets or gets the part's top level part ID the of this RawData; equivalent to the Top Level Part ID field in an XFRACAS system. '''Integer'''.
|TopLevelPartID||Sets or gets the part's top level part ID the of this RawData; equivalent to the Top Level Part ID field in an XFRACAS system. '''Integer'''.
Line 98: Line 104:
|-
|-
|TopLevelSerialNumber||The part serial number of the top level parent. This is used by RGA to distinguish the system in that the failure occurred and in Weibull to distinguish the potentially different Top Level systems in that the failure state (State FS) occurred. This property is equivalent to the part's parent's serial number in an XFRACAS system. '''String'''.
|TopLevelSerialNumber||The part serial number of the top level parent. This is used by RGA to distinguish the system in that the failure occurred and in Weibull to distinguish the potentially different Top Level systems in that the failure state (State FS) occurred. This property is equivalent to the part's parent's serial number in an XFRACAS system. '''String'''.
|}
'''User-Defined Fields'''
{| {{APITable}}
|-
| style="width: 170px;"|DateUDF1||Sets or gets a user-defined date field of this RawData row; equivalent to one of the configurable settings fields in XFRACAS. '''Date'''.
|-
|DateUDF2||Sets or gets a user-defined date field of this RawData row; equivalent to one of the configurable settings fields in XFRACAS. '''Date'''.
|-
|DateUDF3||Sets or gets a user-defined date field of this RawData row; equivalent to one of the configurable settings fields in XFRACAS. '''Date'''.
|-
|NumberUDF1||Sets or gets the number user defined field (UDF) of this RawData; equivalent to the configurable settings fields in XFRACAS. '''Double'''.
|-
|-
|NumberUDF2||Sets or gets the number user defined field (UDF) of this RawData; equivalent to the configurable settings fields in XFRACAS. '''Double'''.
| style="border-bottom:1pt solid #585858; color:#585858;"|
|-
|-
|NumberUDF3||Sets or gets the number user defined field (UDF) of this RawData; equivalent to the configurable settings fields in XFRACAS. '''Double'''.
|DateUDF1||Gets or sets a user-defined date field. '''Date'''.
|-
|-
|StringUDF1||Sets or gets the string user defined field (UDF) of this RawData; equivalent to the configurable settings fields in XFRACAS. '''String'''.
|DateUDF2||Gets or sets a second user-defined date field. '''Date'''.
|-
|-
|StringUDF2||Sets or gets the string user defined field (UDF) of this RawData; equivalent to the configurable settings fields in XFRACAS. '''String'''.
|DateUDF3||Gets or gets a third user-defined date field. '''Date'''.
|-
|-
|StringUDF3||Sets or gets the string user defined field (UDF) of this RawData; equivalent to the configurable settings fields in XFRACAS. '''String'''.
|NumberUDF1||Gets or sets a user-defined number field. '''Double'''.
|}
 
 
'''Miscellaneous'''
{| {{APITable}}
|-
|-
| style="width: 170px;"|AddressLocation||Sets or gets the Address Location of this RawData; equivalent to the Address Location field in an XFRACAS Contact. '''String'''.
|NumberUDF2||Gets or sets a second user-defined number field. '''Double'''.
|-
|-
|Category||Sets or gets the category of this RawData; equivalent to the Category field in an XFRACAS incident. '''String'''.
|NumberUDF3||Gets or sets a third user-defined number field. '''Double'''.
|-
|-
|Chargeable||Sets or gets the chargeable code value (0,1) for this RawData; equivalent to the Category Chargeable and Category Non-Chargeable Lookup Lists in the XFRACAS Admin configuration List. This is to be used to calculate the failure state (StateFS). XFRACAS categories can also be viewed within an XFRACAS Incident. '''Integer'''.
|StringUDF1||Gets or sets a user-defined text field. '''String'''.
|-
|-
|CompanyOwner||Sets or gets the company owner of this RawData; equivalent to the Company filed in an XFRACAS Contact. '''String'''.
|StringUDF2||Gets or sets a second user-defined text field. '''String'''.
|-
|-
|IsLRU||Sets or gets the line replaceable unit (LRU) of this RawData. '''Integer'''.
|StringUDF3||Gets or sets a third user-defined text field. '''String'''.
|-
|ReportType||Sets or gets the report type the of this RawData; equivalent to the Report Type field in an XFRACAS incident. '''String'''.
|-
|RootCause||Sets or gets the RootCause assigned to the resource. '''String'''.
|-
|TimeMetric||Sets or gets the TimeMetric code value of RawData; equivalent to the Time Metric fields in an XFRACAS incident. '''Integer'''.
|}
|}




== Example ==
== Example ==
This example demonstrates how to create a simple raw data set and add it to a repository's Synthesis Data Warehouse (SDW).
This example demonstrates how to use the RawData object to create a simple data set. The data set is saved into an SDW data collection, which can then be exported to a repository's Synthesis Data Warehouse (SDW).


  '''VB'''
  '''VB'''

Revision as of 21:24, 31 August 2015

APIWiki.png


Member of: SynthesisAPI


Represents a single data point in a RawDataSet object.

Constructor

Name Description
RawData Creates an instance of the RawData class.


Properties

Name Description
AddressLocation Gets or sets the Address Location of this RawData; equivalent to the Address Location field in an XFRACAS Contact. String.
Category Sets or gets the category of this RawData; equivalent to the Category field in an XFRACAS incident. String.
Chargeable Sets or gets the chargeable code value (0,1) for this RawData; equivalent to the Category Chargeable and Category Non-Chargeable Lookup Lists in the XFRACAS Admin configuration List. This is to be used to calculate the failure state (StateFS). XFRACAS categories can also be viewed within an XFRACAS Incident. Integer.
CompanyOwner Sets or gets the company owner of this RawData; equivalent to the Company filed in an XFRACAS Contact. String.
IsLRU Sets or gets the line replaceable unit (LRU) of this RawData. Integer.
ReportType Sets or gets the report type the of this RawData; equivalent to the Report Type field in an XFRACAS incident. String.
RootCause Sets or gets the RootCause assigned to the resource. String.
TimeMetric Sets or gets the TimeMetric code value of RawData; equivalent to the Time Metric fields in an XFRACAS incident. Integer.
NumberInState For grouped failure data, gets or sets the number of failed units in a group. Double.
FailureMode Gets or sets the description of the failure mode. String.
LastInspectedTime For interval or left-censored data, gets or sets the time of last inspection. Double.
StateFS Gets or sets whether the data point is a failure ("F") or suspension ("S"). String.
StateTime Gets or sets the time-to-failure or time-to-suspension of the data point. Double.
StateTimeRestore Sets or gets the StateTimeRestore assigned to the resource. Double.
IncidentAction Sets or gets the IncidentAction the resource belongs to and allows the user to see what action occurred within the incident to a part or resource. String.
IncidentEntityDisplayID Sets or gets the IncidentEntityDisplayID the resource belongs to by showing the incident record prefix along with the incident display ID. String.
IncidentID Sets or gets the incident ID of this RawData; equivalent to the Incident ID field in an XFRACAS incident. Integer.
IncidentOccurrenceDate Sets or gets the incident occurrence date of this RawData; equivalent to the Occurrence Date field in an XFRACAS incident. Date.
IncidentRepairDate Sets or gets the incident repair date of this RawData; equivalent to the Repair Date field in an XFRACAS incident. Date.
IncidentResolution Sets or gets the incident resolution of this RawData; equivalent to the Incident Resolution field in an XFRACAS incident. String.
ParentPartID Sets or gets the part's parent ID of this RawData; equivalent to the Part Part ID field in an XFRACAS system. Integer.
ParentPartName Sets or gets the part's parent's name of this RawData; equivalent to the ParentParentName field in an XFRACAS incident. String.
ParentPartNumber Sets or gets the part's parent part number of this RawData; equivalent to the Parent Part Number field in an XFRACAS system. String.
ParentPartVersion Sets or gets the part's parent part version of this RawData; equivalent to the Parent Part Version field in an XFRACAS system. String.
PartHID Sets or gets the part hierarchy identification number of this RawData; equivalent to the HID field in XFRACAS system information. Integer.
PartID Sets or gets the part ID the of this RawData; equivalent to the Part ID field in an XFRACAS incident. Integer.
PartName Sets or gets the part name of this RawData; equivalent to the Part Name field in an XFRACAS incident. String.
PartNumber Sets or gets the part number of this RawData; equivalent to the Part Number field in an XFRACAS incident. String.
PartOrder Sets or gets the part order of this RawData; equivalent to the Part Order field in an XFRACAS incident. Integer.
PartSerialHID Sets or gets the part hierarchy identification number of this RawData; equivalent to the HID field in XFRACAS system information. Integer.
PartSerialMfgCd Sets or gets the serialized part's manufacturing code of this RawData; equivalent to the Manufacturing Code field in an XFRACAS serialized system's Edit Serialized Part dialog box, that can be opened by clicking on the Edit Serialized (default text) button in the Parts section of System. String.
PartSerialNumber Sets or gets the part serial number of this RawData; equivalent to the Part Serial Number field in an XFRACAS incident. String.
PartVersion Sets or gets the part version of this RawData; equivalent to the Version field in an XFRACAS incident. String.
TopLevelCommissionDate Sets or gets the selected part/resource's top level commission date. Date.
TopLevelPartID Sets or gets the part's top level part ID the of this RawData; equivalent to the Top Level Part ID field in an XFRACAS system. Integer.
TopLevelPartName Sets or returns the top level parent name of this RawData; equivalent to the Top Level Part Name field in an XFRACAS incident. String.
TopLevelPartNumber Sets or returns the part's top level parent number of this RawData; equivalent to the Top Level Part Number field in an XFRACAS incident. String.
TopLevelPartVersion Sets or returns the part's top level parent version of this RawData; equivalent to the Top Level Part Version field in an XFRACAS incident. String.
TopLevelSerialHID The part hierarchy serial number (HID) of the top level parent. This is used by RGA to distinguish the system's HID in that the failure occurred and in Weibull to distinguish the potentially different Top Level system HIDs in that the failure state (State FS) occurred. This property is equivalent to the part's parent's serial HID in an XFRACAS system. Integer.
TopLevelSerialNumber The part serial number of the top level parent. This is used by RGA to distinguish the system in that the failure occurred and in Weibull to distinguish the potentially different Top Level systems in that the failure state (State FS) occurred. This property is equivalent to the part's parent's serial number in an XFRACAS system. String.
DateUDF1 Gets or sets a user-defined date field. Date.
DateUDF2 Gets or sets a second user-defined date field. Date.
DateUDF3 Gets or gets a third user-defined date field. Date.
NumberUDF1 Gets or sets a user-defined number field. Double.
NumberUDF2 Gets or sets a second user-defined number field. Double.
NumberUDF3 Gets or sets a third user-defined number field. Double.
StringUDF1 Gets or sets a user-defined text field. String.
StringUDF2 Gets or sets a second user-defined text field. String.
StringUDF3 Gets or sets a third user-defined text field. String.


Example

This example demonstrates how to use the RawData object to create a simple data set. The data set is saved into an SDW data collection, which can then be exported to a repository's Synthesis Data Warehouse (SDW). 

VB

 'Create two data points: 
 Dim DataPoint1 As New RawData
 Dim DataPoint2 As New RawData
 DataPoint1.StateFS = "F"
 DataPoint1.StateTime = "100"
 DataPoint2.StateFS = "F"
 DataPoint2.StateTime = "120"

 'Create an SDW data collection. Name it "New Collection" and specify that it is for use with Weibull++. 
 Dim SDW As New RawDataSet
 SDW.ExtractedName = "New Collection"
 SDW.ExtractedType = RawDataSetType_Weibull

 'Add the two data points to the SDW data collection. 
 Call SDW.AddDataRow(DataPoint1)
 Call SDW.AddDataRow(DataPoint2)
 
 'Add code to connect to a Synthesis repository. 
 Dim MyRepository As New Repository
  ... 

 'Save the data collection to the Synthesis repository. 
 Call MyRepository.DataWarehouse.SaveRawDataSet(SDW)

VB.NET

 'Create two data points: 
 Dim DataPoint1 As New RawData
 Dim DataPoint2 As New RawData
 DataPoint1.StateFS = "F"
 DataPoint1.StateTime = "100"
 DataPoint2.StateFS = "F"
 DataPoint2.StateTime = "120"

 'Create an SDW data collection. Name it "New Collection" and specify that it is for use with Weibull++. 
 Dim SDW As New RawDataSet
 SDW.ExtractedName = "New Collection"
 SDW.ExtractedType = RawDataSetType.Weibull

 'Add the two data points to the SDW data collection. 
 SDW.AddDataRow(DataPoint1)
 SDW.AddDataRow(DataPoint2)

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 
  
 'Save the data collection to the Synthesis repository. 
 MyRepository.DataWarehouse.SaveRawDataSet(SDW)
Retrieved from "https://www.reliawiki.com/index.php?title=RawData_Class&oldid=60659"