User:Kate Racaza/APIdraftspage: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(47 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
 
==Leader Pages==
==Updates for 10.1==  
*[[Talk:API_Changelog/Notes]]
'''Changes for Leader Pages'''
**[[Talk:New_Classes_and_Enumerations/Notes]]
**[[Talk:New_Members_and_Constants/Notes]]
**[[Talk:Deprecated_and_Removed_Members/Notes]]
*[[Talk:API_Reference_Documentation/Notes]]
*[[Talk:Synthesis_API_Reference/Notes]]
*[[Talk:Synthesis_API_Reference/Notes]]
*[[Talk:API_Changelog/Notes]]
*[[Talk:API_Tutorials/Notes]]
*[[Talk:New_Classes_and_Enumerations/Notes]]
*[[Talk:New_Members_and_Constants/Notes]]
*[[Talk:Deprecated_and_Removed_Members/Notes]]
*[[Talk:Full_Synthesis_API/Notes]]
 
 
'''Changes for Existing Reference Docs'''
 
Classes


*[[Talk:CPool_Class/Notes]]
*[[Talk:Repository_Class/Notes]]
*[[Talk:XfmeaItem_Class/Notes]]
*[[Talk:CXfmeaControl_Class/Notes]]
*[[Talk:CAction_Class/Notes]]
*[[Talk:CScheduledTask_Class/Notes]]
*[[Talk:Common_Class/Notes]]


Methods
==Drafts for 11==
xxx


*[[Talk:Repository.Model.GetAllModels/Notes]]
*[[Talk:Repository.Model.GetAllModelsInfo/Notes]]
*[[Talk:Repository.Crew.GetAllCrews/Notes]]
*[[Talk:Repository.Pool.GetAllPools/Notes]]
*[[Talk:Repository.Task.GetAllScheduledTasks/Notes]]
*[[Talk:Repository.Task.GetAllCorrectiveTasks/Notes]]
*[[Talk:Repository.URD.GetAllURDs/Notes]]
*[[Talk:Repository.Variable.GetAllVariables/Notes]]


Enums
*[[Talk:Language_Enumeration/Notes]]




==Pending==
==Pending==
The following docs are complete, just need code samples:
*[[ALTAEvents.Question]] - scrapped from V10, wasn't working. If fixed, include in V11.
*[[Repository.XFRACAS.AddSystemMetric1]]
*[[Upload XML File to XFRACAS]] - removed from V11.1.1. Focus is now on web service. A copy of the old content exists in the Notes talk page.
*[[Repository.XFRACAS.AddSystemMetric2]]
*[[Repository.XFRACAS.AddSystemMetric3]]
 
 
Tutorials to write
* How to create new/edit existing FMEA analysis
* XFRACAS XML Import
* BlockSim XML Import
* How to perform W++ analysis on external data.
* How to perform ALTA analysis on external data.
* How to create plots
 
<!--
=Summary=
<div style="border:1px solid #AAA; background:#f9f9f9; border-radius:10px; width:auto; margin:0 0 1em 1em; padding:1em;">
'''New Classes'''
 
'''New Enums'''
*<strike>ResourceFilterEnum_Enumeration - part of SYN-I-4788</strike>
*<strike>RestockOnEnum_Enumeration - part of SYN-I-4849 </strike>
*<strike>TaskMaintenanceTriggerEnum - SYN-I-4920</strike>
 
 
'''New Methods'''
*<strike>[[Repository.Xfmea.GetItemInSystemHierarchy_Method]] - SYN-I-4795</strike>
 
 
'''New Properties'''
*SYN-I-4974
:*<strike>[[CXfmeaControl_Class]]</strike>
:*<strike>[[cAction_Class]]</strike>
 
'''Edits to Existing Methods'''
*SYN-I-4788 (not code breaking)
:*<strike>[[Repository.Model.GetAllModels]]</strike>
:*<strike>[[Repository.Model.GetAllModelsInfo]]</strike>
:*<strike>[[Repository.Crew.GetAllCrews]]</strike>
:*<strike>[[Repository.Pool.GetAllPools]]</strike>
:*<strike>[[Repository.Task.GetAllScheduledTasks]]</strike>
:*<strike>[[Repository.Task.GetAllCorrectiveTasks]]</strike>
:*<strike>[[Repository.URD.GetAllURDs]]</strike>
:*<strike>[[Repository.Variable.GetAllVariables]]</strike>
 
*SYN-I-4864 (not code breaking)
:*<strike>[[Common_Class]]</strike>
 
'''Edits to Existing Properties'''
*SYN-I-4849 (not code breaking)
:*<strike>[[CPool Class]] Restock On property</strike>
 
'''Deprecations'''
*<strike>[[XfmeaItem_Class]] - removed Nr property because it is a duplicate of the PartNr property.</strike>
*<strike>[[CXfmeaControl_Class]] and [[cAction_Class]] - removed Synthesis identifier fields (because not applicable).</strike>
*<strike>[[CScheduledTask_Class]] - removed OnCondPerformTaskEvenIfItBringsSysDown property because not in use (obsolete).</strike>
 
</div>
 
=SYN-I-4788=
<strike>Use this template:
 
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 ===
  '''.Model.GetAllModels'''<span style="color:#FF0000">(''Filter'')</span>
 
====Parameters====
<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.
 
===Example===
Edit the comment:
 
'Get a list of all <span style="color: #FF0000">local models </span> in project #1.</strike>
 
 
 
=SYN-I-4864=
<strike>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)</strike>
 
 
=SYN-I-4849=
 
<strike>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.).</strike>
 
 
 
 
=SYN-I-4974=
<strike>Add the following properties to the class:
{| {{APITable}}
|-
|UT1||Gets or sets the text in the first user-defined text field. '''String'''.
|-
|UT2||Gets or sets the text in the second user-defined text field. '''String'''.
|-
|UT3||Gets or sets the text in the third user-defined text field. '''String'''.
|-
|UT4||Gets or sets the text in the fourth user-defined text field. '''String'''.
|-
|UT5||Gets or sets the text in the fifth user-defined text field. '''String'''.
|}</strike>
-->

Latest revision as of 22:13, 12 April 2017

Leader Pages


Drafts for 11

xxx



Pending

Retrieved from "https://www.reliawiki.com/index.php?title=User:Kate_Racaza/APIdraftspage&oldid=65053"