Repository Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 230: Line 230:
| style="border-bottom:1pt solid #585858; color:#585858;"|
| style="border-bottom:1pt solid #585858; color:#585858;"|
|-
|-
|[[Repository.Xfmea.GetAllXfmeaFailuresDictionary Method|Xfmea.GetAllXfmeaFailuresDictionary]]||{{APIComment|Returns a dictionary containing all XfmeaFailures that belong to the function. The keys are the IDs of the XfmeaFailures.}} [[#Version Information|*]]
|[[Repository.Xfmea.GetAllXfmeaFailuresDictionary Method|Xfmea.GetAllXfmeaFailuresDictionary]]||{{:Repository.Xfmea.GetAllXfmeaFailuresDictionary Method}}
|-
|-
|[[Repository.Xfmea.GetAllXfmeaFailures Method|Xfmea.GetAllXfmeaFailures]]||{{APIComment|Returns an array containing all XfmeaFailures that belong to the function.}} [[#Version Information|*]]
|[[Repository.Xfmea.GetAllXfmeaFailures Method|Xfmea.GetAllXfmeaFailures]]||{{:Repository.Xfmea.GetAllXfmeaFailures Method}}
|-
|-
|[[Repository.Xfmea.GetXfmeaFailure Method|Xfmea.GetXfmeaFailure]]||{{APIComment|Returns XfmeaFailure with the provided ID.}} [[#Version Information|*]]
|[[Repository.Xfmea.GetXfmeaFailure Method|Xfmea.GetXfmeaFailure]]||{{:Repository.Xfmea.GetXfmeaFailure Method}}
|-
|-
|[[Repository.Xfmea.AddXfmeaFailure Method|Xfmea.AddXfmeaFailure]]||{{APIComment|Adds a new XfmeaFailure in the repository.}} [[#Version Information|*]]
|[[Repository.Xfmea.AddXfmeaFailure Method|Xfmea.AddXfmeaFailure]]||{{:Repository.Xfmea.AddXfmeaFailure Method}}
|-
|-
|[[Repository.Xfmea.UpdateXfmeaFailure Method|Xfmea.UpdateXfmeaFailure]]||{{APIComment|Updates the XfmeaFailure in the repository.}} [[#Version Information|*]]
|[[Repository.Xfmea.UpdateXfmeaFailure Method|Xfmea.UpdateXfmeaFailure]]||{{:Repository.Xfmea.UpdateXfmeaFailure Method}}
|-
|-
| style="border-bottom:1pt solid #585858; color:#585858;"|
| style="border-bottom:1pt solid #585858; color:#585858;"|
|-
|-
|[[Repository.Xfmea.GetAllXfmeaEffectsDictionary Method|Xfmea.GetAllXfmeaEffectsDictionary]]||{{APIComment|Returns a dictionary containing all XfmeaEffects that belong to the failure. The keys are the IDs of the XfmeaEffects.}} [[#Version Information|*]]
|[[Repository.Xfmea.GetAllXfmeaEffectsDictionary Method|Xfmea.GetAllXfmeaEffectsDictionary]]||{{:Repository.Xfmea.GetAllXfmeaEffectsDictionary Method}}
|-
|-
|[[Repository.Xfmea.GetAllXfmeaEffects Method|Xfmea.GetAllXfmeaEffects]]||{{APIComment|Returns an array containing all XfmeaEffects  that belong to the failure.}} [[#Version Information|*]]
|[[Repository.Xfmea.GetAllXfmeaEffects Method|Xfmea.GetAllXfmeaEffects]]||{{:Repository.Xfmea.GetAllXfmeaEffects Method}}
|-
|-
|[[Repository.Xfmea.GetXfmeaEffect Method|Xfmea.GetXfmeaEffect]]||{{APIComment|Returns XfmeaEffect with the provided ID.}} [[#Version Information|*]]
|[[Repository.Xfmea.GetXfmeaEffect Method|Xfmea.GetXfmeaEffect]]||{{:Repository.Xfmea.GetXfmeaEffect Method}}
|-
|-
|[[Repository.Xfmea.AddXfmeaEffect Method|Xfmea.AddXfmeaEffect]]||{{APIComment|Adds a new XfmeaEffect in the repository.}} [[#Version Information|*]]
|[[Repository.Xfmea.AddXfmeaEffect Method|Xfmea.AddXfmeaEffect]]||{{:Repository.Xfmea.AddXfmeaEffect Method}}
|-
|-
|[[Repository.Xfmea.UpdateXfmeaEffect Method|Xfmea.UpdateXfmeaEffect]]||{{APIComment|Updates the XfmeaEffect in the repository.}} [[#Version Information|*]]
|[[Repository.Xfmea.UpdateXfmeaEffect Method|Xfmea.UpdateXfmeaEffect]]||{{:Repository.Xfmea.UpdateXfmeaEffect Method}}
|-
|-
| style="border-bottom:1pt solid #585858; color:#585858;"|
| style="border-bottom:1pt solid #585858; color:#585858;"|
|-
|-
|[[Repository.Xfmea.GetAllXfmeaCausesDictionary Method|Xfmea.GetAllXfmeaCausesDictionary]]||{{APIComment|Returns a dictionary containing all XfmeaCauses that belong to the failure. The keys are the IDs of the XfmeaCauses.}} [[#Version Information|*]]
|[[Repository.Xfmea.GetAllXfmeaCausesDictionary Method|Xfmea.GetAllXfmeaCausesDictionary]]||{{:Repository.Xfmea.GetAllXfmeaCausesDictionary Method}}
|-
|-
|[[Repository.Xfmea.GetAllXfmeaCauses Method|Xfmea.GetAllXfmeaCauses]]||{{APIComment|Returns an array containing all XfmeaCauses  that belong to the failure.}} [[#Version Information|*]]
|[[Repository.Xfmea.GetAllXfmeaCauses Method|Xfmea.GetAllXfmeaCauses]]||{{:Repository.Xfmea.GetAllXfmeaCauses Method}}
|-
|-
|[[Repository.Xfmea.GetXfmeaCause Method|Xfmea.GetXfmeaCause]]||{{APIComment|Returns XfmeaCause with the provided ID.}} [[#Version Information|*]]
|[[Repository.Xfmea.GetXfmeaCause Method|Xfmea.GetXfmeaCause]]||{{:Repository.Xfmea.GetXfmeaCause Method}}
|-
|-
|[[Repository.Xfmea.AddXfmeaCause Method|Xfmea.AddXfmeaCause]]|| {{APIComment|Adds a new XfmeaCause in the repository.}} [[#Version Information|*]]
|[[Repository.Xfmea.AddXfmeaCause Method|Xfmea.AddXfmeaCause]]|| {{:Repository.Xfmea.AddXfmeaCause Method}}
|-
|-
|[[Repository.Xfmea.UpdateXfmeaCause Method|Xfmea.UpdateXfmeaCause]]||{{APIComment|Updates the XfmeaCause in the repository.}} [[#Version Information|*]]
|[[Repository.Xfmea.UpdateXfmeaCause Method|Xfmea.UpdateXfmeaCause]]||{{:Repository.Xfmea.UpdateXfmeaCause Method}}
|}
|}

Revision as of 21:27, 25 August 2015

Template:InProgress

APIWiki.png


Member of: SynthesisAPI


Represents a Synthesis repository. Use any of the first four methods to establish a connection to a Synthesis repository. Once you have a connection, you can use the methods in the Project, Unit, Model, etc. fields to read and write data to the repository.

Constructors

Name Description
Repository Creates an instance of the Repository class.


Methods

Name Description
ConnectToRepository Connects to a standard or enterprise repository. Returns a Boolean value; when true, indicates a successful connection to the repository.
ConnectToAccessRepository Connects to a standard repository (cannot be used to connect to an enterprise repository). Returns a Boolean value; when true, indicates a successful connection to the repository.
ConnectToSQLRepository Connects to a SQL Server repository. Returns a Boolean value; when true, indicates a successful connection to the repository.
ConnectToOracleRepository Connects to an Oracle repository. Returns a Boolean value; when true, indicates a successful connection to the repository.
DisconnectFromRepository Disconnects from the current repository.
EnforceRENOCompliance Template:InProgress
APIWiki.png


Member of: SynthesisAPI


Represents a Synthesis repository. Use any of the first four methods to establish a connection to a Synthesis repository. Once you have a connection, you can use the methods in the Project, Unit, Model, etc. fields to read and write data to the repository.

Constructors

Name Description
Repository Creates an instance of the Repository class.


Methods

Name Description
ConnectToRepository Connects to a standard or enterprise repository. Returns a Boolean value; when true, indicates a successful connection to the repository.
ConnectToAccessRepository Connects to a standard repository (cannot be used to connect to an enterprise repository). Returns a Boolean value; when true, indicates a successful connection to the repository.
ConnectToSQLRepository Connects to a SQL Server repository. Returns a Boolean value; when true, indicates a successful connection to the repository.
ConnectToOracleRepository Connects to an Oracle repository. Returns a Boolean value; when true, indicates a successful connection to the repository.
DisconnectFromRepository Disconnects from the current repository.
EnforceRENOCompliance Template loop detected: Repository.EnforceRENOCompliance

Project

Name Description
Project.GetAllProjects Returns an array of NameIDPair objects that represent the name and ID pairs of the projects associated with the Repository object.
Project.GetCurrentProject Returns a NameIDPair object that represents the name and ID pair of the current project.
Project.SetCurrentProject Sets the current (active) project for the repository. Returns a Boolean value; when true, indicates a successful connection to that project.

Unit

Name Description
Unit.GetAllUnits Returns an array of UnitInfo objects that represent the units of measurement associated with the Repository object.

Model

Name Description
Model.GetAllModels Returns an array of cModel objects that represent the model resources in the current project.
Model.AddModel Adds a new model resource to the current project. Returns a Boolean value; when true, indicates a successful save.
Model.UpdateModel Updates the properties of a given model resource in the current project. Returns a Boolean value; when true, indicates a successful update.
Model.GetModel Returns a cModel object that represents a given model resource in the current project. Returns nothing if the model does not exist or is not in the current project.
Model.IsModelUsed Checks whether the model is used by other items in the project. Returns a Boolean value; when true, indicates that the model is in use.
Model.DeleteModel Deletes an unused model from the current project. Throws an exception if the model is in use. Returns a Boolean value; when true, indicates a successful deletion.
Model.GetAllModelsInfo   Deprecated   Returns an array of NameIdPair objects that represent the name and ID pairs of the model resources in the current project. This includes internal models automatically created with any new repository (model ID#s 1 to 20).

URD

Name Description
URD.GetAllURDs Returns an array of cURD objects that represent the universal reliability definitions (URDs) in the current project.
URD.AddURD Adds a new universal reliability definition (URD) resource to the current project. Returns a Boolean value; when true, indicates a successful save.
URD.UpdateURD Updates the properties of a given URD resource in the current project. Returns a Boolean value; when true, indicates a successful update.
URD.GetURD Returns a cURD object that represents a given URD resource in the current project. Returns nothing if the URD does not exist or is not in the current project.

Variable

Name Description
Variables.GetAllVariables Returns an array of cVariable objects that represent the variable resources in the current project.
Variables.AddVariable Adds a new variable resource to the current project. Returns a Boolean value; when true, indicates a successful save.
Variables.UpdateVariable Updates the properties of a given variable resource in the current project. Returns a Boolean value; when true, indicates a successful update.
Variables.GetVariable Returns a cVariable object that represents a given variable resource in the current project. Returns nothing if the variable does not exist or is not in the current project.

Task

Name Description
Task.GetAllCorrectiveTasks Returns an array of cCorrectiveTask objects that represent the corrective tasks in the current project.
Task.AddCorrectiveTask Adds a new corrective task to the current project. Returns a Boolean value; when true, indicates a successful save.
Task.UpdateCorrectiveTask Updates the properties of a given corrective task in the current project. Returns a Boolean value; when true, indicates a successful update.
Task.GetCorrectiveTask Returns a cCorrectiveTask object that represents a given corrective task resource in the current project. Returns nothing if the task does not exist or is not in the current project.
Task.GetAllScheduledTasks Returns an array of cScheduledTask objects that represent the scheduled tasks in the current project.
Task.AddScheduledTask Adds a new scheduled task to the current project. Returns a Boolean value; when true, indicates a successful save.
Task.UpdateScheduledTask Updates the properties of a given scheduled task in the current project. Returns a Boolean value; when true, indicates a successful update.
Task.GetScheduledTask Returns a cScheduledTask object that represents a given scheduled task resource in the current project. Returns nothing if the task does not exist or is not in the current project.
Task.GetAllTaskTypes Returns an array of TaskTypeInfo objects that represent the RCM++ or RBI task types associated with the Repository object.

Crew

Name Description
Crew.GetAllCrews Returns an array of cCrew objects that represent the crew resources in the current project.
Crew.AddCrew Adds a new crew resource to the current project. Returns a Boolean value; when true, indicates a successful save.
Crew.UpdateCrew Updates the properties of a given crew resource in the current project. Returns a Boolean value; when true, indicates a successful save.
Crew.GetCrew Returns a cCrew object that represents a given crew resource in the current project. Returns nothing if the crew does not exist or is not in the current project.

Pool

Name Description
Pool.GetAllPools Returns an array of cPool objects that represent the spare part pools in the current project.
Pool.AddPool Adds a new spare part pool to the current project. Returns a Boolean value; when true, indicates indicates a successful save.
Pool.UpdatePool Updates the properties of a given spare part pool in the current project. Returns a Boolean value; when true, indicates a successful update.
Pool.GetPool Returns a cPool object that represents a given spare part pool resource in the current project. Returns nothing if the spare part pool does not exist or is not in the current project.

Action

Name Description
Action.GetAllActionsDictionary Returns a dictionary object that contains all available action resources in the current project. The dictionary syntax is Dictionary(Of Integer, cAction), where the ID numbers are the keys and the cAction objects that represent the action resources are the associated values. (.NET only)
Action.GetAllActions Returns an array of cAction objects that represent the action resources in the current project.
Action.AddAction Adds a new action to the current project. The action description or name must be unique. Returns a Boolean value; when true, indicates a successful save.
Action.UpdateAction Updates the properties of a given action resource in the current project. Returns a Boolean value; when true, indicates a successful update.
Action.GetAction Returns a cAction object that represents a given action resource in the current project. Returns nothing if the action does not exist or is not in the current project.

Control

Name Description
Control.GetAllXfmeaControlsDictionary Returns a dictionary object that contains all available Xfmea controls in the current project. The dictionary syntax is Dictionary (Of Integer, cXfmeaControl), where the ID numbers are the keys and the cXfmeaControl objects that represent the controls are the associated values. (.NET only)
Control.GetAllXfmeaControls Returns an array of cXfmeaControl objects that represent the Xfmea controls in the current project.
Control.AddXfmeaControl Adds a new Xfmea control to the current project. Returns a Boolean value; when true, indicates a successful save.
Control.UpdateXfmeaControl Updates the properties of a given control resource in the current project. Returns a Boolean value; when true, indicates a successful update.
Control.GetXfmeaControl Returns a cXfmeaControl object that represents a given control resource in the current project. Returns nothing if the control does not exist or is not in the current project.

BlockSim

Name Description
BlockSim.ImportBlockSimXMLFile Imports data from an XML file into the current BlockSim project. Returns a Boolean value; when true, indicates a successful import.
BlockSim.ExportBlockSimXMLFile Exports data from the current BlockSim project to a new XML file. Returns a Boolean value; when true, indicates a successful export.

Data Warehouse

Name Description
DataWarehouse.SaveRawDataSet Adds a new Synthesis Data Warehouse (SDW) data collection to the associated Repository object. Returns a Boolean value; when true, indicates a successful save.

XFRACAS

Name Description
XFRACAS.GetAllXFRACASEntities
XFRACAS.ImportXFRACASXML Uploads an import file byte stream for processing and returns the system ID of the uploaded byte array.
XFRACAS.ImportXFRACASXMLFile Uploads an import file for processing and returns the system ID of the uploaded XML file.
XFRACAS.ImportXFRACASXMLString Uploads an import file string for processing and returns the system ID of the uploaded XML string.
XFRACAS.SerializeXMLObjectToByteArray A helper function to create an array of bytes from a serializable XML object.
XFRACAS.ProcessXfracasImports Runs the import process.
XFRACAS.WriteMessageToDiagnosticsLog Writes a message to the diagnostics log
XFRACAS.WriteExceptionToDiagnosticsLog Writes exception information to the diagnostics log
XFRACAS.XFRACASCommandTimeout Gets or sets the wait time before terminating the attempt to execute an XFRACAS command.
XFRACAS.AddSystemMetric1 This can be used to insert reported run hours and the date of the reported run hours.
XFRACAS.AddSystemMetric2 This can be used to insert reported run hours, number of starts, and the date.
XFRACAS.AddSystemMetric3 This can be used to insert reported run hours, number of starts, kw run hours, and the date.

Xfmea

Name Description
Xfmea.GetAllItemsInSystemHierarchyDictionary Returns a dictionary object that contains all available system hierarchy items in the current project. The dictionary syntax is Dictionary(Of Integer, XfmeaItem), where the ID numbers are the keys, and the XfmeaItem objects that represent the system hierarchy items are the associated values. (.NET only)
Xfmea.GetAllItemsInSystemHierarchy Returns an array of XfmeaItem objects that represent the system hierarchy items in the current project.
Xfmea.AddItemToSystemHierarchy Adds a new system hierarchy item to the current project. Returns a Boolean value; when true, indicates a successful save.
Xfmea.UpdateItemInSystemHierarchy Updates the properties of a given system hierarchy item in the current project. Returns a Boolean value; when true, indicates a successful update.
Xfmea.GetAllXfmeaFunctionsDictionary Returns a dictionary object that contains all available FMEA functions associated with a system hierarchy item. The dictionary syntax is Dictionary(Of Integer, XfmeaFunction), where the ID numbers are the keys, and the XfmeaFunction objects that represent the FMEA functions are the associated values. (.NET only)
Xfmea.GetAllXfmeaFunctions Returns an array of XfmeaFunction objects that represent the FMEA functions associated with a system hierarchy item.
Xfmea.GetXfmeaFunction Returns an XfmeaFunction object that represents a given FMEA function in the current project. Returns nothing if the FMEA function does not exist or is not in the current project.
Xfmea.AddXfmeaFunction Adds a new FMEA function to a system hierarchy item. Returns a Boolean value; when true, indicates a successful save.
Xfmea.UpdateXfmeaFunction Updates the properties of a given FMEA function in the current project. Returns a Boolean value; when true, indicates a successful update.
Xfmea.GetAllXfmeaFailuresDictionary Returns a dictionary object that contains all available failures associated with an FMEA function. The dictionary syntax is Dictionary(Of Integer, XfmeaFailure), where the ID numbers are the keys, and the XfmeaFailure objects that represent the failures are the associated values. (.NET only)
Xfmea.GetAllXfmeaFailures Returns an array of XfmeaFailure objects that represent the failures associated with an FMEA function.
Xfmea.GetXfmeaFailure Returns an XfmeaFailure object that represents a given FMEA failure in the current project. Returns nothing if the failure does not exist or is not in the current project.
Xfmea.AddXfmeaFailure Adds a new failure to an FMEA function. Returns a Boolean value; when true, indicates a successful save.
Xfmea.UpdateXfmeaFailure Updates the properties of a given FMEA failure in the current project. Returns a Boolean value; when true, indicates a successful update.
Xfmea.GetAllXfmeaEffectsDictionary Returns a dictionary object that contains all available effects associated with a failure. The dictionary syntax is Dictionary(Of Integer, XfmeaEffect), where the ID numbers are the keys, and the XfmeaEffect objects that represent the effects are the associated values. (.NET only)
Xfmea.GetAllXfmeaEffects Returns an array of XfmeaEffect objects that represent the effects associated with a failure.
Xfmea.GetXfmeaEffect Returns an XfmeaEffect object that represents a given FMEA effect in the current project. Returns nothing if the effect does not exist or is not in the current project.
Xfmea.AddXfmeaEffect Adds a new effect to a failure. Returns a Boolean value; when true, indicates a successful save.
Xfmea.UpdateXfmeaEffect Updates the properties of a given FMEA effect in the current project. Returns a Boolean value; when true, indicates a successful update.
Xfmea.GetAllXfmeaCausesDictionary Returns a dictionary object that contains all available causes associated with a failure. The dictionary syntax is Dictionary(Of Integer, XfmeaCause), where the ID numbers are the keys, and the XfmeaCause objects that represent the causes are the associated values. (.NET only)
Xfmea.GetAllXfmeaCauses Returns an array of XfmeaCause objects that represent the causes associated with a failure.
Xfmea.GetXfmeaCause Returns an XfmeaCause object that represents a given FMEA cause in the current project. Returns nothing if the cause does not exist or is not in the current project.
Xfmea.AddXfmeaCause Adds a new cause to an effect. Returns a Boolean value; when true, indicates a successful save.
Xfmea.UpdateXfmeaCause Updates the properties of a given FMEA cause in the current project. Returns a Boolean value; when true, indicates a successful update.

Project

Name Description
Project.GetAllProjects Returns an array of NameIDPair objects that represent the name and ID pairs of the projects associated with the Repository object.
Project.GetCurrentProject Returns a NameIDPair object that represents the name and ID pair of the current project.
Project.SetCurrentProject Sets the current (active) project for the repository. Returns a Boolean value; when true, indicates a successful connection to that project.

Unit

Name Description
Unit.GetAllUnits Returns an array of UnitInfo objects that represent the units of measurement associated with the Repository object.

Model

Name Description
Model.GetAllModels Returns an array of cModel objects that represent the model resources in the current project.
Model.AddModel Adds a new model resource to the current project. Returns a Boolean value; when true, indicates a successful save.
Model.UpdateModel Updates the properties of a given model resource in the current project. Returns a Boolean value; when true, indicates a successful update.
Model.GetModel Returns a cModel object that represents a given model resource in the current project. Returns nothing if the model does not exist or is not in the current project.
Model.IsModelUsed Checks whether the model is used by other items in the project. Returns a Boolean value; when true, indicates that the model is in use.
Model.DeleteModel Deletes an unused model from the current project. Throws an exception if the model is in use. Returns a Boolean value; when true, indicates a successful deletion.
Model.GetAllModelsInfo   Deprecated   Returns an array of NameIdPair objects that represent the name and ID pairs of the model resources in the current project. This includes internal models automatically created with any new repository (model ID#s 1 to 20).

URD

Name Description
URD.GetAllURDs Returns an array of cURD objects that represent the universal reliability definitions (URDs) in the current project.
URD.AddURD Adds a new universal reliability definition (URD) resource to the current project. Returns a Boolean value; when true, indicates a successful save.
URD.UpdateURD Updates the properties of a given URD resource in the current project. Returns a Boolean value; when true, indicates a successful update.
URD.GetURD Returns a cURD object that represents a given URD resource in the current project. Returns nothing if the URD does not exist or is not in the current project.

Variable

Name Description
Variables.GetAllVariables Returns an array of cVariable objects that represent the variable resources in the current project.
Variables.AddVariable Adds a new variable resource to the current project. Returns a Boolean value; when true, indicates a successful save.
Variables.UpdateVariable Updates the properties of a given variable resource in the current project. Returns a Boolean value; when true, indicates a successful update.
Variables.GetVariable Returns a cVariable object that represents a given variable resource in the current project. Returns nothing if the variable does not exist or is not in the current project.

Task

Name Description
Task.GetAllCorrectiveTasks Returns an array of cCorrectiveTask objects that represent the corrective tasks in the current project.
Task.AddCorrectiveTask Adds a new corrective task to the current project. Returns a Boolean value; when true, indicates a successful save.
Task.UpdateCorrectiveTask Updates the properties of a given corrective task in the current project. Returns a Boolean value; when true, indicates a successful update.
Task.GetCorrectiveTask Returns a cCorrectiveTask object that represents a given corrective task resource in the current project. Returns nothing if the task does not exist or is not in the current project.
Task.GetAllScheduledTasks Returns an array of cScheduledTask objects that represent the scheduled tasks in the current project.
Task.AddScheduledTask Adds a new scheduled task to the current project. Returns a Boolean value; when true, indicates a successful save.
Task.UpdateScheduledTask Updates the properties of a given scheduled task in the current project. Returns a Boolean value; when true, indicates a successful update.
Task.GetScheduledTask Returns a cScheduledTask object that represents a given scheduled task resource in the current project. Returns nothing if the task does not exist or is not in the current project.
Task.GetAllTaskTypes Returns an array of TaskTypeInfo objects that represent the RCM++ or RBI task types associated with the Repository object.

Crew

Name Description
Crew.GetAllCrews Returns an array of cCrew objects that represent the crew resources in the current project.
Crew.AddCrew Adds a new crew resource to the current project. Returns a Boolean value; when true, indicates a successful save.
Crew.UpdateCrew Updates the properties of a given crew resource in the current project. Returns a Boolean value; when true, indicates a successful save.
Crew.GetCrew Returns a cCrew object that represents a given crew resource in the current project. Returns nothing if the crew does not exist or is not in the current project.

Pool

Name Description
Pool.GetAllPools Returns an array of cPool objects that represent the spare part pools in the current project.
Pool.AddPool Adds a new spare part pool to the current project. Returns a Boolean value; when true, indicates indicates a successful save.
Pool.UpdatePool Updates the properties of a given spare part pool in the current project. Returns a Boolean value; when true, indicates a successful update.
Pool.GetPool Returns a cPool object that represents a given spare part pool resource in the current project. Returns nothing if the spare part pool does not exist or is not in the current project.

Action

Name Description
Action.GetAllActionsDictionary Returns a dictionary object that contains all available action resources in the current project. The dictionary syntax is Dictionary(Of Integer, cAction), where the ID numbers are the keys and the cAction objects that represent the action resources are the associated values. (.NET only)
Action.GetAllActions Returns an array of cAction objects that represent the action resources in the current project.
Action.AddAction Adds a new action to the current project. The action description or name must be unique. Returns a Boolean value; when true, indicates a successful save.
Action.UpdateAction Updates the properties of a given action resource in the current project. Returns a Boolean value; when true, indicates a successful update.
Action.GetAction Returns a cAction object that represents a given action resource in the current project. Returns nothing if the action does not exist or is not in the current project.

Control

Name Description
Control.GetAllXfmeaControlsDictionary Returns a dictionary object that contains all available Xfmea controls in the current project. The dictionary syntax is Dictionary (Of Integer, cXfmeaControl), where the ID numbers are the keys and the cXfmeaControl objects that represent the controls are the associated values. (.NET only)
Control.GetAllXfmeaControls Returns an array of cXfmeaControl objects that represent the Xfmea controls in the current project.
Control.AddXfmeaControl Adds a new Xfmea control to the current project. Returns a Boolean value; when true, indicates a successful save.
Control.UpdateXfmeaControl Updates the properties of a given control resource in the current project. Returns a Boolean value; when true, indicates a successful update.
Control.GetXfmeaControl Returns a cXfmeaControl object that represents a given control resource in the current project. Returns nothing if the control does not exist or is not in the current project.

BlockSim

Name Description
BlockSim.ImportBlockSimXMLFile Imports data from an XML file into the current BlockSim project. Returns a Boolean value; when true, indicates a successful import.
BlockSim.ExportBlockSimXMLFile Exports data from the current BlockSim project to a new XML file. Returns a Boolean value; when true, indicates a successful export.

Data Warehouse

Name Description
DataWarehouse.SaveRawDataSet Adds a new Synthesis Data Warehouse (SDW) data collection to the associated Repository object. Returns a Boolean value; when true, indicates a successful save.

XFRACAS

Name Description
XFRACAS.GetAllXFRACASEntities
XFRACAS.ImportXFRACASXML Uploads an import file byte stream for processing and returns the system ID of the uploaded byte array.
XFRACAS.ImportXFRACASXMLFile Uploads an import file for processing and returns the system ID of the uploaded XML file.
XFRACAS.ImportXFRACASXMLString Uploads an import file string for processing and returns the system ID of the uploaded XML string.
XFRACAS.SerializeXMLObjectToByteArray A helper function to create an array of bytes from a serializable XML object.
XFRACAS.ProcessXfracasImports Runs the import process.
XFRACAS.WriteMessageToDiagnosticsLog Writes a message to the diagnostics log
XFRACAS.WriteExceptionToDiagnosticsLog Writes exception information to the diagnostics log
XFRACAS.XFRACASCommandTimeout Gets or sets the wait time before terminating the attempt to execute an XFRACAS command.
XFRACAS.AddSystemMetric1 This can be used to insert reported run hours and the date of the reported run hours.
XFRACAS.AddSystemMetric2 This can be used to insert reported run hours, number of starts, and the date.
XFRACAS.AddSystemMetric3 This can be used to insert reported run hours, number of starts, kw run hours, and the date.

Xfmea

Name Description
Xfmea.GetAllItemsInSystemHierarchyDictionary Returns a dictionary object that contains all available system hierarchy items in the current project. The dictionary syntax is Dictionary(Of Integer, XfmeaItem), where the ID numbers are the keys, and the XfmeaItem objects that represent the system hierarchy items are the associated values. (.NET only)
Xfmea.GetAllItemsInSystemHierarchy Returns an array of XfmeaItem objects that represent the system hierarchy items in the current project.
Xfmea.AddItemToSystemHierarchy Adds a new system hierarchy item to the current project. Returns a Boolean value; when true, indicates a successful save.
Xfmea.UpdateItemInSystemHierarchy Updates the properties of a given system hierarchy item in the current project. Returns a Boolean value; when true, indicates a successful update.
Xfmea.GetAllXfmeaFunctionsDictionary Returns a dictionary object that contains all available FMEA functions associated with a system hierarchy item. The dictionary syntax is Dictionary(Of Integer, XfmeaFunction), where the ID numbers are the keys, and the XfmeaFunction objects that represent the FMEA functions are the associated values. (.NET only)
Xfmea.GetAllXfmeaFunctions Returns an array of XfmeaFunction objects that represent the FMEA functions associated with a system hierarchy item.
Xfmea.GetXfmeaFunction Returns an XfmeaFunction object that represents a given FMEA function in the current project. Returns nothing if the FMEA function does not exist or is not in the current project.
Xfmea.AddXfmeaFunction Adds a new FMEA function to a system hierarchy item. Returns a Boolean value; when true, indicates a successful save.
Xfmea.UpdateXfmeaFunction Updates the properties of a given FMEA function in the current project. Returns a Boolean value; when true, indicates a successful update.
Xfmea.GetAllXfmeaFailuresDictionary Returns a dictionary object that contains all available failures associated with an FMEA function. The dictionary syntax is Dictionary(Of Integer, XfmeaFailure), where the ID numbers are the keys, and the XfmeaFailure objects that represent the failures are the associated values. (.NET only)
Xfmea.GetAllXfmeaFailures Returns an array of XfmeaFailure objects that represent the failures associated with an FMEA function.
Xfmea.GetXfmeaFailure Returns an XfmeaFailure object that represents a given FMEA failure in the current project. Returns nothing if the failure does not exist or is not in the current project.
Xfmea.AddXfmeaFailure Adds a new failure to an FMEA function. Returns a Boolean value; when true, indicates a successful save.
Xfmea.UpdateXfmeaFailure Updates the properties of a given FMEA failure in the current project. Returns a Boolean value; when true, indicates a successful update.
Xfmea.GetAllXfmeaEffectsDictionary Returns a dictionary object that contains all available effects associated with a failure. The dictionary syntax is Dictionary(Of Integer, XfmeaEffect), where the ID numbers are the keys, and the XfmeaEffect objects that represent the effects are the associated values. (.NET only)
Xfmea.GetAllXfmeaEffects Returns an array of XfmeaEffect objects that represent the effects associated with a failure.
Xfmea.GetXfmeaEffect Returns an XfmeaEffect object that represents a given FMEA effect in the current project. Returns nothing if the effect does not exist or is not in the current project.
Xfmea.AddXfmeaEffect Adds a new effect to a failure. Returns a Boolean value; when true, indicates a successful save.
Xfmea.UpdateXfmeaEffect Updates the properties of a given FMEA effect in the current project. Returns a Boolean value; when true, indicates a successful update.
Xfmea.GetAllXfmeaCausesDictionary Returns a dictionary object that contains all available causes associated with a failure. The dictionary syntax is Dictionary(Of Integer, XfmeaCause), where the ID numbers are the keys, and the XfmeaCause objects that represent the causes are the associated values. (.NET only)
Xfmea.GetAllXfmeaCauses Returns an array of XfmeaCause objects that represent the causes associated with a failure.
Xfmea.GetXfmeaCause Returns an XfmeaCause object that represents a given FMEA cause in the current project. Returns nothing if the cause does not exist or is not in the current project.
Xfmea.AddXfmeaCause Adds a new cause to an effect. Returns a Boolean value; when true, indicates a successful save.
Xfmea.UpdateXfmeaCause Updates the properties of a given FMEA cause in the current project. Returns a Boolean value; when true, indicates a successful update.