Difference between revisions of "API Changelog"

From ReliaWiki
Jump to navigation Jump to search
Line 2: Line 2:
  
  
The following is a summary of the changes from Version 9.
+
<!--
  
==Major Changes==
+
==What's New in Synthesis API Version 10==
 
* 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 <code>Repository.GetAllModels()</code> method, which affects model resources, has been renamed to <code>Repository.Model.GetAllModels()</code>; similarly, <code>Repository.ImportBlockSimXMLFile</code> has been renamed to <code>Repository.BlockSim.ImportBlockSimXMLFile</code>, 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.  
 
* 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 <code>Repository.GetAllModels()</code> method, which affects model resources, has been renamed to <code>Repository.Model.GetAllModels()</code>; similarly, <code>Repository.ImportBlockSimXMLFile</code> has been renamed to <code>Repository.BlockSim.ImportBlockSimXMLFile</code>, 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.
 
* 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.
Line 10: Line 10:
  
  
==Minor Changes==
 
*xxx
 
  
 +
For a list of new classes and enumerations, see [[New Classes and Enumerations]].
  
 +
For a list of new methods, properties, events and constants, see [[New Members and Constants]].
  
==What's New==
+
For a list of deprecated, changed or removed members, see [[Deprecated and Removed Members]].
Here's a complete list of all new functionality available in the latest version.
+
-->
 
 
===New methods in the [[Repository Class|Repository]] class===
 
{| {{APITable}}
 
|-
 
| style="width: 240px;"|[[Repository.Model.GetModel|Model.GetModel]]||{{:Repository.Model.GetModel}}
 
|-
 
|[[Repository.Model.IsModelUsed|Model.IsModelUsed]]||{{:Repository.Model.IsModelUsed}}
 
|-
 
|[[Repository.Model.DeleteModel|Model.DeleteModel]]||{{:Repository.Model.DeleteModel}}
 
|-
 
|[[Repository.URD.GetURD|URD.GetURD]]||{{:Repository.URD.GetURD}}
 
|-
 
|[[Repository.Variable.GetVariable|Variables.GetVariable]]||{{:Repository.Variable.GetVariable}}
 
|-
 
|[[Repository.Task.GetCorrectiveTask|Task.GetCorrectiveTask]]||{{:Repository.Task.GetCorrectiveTask}}
 
|-
 
|[[Repository.Task.GetScheduledTask|Task.GetScheduledTask]]||{{:Repository.Task.GetScheduledTask}}
 
|-
 
|[[Repository.Crew.GetCrew|Crew.GetCrew]]||{{:Repository.GetCrew}}
 
|-
 
|[[Repository.Pool.GetPool|Pool.GetPool]]||{{:Repository.Pool.GetPool}}
 
|-
 
| style="width: 240px;"|[[Repository.Action.GetAllActionsDictionary|Action.GetAllActionsDictionary]]||{{:Repository.Action.GetAllActionsDictionary}}
 
|-
 
|[[Repository.Action.GetAction|Action.GetAction]]||{{:Repository.Action.GetAction}}
 
|-
 
| style="width: 240px;"|[[Repository.Control.GetAllXfmeaControlsDictionary|Control.GetAllXfmeaControlsDictionary]]||{{:Repository.Control.GetAllXfmeaControlsDictionary}}
 
|-
 
|[[Repository.Control.GetAllXfmeaControls|Control.GetAllXfmeaControls]]||{{:Repository.Control.GetAllXfmeaControls}}
 
|-
 
|[[Repository.Control.AddXfmeaControl|Control.AddXfmeaControl]]||{{:Repository.Control.AddXfmeaControl}}
 
|-
 
|[[Repository.Control.UpdateXfmeaControl|Control.UpdateXfmeaControl]]||{{:Repository.Control.UpdateXfmeaControl}}
 
|-
 
|[[Repository.Control.GetXfmeaControl|Control.GetXfmeaControl]]||{{:Repository.Control.GetXfmeaControl}}
 
|-
 
|[[Repository.XFRACAS.XFRACASCommandTimeout|XFRACAS.XFRACASCommandTimeout]] ||{{APIComment|Gets or sets the wait time before terminating the attempt to execute an XFRACAS command.}}
 
|-
 
|[[Repository.XFRACAS.AddSystemMetric1|XFRACAS.AddSystemMetric1]] ||{{APIComment|This can be used to insert reported run hours and the date of the reported run hours.}}
 
|-
 
|[[Repository.XFRACAS.AddSystemMetric2|XFRACAS.AddSystemMetric2]]|| {{APIComment|This can be used to insert reported run hours, number of starts, and the date.}}
 
|-
 
|[[Repository.XFRACAS.AddSystemMetric3|XFRACAS.AddSystemMetric3]]|| {{APIComment|This can be used to insert reported run hours, number of starts, kw run hours, and the date.}}
 
|-
 
|[[Repository.Xfmea.GetAllItemsInSystemHierarchyDictionary Method|Xfmea.GetAllItemsInSystemHierarchyDictionary]]|| {{:Repository.Xfmea.GetAllItemsInSystemHierarchyDictionary Method}}
 
|-
 
|[[Repository.Xfmea.GetAllItemsInSystemHierarchy Method|Xfmea.GetAllItemsInSystemHierarchy]]||{{:Repository.Xfmea.GetAllItemsInSystemHierarchy  Method}}
 
|-
 
|[[Repository.Xfmea.AddItemToSystemHierarchy Method|Xfmea.AddItemToSystemHierarchy]]||{{:Repository.Xfmea.AddItemToSystemHierarchy  Method}}
 
|-
 
|[[Repository.Xfmea.UpdateItemInSystemHierarchy Method|Xfmea.UpdateItemInSystemHierarchy]]||{{:Repository.Xfmea.UpdateItemInSystemHierarchy  Method}}
 
|-
 
| style="border-bottom:1pt solid #585858; color:#585858;"|
 
|-
 
|[[Repository.Xfmea.GetAllXfmeaFunctionsDictionary Method|Xfmea.GetAllXfmeaFunctionsDictionary]]||{{:Repository.Xfmea.GetAllXfmeaFunctionsDictionary Method}}
 
|-
 
|[[Repository.Xfmea.GetAllXfmeaFunctions Method|Xfmea.GetAllXfmeaFunctions]]|| {{:Repository.Xfmea.GetAllXfmeaFunctions Method}}
 
|-
 
|[[Repository.Xfmea.GetXfmeaFunction Method|Xfmea.GetXfmeaFunction]]|| {{:Repository.Xfmea.GetXfmeaFunction Method}}
 
|-
 
|[[Repository.Xfmea.AddXfmeaFunction Method|Xfmea.AddXfmeaFunction]]|| {{:Repository.Xfmea.AddXfmeaFunction Method}}
 
|-
 
|[[Repository.Xfmea.UpdateXfmeaFunction Method|Xfmea.UpdateXfmeaFunction]]|| {{:Repository.Xfmea.UpdateXfmeaFunction Method}}
 
|-
 
| style="border-bottom:1pt solid #585858; color:#585858;"|
 
|-
 
|[[Repository.Xfmea.GetAllXfmeaFailuresDictionary Method|Xfmea.GetAllXfmeaFailuresDictionary]]||{{:Repository.Xfmea.GetAllXfmeaFailuresDictionary Method}}
 
|-
 
|[[Repository.Xfmea.GetAllXfmeaFailures Method|Xfmea.GetAllXfmeaFailures]]||{{:Repository.Xfmea.GetAllXfmeaFailures Method}}
 
|-
 
|[[Repository.Xfmea.GetXfmeaFailure Method|Xfmea.GetXfmeaFailure]]||{{:Repository.Xfmea.GetXfmeaFailure Method}}
 
|-
 
|[[Repository.Xfmea.AddXfmeaFailure Method|Xfmea.AddXfmeaFailure]]||{{:Repository.Xfmea.AddXfmeaFailure Method}}
 
|-
 
|[[Repository.Xfmea.UpdateXfmeaFailure Method|Xfmea.UpdateXfmeaFailure]]||{{:Repository.Xfmea.UpdateXfmeaFailure Method}}
 
|-
 
| style="border-bottom:1pt solid #585858; color:#585858;"|
 
|-
 
|[[Repository.Xfmea.GetAllXfmeaEffectsDictionary Method|Xfmea.GetAllXfmeaEffectsDictionary]]||{{:Repository.Xfmea.GetAllXfmeaEffectsDictionary Method}}
 
|-
 
|[[Repository.Xfmea.GetAllXfmeaEffects Method|Xfmea.GetAllXfmeaEffects]]||{{:Repository.Xfmea.GetAllXfmeaEffects Method}}
 
|-
 
|[[Repository.Xfmea.GetXfmeaEffect Method|Xfmea.GetXfmeaEffect]]||{{:Repository.Xfmea.GetXfmeaEffect Method}}
 
|-
 
|[[Repository.Xfmea.AddXfmeaEffect Method|Xfmea.AddXfmeaEffect]]||{{:Repository.Xfmea.AddXfmeaEffect Method}}
 
|-
 
|[[Repository.Xfmea.UpdateXfmeaEffect Method|Xfmea.UpdateXfmeaEffect]]||{{:Repository.Xfmea.UpdateXfmeaEffect Method}}
 
|-
 
| style="border-bottom:1pt solid #585858; color:#585858;"|
 
|-
 
|[[Repository.Xfmea.GetAllXfmeaCausesDictionary Method|Xfmea.GetAllXfmeaCausesDictionary]]||{{:Repository.Xfmea.GetAllXfmeaCausesDictionary Method}}
 
|-
 
|[[Repository.Xfmea.GetAllXfmeaCauses Method|Xfmea.GetAllXfmeaCauses]]||{{:Repository.Xfmea.GetAllXfmeaCauses Method}}
 
|-
 
|[[Repository.Xfmea.GetXfmeaCause Method|Xfmea.GetXfmeaCause]]||{{:Repository.Xfmea.GetXfmeaCause Method}}
 
|-
 
|[[Repository.Xfmea.AddXfmeaCause Method|Xfmea.AddXfmeaCause]]|| {{:Repository.Xfmea.AddXfmeaCause Method}}
 
|-
 
|[[Repository.Xfmea.UpdateXfmeaCause Method|Xfmea.UpdateXfmeaCause]]||{{:Repository.Xfmea.UpdateXfmeaCause Method}}
 
|}
 
 
 
 
 
===New methods in the [[CCorrectiveTask Class|cCorrectiveTask]] class  and [[CScheduledTask Class|cScheduledTask]] class===
 
 
 
{| {{APITable}}
 
|-
 
| style="width: 240px;"|GetCrewIDs
 
|-
 
|SetCrewIDs
 
|}
 
 
 
 
 
===New properties for all resource object models (e.g., [[cModel Class|cModels]], [[cURD Class|cURDs]], [[cCrew Class|cCrews]], etc.)===
 
{| {{APITable}}
 
|-
 
| style="width: 200px;"|{{Template:API_TxtIdentifiers}}
 
|}
 
 
 
===New property for the [[CModel Class|cModel]] class===
 
{| {{APITable}}
 
|-
 
| style="width: 200px;"|Unit ID||Gets or sets the numeric ID of the model's unit of measurement. '''Integer '''
 
|}
 

Revision as of 19:01, 27 August 2015

DRAFT GRAY.png

WORK IN PROGRESS
API Changelog

DRAFT GRAY.png
APIWiki.png