Difference between revisions of "API Changelog"

From ReliaWiki
Jump to navigation Jump to search
Line 129: Line 129:
  
  
===New properties for all resources (e.g., models, URDs, crews, etc.)===
+
===New properties for all resource object models (e.g., [[cModel Class|cModels]], [[cURD Class|cURDs]], [[cCrew Class|cCrews]], etc.)===
 
{| {{APITable}}
 
{| {{APITable}}
 
|-
 
|-
 
| style="width: 200px;"|{{Template:API_TxtIdentifiers}}
 
| style="width: 200px;"|{{Template:API_TxtIdentifiers}}
 
|}
 
|}
 
  
 
===New property for the [[CModel Class|cModel]] class===
 
===New property for the [[CModel Class|cModel]] class===

Revision as of 17:20, 27 August 2015

DRAFT GRAY.png

WORK IN PROGRESS
API Changelog

DRAFT GRAY.png
APIWiki.png



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 into fields named after the object type they apply to. This means that existing methods in the class have also been moved to the appropriate fields. For example, the Repository.GetAllModels() method, which affects model resources, has been renamed to Repository.Model.GetAllModels(); similarly, Repository.ImportBlockSimXMLFile has been renamed to Repository.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
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.
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.


New methods in the cCorrectiveTask class and cScheduledTask class

Name Description
GetCrewIDs
SetCrewIDs


New properties for all resource object models (e.g., cModels, cURDs, cCrews, 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 numeric ID of the model's unit of measurement. Integer