RawData Class: Difference between revisions

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




<onlyinclude>Represents a single data point in a [[RawDataSet Class|RawDataSet]] object.</onlyinclude>
<onlyinclude>Represents a single data point in a [[RawDataSet Class|RawDataSet]] object. The data point may be for an XFRACAS, Weibull++ or RGA data set. </onlyinclude>
 
==Constructor==
==Constructor==
{| {{APITable}}
{| {{APITable}}
Line 12: Line 12:


== Properties  ==
== Properties  ==
'''Failure Data'''
 
{| {{APITable}}
{| {{APITable}}
|-
|-
| style="width: 170px;"|StateFS||''String''. 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. 
| style="width: 170px;"|AddressLocation||Gets or sets the location of the owner of the system. Corresponds to the Location field in the XFRACAS contact. '''String'''.
|-
|-
|StateTime||''Double''. Sets or gets the failure/suspension time, equivalent to the "Time to F or S" or "Time Failed" columns in a Weibull++ folio.  
|Category||Gets or sets the XFRACAS incident category. '''String'''.
|-
|-
|StateTimeRestore||''Double''. Sets or gets the StateTimeRestore assigned to the resource.
|Chargeable||Gets or sets the chargeable code value (0 = non-chargeable, 1 = chargeable). Equivalent to the Category Chargeable and Category Non-Chargeable lists in the XFRACAS Admin List page. '''Integer'''.
|-
|-
|LastInspectedTime||''Double''. Sets or gets the time of last inspection, equivalent to the "Last Inspected" column in a Weibull++ folio with interval censored data.  
|CompanyOwner||Gets or sets the owner of the system. Corresponds to the Company field in the XFRACAS contact. '''String'''.
|-
|-
|NumberInState||''Double''. 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.  
|DateUDF1||Gets or sets the date in the first user-defined date field. '''Date'''.
|-
|-
|FailureMode||''String''. Sets or gets the failure mode, equivalent to the Failure Mode field in an XFRACAS incident.  
|DateUDF2||Gets or sets the date in the second user-defined date field. '''Date'''.
|}
 
 
'''Incident'''
{| {{APITable}}
|-
|-
| style="width: 170px;"|IncidentAction||''String''. 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.
|DateUDF3||Gets or gets the date in the third user-defined date field. '''Date'''.
|-
|-
|IncidentEntityDisplayID||''String''. Sets or gets the IncidentEntityDisplayID the resource belongs to by showing the incident record prefix along with the incident display ID.  
|FailureMode||Gets or sets the description of the failure mode associated with the incident. Corresponds to the Failure Mode field in the XFRACAS incident. '''String'''.
|-
|-
|IncidentID||''Integer''. Sets or gets the incident ID of this RawData; equivalent to the Incident ID field in an XFRACAS incident.  
|IncidentAction||Gets or sets the description of the action taken to address the XFRACAS incident (whether a part was removed or installed). '''String'''.
|-
|-
|IncidentOccurrenceDate||''Date''.  Sets or gets the incident occurrence date of this RawData; equivalent to the Occurrence Date field in an XFRACAS incident.
|IncidentEntityDisplayID||Gets or sets the incident number assigned by XFRACAS. It includes the prefix for the entity that the incident is associated with (e.g., E1-201). '''String'''.
|-
|-
|IncidentRepairDate||''Date''.  Sets or gets the incident repair date of this RawData; equivalent to the Repair Date field in an XFRACAS incident.  
|IncidentID||Gets or sets the database ID of the XFRACAS incident. '''Integer'''.
|-
|-
|IncidentResolution||''String''. Sets or gets the incident resolution of this RawData; equivalent to the Incident Resolution field in an XFRACAS incident.  
|IncidentOccurrenceDate||Gets or sets the date when the XFRACAS incident occurred. '''Date'''.
|}
 
 
'''Parent Part'''
{| {{APITable}}
|-
|-
| style="width: 170px;"|ParentPartID||''Integer''. Sets or gets the part's parent ID of this RawData; equivalent to the Part Part ID field in an XFRACAS system.  
|IncidentRepairDate||Gets or sets the date that the part repair or replacement was completed. Corresponds to the Completed Date field that applies to the XFRACAS incident resolution. '''Date'''.
|-
|-
|ParentPartName||''String''. Sets or gets the part's parent's name of this RawData; equivalent to the ParentParentName field in an XFRACAS incident.  
|IncidentResolution||Gets or sets the description of the incident resolution. Corresponds to the Incident Resolution field in the XFRACAS incident. '''String'''.
|-
|-
|ParentPartNumber||''String''. Sets or gets the part's parent part number of this RawData; equivalent to the Parent Part Number field in an XFRACAS system.  
|IsLRU||Gets or sets the line replaceable unit (LRU). '''Integer'''.
|-
|-
|ParentPartVersion||''String''. Sets or gets the part's parent part version of this RawData; equivalent to the Parent Part Version field in an XFRACAS system.  
|LastInspectedTime||Gets or sets the time of last inspection. For exporting data sets to Weibull++, this is equal to the state time for the data row. For exporting data sets to RGA, it is the amount of time the system has accrued at the last reported incident. '''Double'''.
|}
 
 
'''Part'''
{| {{APITable}}
|-
|-
| style="width: 170px;"|PartHID||''Integer''. Sets or gets the part hierarchy identification number of this RawData; equivalent to the HID field in XFRACAS system information.  
|NumberInState||Gets or sets the number of failed units in the group. Equivalent to the Number in State column in a Weibull++ standard folio for grouped data. '''Double'''.
|-
|-
|PartID||''Integer''. Sets or gets the part ID the of this RawData; equivalent to the Part ID field in an XFRACAS incident.  
|NumberUDF1||Gets or sets the value in the first user-defined number field. '''Double'''.
|-
|-
|PartName||''String''. Sets or gets the part name of this RawData; equivalent to the Part Name field in an XFRACAS incident.  
|NumberUDF2||Gets or sets the value in the second user-defined number field. '''Double'''.
|-
|-
|PartNumber||''String''. Sets or gets the part number of this RawData; equivalent to the Part Number field in an XFRACAS incident.  
|NumberUDF3||Gets or sets the value in the third user-defined number field. '''Double'''.
|-
|-
|PartOrder||''Integer''. Sets or gets the part order of this RawData; equivalent to the Part Order field in an XFRACAS incident.  
|ParentPartID||Gets or sets the database identification number for the parent of the part that the XFRACAS incident pertains to. '''Integer'''.
|-
|-
|PartSerialHID||''Integer''. Sets or gets the part hierarchy identification number of this RawData; equivalent to the HID field in XFRACAS system information.  
|ParentPartName||Gets or sets the name for the parent of the part that the XFRACAS incident pertains to. '''String'''.
|-
|-
|PartSerialMfgCd||''String''. 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.  
|ParentPartNumber||Gets or sets the part number for the parent of the part that the XFRACAS incident pertains to. '''String'''.
|-
|-
|PartSerialNumber||''String''. Sets or gets the part serial number of this RawData; equivalent to the Part Serial Number field in an XFRACAS incident.  
|ParentPartVersion||Gets or sets the part version for the parent of the part that the XFRACAS incident pertains to. '''String'''.
|-
|-
|PartVersion||''String''. Sets or gets the part version of this RawData; equivalent to the Version field in an XFRACAS incident.  
|PartHID||Gets or sets the part’s hierarchy identification number. '''Integer'''.
|}
 
 
'''Top Level'''
{| {{APITable}}
|-
|-
| style="width: 170px;"|TopLevelCommissionDate||''Date''. Sets or gets the selected part/resource's top level commission date.  
|PartID||Gets or sets the part’s database identification number. '''Integer'''.
|-
|-
|TopLevelPartID||''Integer''. 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.  
|PartName||Gets or sets the part's name. '''String'''.
|-
|-
|TopLevelPartName||''String''. Sets or returns the top level parent name of this RawData; equivalent to the Top Level Part Name field in an XFRACAS incident.  
|PartNumber||Gets or sets the part number. '''String'''.
|-
|-
|TopLevelPartNumber||''String''. 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.  
|PartOrder||Gets or sets the order in which the part was replaced. This corresponds to the order in the repair/replace table in the XFRACAS incident.'''Integer'''.
|-
|-
|TopLevelPartVersion||''String''. 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.  
|PartSerialHID||Gets or sets the part’s serial hierarchy identification number. '''Integer'''.
|-
|-
|TopLevelSerialHID||''Integer''. 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.  
|PartSerialMfgCd||Gets or sets the serialized part's manufacturing code. '''String'''.
|-
|-
|TopLevelSerialNumber||''String''. 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.  
|PartSerialNumber||Gets or sets the part's serial number. '''String'''.
|}
 
 
'''User-Defined Fields'''
{| {{APITable}}
|-
|-
| style="width: 170px;"|DateUDF1||''Date''. Sets or gets a user-defined date field of this RawData row; equivalent to one of the configurable settings fields in XFRACAS.  
|PartVersion||Gets or sets the part version. '''String'''.
|-
|-
|DateUDF2||''Date''. Sets or gets a user-defined date field of this RawData row; equivalent to one of the configurable settings fields in XFRACAS.  
|ReportType||Gets or sets the description of how the XFRACAS incident was reported. '''String'''.
|-
|-
|DateUDF3||''Date''. Sets or gets a user-defined date field of this RawData row; equivalent to one of the configurable settings fields in XFRACAS.  
|RootCause||Gets or sets the description of the root cause of the failure mode. Corresponds to the Root Cause field in the XFRACAS incident. '''String'''.
|-
|-
|NumberUDF1||''Double''. Sets or gets the number user defined field (UDF) of this RawData; equivalent to the configurable settings fields in XFRACAS.
|StateFS||Gets or sets whether the data point is a failure (F) or suspension (S). '''String'''.  
|-
|-
|NumberUDF2||''Double''. Sets or gets the number user defined field (UDF) of this RawData; equivalent to the configurable settings fields in XFRACAS.
|StateTime||Gets or sets the amount of time accrued on the part. '''Double'''.  
|-
|-
|NumberUDF3||''Double''. Sets or gets the number user defined field (UDF) of this RawData; equivalent to the configurable settings fields in XFRACAS.
|StateTimeRestore||Gets or sets the amount of time required for the repair (repair duration). '''Double'''.
|-
|-
|StringUDF1||''String''. Sets or gets the string user defined field (UDF) of this RawData; equivalent to the configurable settings fields in XFRACAS.  
|StringUDF1||Gets or sets the text in the first user-defined text field. '''String'''.
|-
|-
|StringUDF2||''String''. Sets or gets the string user defined field (UDF) of this RawData; equivalent to the configurable settings fields in XFRACAS.  
|StringUDF2||Gets or sets the text in the second user-defined text field. '''String'''.
|-
|-
|StringUDF3||''String''. Sets or gets the string user defined field (UDF) of this RawData; equivalent to the configurable settings fields in XFRACAS.  
|StringUDF3||Gets or sets the text in the third user-defined text field. '''String'''.
|}
 
 
'''Miscellaneous'''
{| {{APITable}}
|-
|-
| style="width: 170px;"|AddressLocation||''String''. Sets or gets the Address Location of this RawData; equivalent to the Address Location field in an XFRACAS Contact.
|TimeMetric||Gets or sets the calculated time metric that is in use. '''Integer'''.
|-
|-
|Category||''String''. Sets or gets the category of this RawData; equivalent to the Category field in an XFRACAS incident.  
|TopLevelCommissionDate||Gets or sets the commission date of the top level part in the system. '''Date'''.
|-
|-
|Chargeable||''Integer''. 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.  
|TopLevelPartID||Gets or sets the part ID of the top level part in the system. '''Integer'''.
|-
|-
|CompanyOwner||''String''. Sets or gets the company owner of this RawData; equivalent to the Company filed in an XFRACAS Contact.
|TopLevelPartName||Gets or sets the part name of the top level part in the system. '''String'''.
|-
|-
|IsLRU||''Integer''. Sets or gets the line replaceable unit (LRU) of this RawData.  
|TopLevelPartNumber||Gets or sets the part number of the top level part in the system. '''String'''.
|-
|-
|ReportType||''String''. Sets or gets the report type the of this RawData; equivalent to the Report Type field in an XFRACAS incident.  
|TopLevelPartVersion||Gets or sets the part version of the top level part in the system. '''String'''.
|-
|-
|RootCause||''String''. Sets or gets the RootCause assigned to the resource.  
|TopLevelSerialHID||Gets or sets the serial hierarchy identification number of the top level part in the serialized system. '''Integer'''.
|-
|-
|TimeMetric||''Integer''. Sets or gets the TimeMetric code value of RawData; equivalent to the Time Metric fields in an XFRACAS incident.  
|TopLevelSerialNumber||Gets or sets the serial number of the top level part in the serialized system. '''String'''.
|}
|}




== Example ==
==Notes==
This example demonstrates how to create a simple raw data set and add it to a repository's Synthesis Data Warehouse (SDW).
A data point for a Weibull++ data set typically requires the following properties:
*LastInspectedTime
*NumberinState
*StateFS
*StateTime


'''VB'''
For an RGA data set, the typical properties are:
*LastInspectedTime
{{APIComment|'Create two data points:}}
*StateFS
  {{APIPrefix|Dim}} DataPoint1 {{APIPrefix|As New}} RawData
*StateTime
  {{APIPrefix|Dim}} DataPoint2 {{APIPrefix|As New}} RawData
*TopLevelSerialNumber
  DataPoint1.StateFS = {{APIString|"F"}}
  DataPoint1.StateTime = {{APIString|"100"}}
  DataPoint2.StateFS = {{APIString|"F"}}
  DataPoint2.StateTime = {{APIString|"120"}}
{{APIComment|'Create an SDW data collection. Name it "New Collection" and specify that it is for use with Weibull++.}}
  {{APIPrefix|Dim}} SDW {{APIPrefix|As New}} RawDataSet
  SDW.ExtractedName = {{APIString|"New Collection"}}
  SDW.ExtractedType = RawDataSetType_Weibull
{{APIComment|'Add the two data points to the SDW data collection.}}
  {{APIPrefix|Call}} SDW.AddDataRow(DataPoint1)
  {{APIPrefix|Call}} SDW.AddDataRow(DataPoint2)
 
{{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
{{APIComment|'Save the data collection to the Synthesis repository.}}
  {{APIPrefix|Call}} MyRepository.DataWarehouse.SaveRawDataSet(SDW)
 
'''VB.NET'''
{{APIComment|'Create two data points:}}
  {{APIPrefix|Dim}} DataPoint1 {{APIPrefix|As New}} RawData
  {{APIPrefix|Dim}} DataPoint2 {{APIPrefix|As New}} RawData
  DataPoint1.StateFS = {{APIString|"F"}}
  DataPoint1.StateTime = {{APIString|"100"}}
  DataPoint2.StateFS = {{APIString|"F"}}
  DataPoint2.StateTime = {{APIString|"120"}}
{{APIComment|'Create an SDW data collection. Name it "New Collection" and specify that it is for use with Weibull++.}}
  {{APIPrefix|Dim}} SDW {{APIPrefix|As New}} RawDataSet
  SDW.ExtractedName = {{APIString|"New Collection"}}
  SDW.ExtractedType = RawDataSetType.Weibull
{{APIComment|'Add the two data points to the SDW data collection.}}
  SDW.AddDataRow(DataPoint1)
  SDW.AddDataRow(DataPoint2)
{{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
 
{{APIComment|'Save the data collection to the Synthesis repository.}}
  MyRepository.DataWarehouse.SaveRawDataSet(SDW)

Latest revision as of 21:31, 10 May 2016

APIWiki.png


Member of: SynthesisAPI


Represents a single data point in a RawDataSet object. The data point may be for an XFRACAS, Weibull++ or RGA data set.

Constructor

Name Description
RawData Creates an instance of the RawData class.


Properties

Name Description
AddressLocation Gets or sets the location of the owner of the system. Corresponds to the Location field in the XFRACAS contact. String.
Category Gets or sets the XFRACAS incident category. String.
Chargeable Gets or sets the chargeable code value (0 = non-chargeable, 1 = chargeable). Equivalent to the Category Chargeable and Category Non-Chargeable lists in the XFRACAS Admin List page. Integer.
CompanyOwner Gets or sets the owner of the system. Corresponds to the Company field in the XFRACAS contact. String.
DateUDF1 Gets or sets the date in the first user-defined date field. Date.
DateUDF2 Gets or sets the date in the second user-defined date field. Date.
DateUDF3 Gets or gets the date in the third user-defined date field. Date.
FailureMode Gets or sets the description of the failure mode associated with the incident. Corresponds to the Failure Mode field in the XFRACAS incident. String.
IncidentAction Gets or sets the description of the action taken to address the XFRACAS incident (whether a part was removed or installed). String.
IncidentEntityDisplayID Gets or sets the incident number assigned by XFRACAS. It includes the prefix for the entity that the incident is associated with (e.g., E1-201). String.
IncidentID Gets or sets the database ID of the XFRACAS incident. Integer.
IncidentOccurrenceDate Gets or sets the date when the XFRACAS incident occurred. Date.
IncidentRepairDate Gets or sets the date that the part repair or replacement was completed. Corresponds to the Completed Date field that applies to the XFRACAS incident resolution. Date.
IncidentResolution Gets or sets the description of the incident resolution. Corresponds to the Incident Resolution field in the XFRACAS incident. String.
IsLRU Gets or sets the line replaceable unit (LRU). Integer.
LastInspectedTime Gets or sets the time of last inspection. For exporting data sets to Weibull++, this is equal to the state time for the data row. For exporting data sets to RGA, it is the amount of time the system has accrued at the last reported incident. Double.
NumberInState Gets or sets the number of failed units in the group. Equivalent to the Number in State column in a Weibull++ standard folio for grouped data. Double.
NumberUDF1 Gets or sets the value in the first user-defined number field. Double.
NumberUDF2 Gets or sets the value in the second user-defined number field. Double.
NumberUDF3 Gets or sets the value in the third user-defined number field. Double.
ParentPartID Gets or sets the database identification number for the parent of the part that the XFRACAS incident pertains to. Integer.
ParentPartName Gets or sets the name for the parent of the part that the XFRACAS incident pertains to. String.
ParentPartNumber Gets or sets the part number for the parent of the part that the XFRACAS incident pertains to. String.
ParentPartVersion Gets or sets the part version for the parent of the part that the XFRACAS incident pertains to. String.
PartHID Gets or sets the part’s hierarchy identification number. Integer.
PartID Gets or sets the part’s database identification number. Integer.
PartName Gets or sets the part's name. String.
PartNumber Gets or sets the part number. String.
PartOrder Gets or sets the order in which the part was replaced. This corresponds to the order in the repair/replace table in the XFRACAS incident.Integer.
PartSerialHID Gets or sets the part’s serial hierarchy identification number. Integer.
PartSerialMfgCd Gets or sets the serialized part's manufacturing code. String.
PartSerialNumber Gets or sets the part's serial number. String.
PartVersion Gets or sets the part version. String.
ReportType Gets or sets the description of how the XFRACAS incident was reported. String.
RootCause Gets or sets the description of the root cause of the failure mode. Corresponds to the Root Cause field in the XFRACAS incident. String.
StateFS Gets or sets whether the data point is a failure (F) or suspension (S). String.
StateTime Gets or sets the amount of time accrued on the part. Double.
StateTimeRestore Gets or sets the amount of time required for the repair (repair duration). Double.
StringUDF1 Gets or sets the text in the first user-defined text field. String.
StringUDF2 Gets or sets the text in the second user-defined text field. String.
StringUDF3 Gets or sets the text in the third user-defined text field. String.
TimeMetric Gets or sets the calculated time metric that is in use. Integer.
TopLevelCommissionDate Gets or sets the commission date of the top level part in the system. Date.
TopLevelPartID Gets or sets the part ID of the top level part in the system. Integer.
TopLevelPartName Gets or sets the part name of the top level part in the system. String.
TopLevelPartNumber Gets or sets the part number of the top level part in the system. String.
TopLevelPartVersion Gets or sets the part version of the top level part in the system. String.
TopLevelSerialHID Gets or sets the serial hierarchy identification number of the top level part in the serialized system. Integer.
TopLevelSerialNumber Gets or sets the serial number of the top level part in the serialized system. String.


Notes

A data point for a Weibull++ data set typically requires the following properties:

  • LastInspectedTime
  • NumberinState
  • StateFS
  • StateTime

For an RGA data set, the typical properties are:

  • LastInspectedTime
  • StateFS
  • StateTime
  • TopLevelSerialNumber
Retrieved from "https://www.reliawiki.com/index.php?title=RawData_Class&oldid=64078"