API Changelog
Jump to navigation
Jump to search
The following is a summary of the changes from Version 9.
Major Changes
- We've added several new methods to the Repository class and organized them according to the object type they apply to. This means that existing methods in the class have also been moved to the appropriate sections. For example,
Repository.GetAllModels()
is nowRepository.Model.GetAllModels()
; similarly,Repository.ImportBlockSimXMLFile
is nowRepository.BlockSim.ImportBlockSimXMLFile
, etc. The Version 9 methods still exist so your code is not broken, but they are deprecated and may be removed in future versions of the API. - In Version 9, you had to get all of a single resource (e.g., all models) from a repository before you could update a single one. In the latest version, we've added new methods that allow you to get just a single resource from the repository and update it.
- We've added new methods that allow access to FMEA and related data from Xfmea/RCM++/RBI.
Minor Changes
- xxx
What's New
Here's a complete list of all new functionality available in the latest version.
New methods in the Repository class
Name | Description |
---|---|
Repository.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. |
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. |
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.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.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. |
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.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.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.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.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. |
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. |
New properties for all resources (e.g., models, URDs, crews, etc.)
Name | Description |
---|---|
ItemApplication | Gets or sets the item's application. (Synthesis identifier) String |
ItemCategoryID | Gets or sets the category ID. (Synthesis identifier) Integer |
ItemComments | Gets or sets the comments. (Synthesis identifier) String |
ItemDescription | Gets or sets the description. (Synthesis identifier) String |
ItemKeywords | Gets or sets the keywords. (Synthesis identifier) String |
ItemPartNumber | Gets or sets the part number. (Synthesis identifier) String |
ItemSupplier | Gets or sets the supplier name. (Synthesis identifier) String |
ItemVersion | Gets or sets the version number. (Synthesis identifier) String |
New property for the cModel class
Name | Description |
---|---|
Unit ID | Gets or sets the model's unit ID number. Integer |