User:Kate Racaza/APIdraftspage: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) (→TOC) |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 6: | Line 6: | ||
'''New Enums''' | '''New Enums''' | ||
*[[ResourceFilterEnum_Enumeration]] - part of SYN-I-4788 | *[[ResourceFilterEnum_Enumeration]] - part of SYN-I-4788 | ||
*[[RestockOnEnum_Enumeration]] - part of SYN-I-4849 | |||
'''New Methods''' | '''New Methods''' | ||
| Line 24: | Line 25: | ||
:*[[Repository.Control.GetAllXfmeaControls]] | :*[[Repository.Control.GetAllXfmeaControls]] | ||
:*[[Repository.Control.GetAllXfmeaControlsDictionary]] | :*[[Repository.Control.GetAllXfmeaControlsDictionary]] | ||
*SYN-I-4864 (non-code breaking) | |||
:*[[Common_Class]] | |||
'''Edits to Existing Properties''' | |||
*SYN-I-4849 (non-code breaking) | |||
:*[[CPool Class]] Restock On property | |||
'''Deprecations''' | '''Deprecations''' | ||
| Line 34: | Line 41: | ||
Gets a <span style="color:#FF0000">list of models </span>associated with a project. Returns a '''[[CModel Class|cModel]]''' object array that contains <span style="color:#FF0000">the models </span>in that project.</onlyinclude> | Gets a <span style="color:#FF0000">list of models </span>associated with a project. Returns a '''[[CModel Class|cModel]]''' object array that contains <span style="color:#FF0000">the models </span>in that project.</onlyinclude> | ||
== Syntax == | === Syntax === | ||
'''.Model.GetAllModels'''<span style="color:#FF0000">(''Filter'')</span> | '''.Model.GetAllModels'''<span style="color:#FF0000">(''Filter'')</span> | ||
===Parameters=== | ====Parameters==== | ||
<span style="color:#FF0000">''Filter''</span> | <span style="color:#FF0000">''Filter''</span> | ||
:Optional. A filter that returns a particular type of <span style="color:#FF0000">model</span> resource (e.g., global only, local and global only, etc.). Can be any [[ResourceFilterEnum_Enumeration|ResourceFilterEnum]] constant. Default value = 0, which returns local <span style="color:#FF0000">models</span> only. | :Optional. A filter that returns a particular type of <span style="color:#FF0000">model</span> resource (e.g., global only, local and global only, etc.). Can be any [[ResourceFilterEnum_Enumeration|ResourceFilterEnum]] constant. Default value = 0, which returns local <span style="color:#FF0000">models</span> only. | ||
== Example == | ===Example=== | ||
Edit the comment: | Edit the comment: | ||
'Get a list of all <span style="color: #FF0000">local models </span> in project #1. | 'Get a list of all <span style="color: #FF0000">local models </span> in project #1. | ||
=SYN-I-4864= | |||
Remove the "VB.NET Only" parenthetical in the definition. | |||
Then add the following example. Add note that in VBA, you'll need to instantiate the class. | |||
'''VBA''' | |||
{{APIComment|'Set the API's language to Portuguese}} | |||
{{APIPrefix|Dim}} Lng {{APIPrefix|As New}} cLanguage | |||
Lng.SetLanguage (Language_Portuguese) | |||
{{APIComment|'The following code triggers the Synthesis repository to return an error message.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIPrefix|Dim}} m {{APIPrefix|As New}} cModel | |||
MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}}) | |||
m = MyRepository.Model.GetModel(47) | |||
=SYN-I-4849= | |||
Update definition of RestockOn property: | |||
Gets or sets a value from the [[RestockOnEnum Enumeration|RestockOnEnum]] enumeration, which specifies the pool's restock property (e.g. restock as needed, restock as scheduled, etc.). | |||
Revision as of 20:51, 4 November 2015
Summary
New Classes
New Enums
- ResourceFilterEnum_Enumeration - part of SYN-I-4788
- RestockOnEnum_Enumeration - part of SYN-I-4849
New Methods
- Repository.Xfmea.GetItemInSystemHierarchy_Method - SYN-I-4795
Edits to Existing Methods
- SYN-I-4788 (non code-breaking)
- Repository.Model.GetAllModels
- Repository.Model.GetAllModelsInfo
- Repository.Action.GetAllActions
- Repository.Action.GetAllActionsDictionary
- Repository.Crew.GetAllCrews
- Repository.Pool.GetAllPools
- Repository.Task.GetAllScheduledTasks
- Repository.Task.GetAllCorrectiveTasks
- Repository.URD.GetAllURDs
- Repository.Variable.GetAllVariables
- Repository.Control.GetAllXfmeaControls
- Repository.Control.GetAllXfmeaControlsDictionary
- SYN-I-4864 (non-code breaking)
Edits to Existing Properties
- SYN-I-4849 (non-code breaking)
- CPool Class Restock On property
Deprecations none
SYN-I-4788
Use this template:
Gets a list of models associated with a project. Returns a cModel object array that contains the models in that project.
Syntax
.Model.GetAllModels(Filter)
Parameters
Filter
- Optional. A filter that returns a particular type of model resource (e.g., global only, local and global only, etc.). Can be any ResourceFilterEnum constant. Default value = 0, which returns local models only.
Example
Edit the comment:
'Get a list of all local models in project #1.
SYN-I-4864
Remove the "VB.NET Only" parenthetical in the definition.
Then add the following example. Add note that in VBA, you'll need to instantiate the class.
VBA 'Set the API's language to Portuguese Dim Lng As New cLanguage Lng.SetLanguage (Language_Portuguese) 'The following code triggers the Synthesis repository to return an error message. Dim MyRepository As New Repository Dim m As New cModel MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10") m = MyRepository.Model.GetModel(47)
SYN-I-4849
Update definition of RestockOn property:
Gets or sets a value from the RestockOnEnum enumeration, which specifies the pool's restock property (e.g. restock as needed, restock as scheduled, etc.).