Repository Class: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) mNo edit summary |
No edit summary |
||
(27 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{Template: | {{Template:API}}{{Template:APIBreadcrumb}}<div style="border:1px solid #D0CDE8; background:#EEEDF7; border-radius:10px; width:auto; margin:0 0 1em 1em; padding:1em; float:right;"><span style="font-family:arial;font-size:5;color:#585858">Other Versions: [[Repository Class 10|Version 10]]</span></div> | ||
Represents a Synthesis | Represents a Synthesis repository. | ||
'''Remarks''': Use any of the first four methods to establish a connection to a Synthesis repository. Once you have a connection, you can use any of the rest of the methods to read/write data to the repository. | |||
==Constructors== | ==Constructors== | ||
{| {{APITable}} | {| {{APITable}} | ||
Line 25: | Line 26: | ||
|- | |- | ||
|[[Repository.DisconnectFromRepository|DisconnectFromRepository]]||{{:Repository.DisconnectFromRepository}} | |[[Repository.DisconnectFromRepository|DisconnectFromRepository]]||{{:Repository.DisconnectFromRepository}} | ||
|} | |} | ||
===Action=== | ===<span style="color:#585858">Action</span>=== | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
Line 40: | Line 39: | ||
|- | |- | ||
|[[Repository.Action.GetAllActionsDictionary|Action.GetAllActionsDictionary]]||{{:Repository.Action.GetAllActionsDictionary}} | |[[Repository.Action.GetAllActionsDictionary|Action.GetAllActionsDictionary]]||{{:Repository.Action.GetAllActionsDictionary}} | ||
|- | |||
|[[Repository.Action.GetFMEAActionLocatorLinkPath|Action.GetFMEAActionLocatorLinkPath]]||{{:Repository.Action.GetFMEAActionLocatorLinkPath}} | |||
|- | |- | ||
|[[Repository.Action.UpdateAction|Action.UpdateAction]]||{{:Repository.Action.UpdateAction}} | |[[Repository.Action.UpdateAction|Action.UpdateAction]]||{{:Repository.Action.UpdateAction}} | ||
Line 45: | Line 46: | ||
===BlockSim=== | ===<span style="color:#585858">BlockSim</span>=== | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
| style="width: 240px;"|[[Repository.BlockSim.ExportBlockSimXMLFile|BlockSim.ExportBlockSimXMLFile]]||{{:Repository.BlockSim.ExportBlockSimXMLFile}} | | style="width: 240px;"|[[Repository.BlockSim.ExportBlockSimXMLFile|BlockSim.ExportBlockSimXMLFile]]||{{:Repository.BlockSim.ExportBlockSimXMLFile}} | ||
|- | |||
|[[Repository.BlockSim.GetAllFaultTrees|BlockSim.GetAllFaultTrees]]||{{:Repository.BlockSim.GetAllFaultTrees}} | |||
|- | |||
|[[Repository.BlockSim.GetAllRBDBlocksData|BlockSim.GetAllRBDBlocksData]]||{{:Repository.BlockSim.GetAllRBDBlocksData}} | |||
|- | |||
|[[Repository.BlockSim.GetAllRBDs|BlockSim.GetAllRBDs]]||{{:Repository.BlockSim.GetAllRBDs}} | |||
|- | |||
|[[Repository.BlockSim.GetRBDBlockData|BlockSim.GetRBDBlockData]]||{{:Repository.BlockSim.GetRBDBlockData}} | |||
|- | |- | ||
|[[Repository.BlockSim.ImportBlockSimXMLFile|BlockSim.ImportBlockSimXMLFile]]||{{:Repository.BlockSim.ImportBlockSimXMLFile}} | |[[Repository.BlockSim.ImportBlockSimXMLFile|BlockSim.ImportBlockSimXMLFile]]||{{:Repository.BlockSim.ImportBlockSimXMLFile}} | ||
|- | |||
|[[Repository.BlockSim.UpdateRBDBlockData|BlockSim.UpdateRBDBlockData]]||{{:Repository.BlockSim.UpdateRBDBlockData}} | |||
|} | |} | ||
===Control=== | ===<span style="color:#585858">Control</span>=== | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
Line 69: | Line 80: | ||
===Crew=== | ===<span style="color:#585858">Crew</span>=== | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
Line 82: | Line 93: | ||
===Data Warehouse=== | ===<span style="color:#585858">Data Warehouse</span>=== | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
Line 89: | Line 100: | ||
===Model=== | ===<span style="color:#585858">Model</span>=== | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
Line 108: | Line 119: | ||
===Pool=== | ===<span style="color:#585858">Pool</span>=== | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
Line 121: | Line 132: | ||
===Project=== | ===<span style="color:#585858">Profiles</span>=== | ||
{| {{APITable}} | |||
|- | |||
| style="width: 240px;"|[[Repository.Profile.AddProfile|Profile.AddProfile]]||{{:Repository.Profile.AddProfile}} | |||
|- | |||
|[[Repository.Profile.GetProfile|Profile.GetProfile]]||{{:Repository.Profile.GetProfile}} | |||
|- | |||
|[[Repository.Profile.GetAllProfiles|Profile.GetAllProfiles]]||{{:Repository.Profile.GetAllProfiles}} | |||
|- | |||
|[[Repository.Profile.UpdateProfile|Profile.UpdateProfile]]||{{:Repository.Profile.UpdateProfile}} | |||
|} | |||
===<span style="color:#585858">Project</span>=== | |||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
Line 127: | Line 151: | ||
|- | |- | ||
|[[Repository.Project.GetCurrentProject|Project.GetCurrentProject]]||{{:Repository.Project.GetCurrentProject}} | |[[Repository.Project.GetCurrentProject|Project.GetCurrentProject]]||{{:Repository.Project.GetCurrentProject}} | ||
|- | |||
|[[Repository.Project.GetUserAccessibleProjects|Project.GetUserAccessibleProjects]]||{{:Repository.Project.GetUserAccessibleProjects}} | |||
|- | |||
|[[Repository.Project.GetUserPermissions|Project.GetUserPermissions]]||{{:Repository.Project.GetUserPermissions}} | |||
|- | |- | ||
|[[Repository.Project.SetCurrentProject|Project.SetCurrentProject]]||{{:Repository.Project.SetCurrentProject}} | |[[Repository.Project.SetCurrentProject|Project.SetCurrentProject]]||{{:Repository.Project.SetCurrentProject}} | ||
|} | |} | ||
===<span style="color:#585858">Task</span>=== | |||
===Task=== | |||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
Line 155: | Line 182: | ||
===Unit=== | ===<span style="color:#585858">Unit</span>=== | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
Line 162: | Line 189: | ||
===URD=== | ===<span style="color:#585858">URD</span>=== | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
Line 175: | Line 202: | ||
===Variable=== | ===<span style="color:#585858">Variable</span>=== | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
Line 188: | Line 215: | ||
=== | ===<span style="color:#585858">XFMEA</span>=== | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
Line 220: | Line 247: | ||
|- | |- | ||
|[[Repository.Xfmea.GetAllXfmeaFunctionsDictionary Method|Xfmea.GetAllXfmeaFunctionsDictionary]]||{{:Repository.Xfmea.GetAllXfmeaFunctionsDictionary Method}} | |[[Repository.Xfmea.GetAllXfmeaFunctionsDictionary Method|Xfmea.GetAllXfmeaFunctionsDictionary]]||{{:Repository.Xfmea.GetAllXfmeaFunctionsDictionary Method}} | ||
|- | |||
|[[Repository.Xfmea.GetItemInSystemHierarchy_Method|Xfmea.GetItemInSystemHierarchy]]||{{:Repository.Xfmea.GetItemInSystemHierarchy_Method}} | |||
|- | |- | ||
|[[Repository.Xfmea.GetXfmeaCause Method|Xfmea.GetXfmeaCause]]||{{:Repository.Xfmea.GetXfmeaCause Method}} | |[[Repository.Xfmea.GetXfmeaCause Method|Xfmea.GetXfmeaCause]]||{{:Repository.Xfmea.GetXfmeaCause Method}} | ||
Line 238: | Line 267: | ||
|- | |- | ||
|[[Repository.Xfmea.UpdateXfmeaFunction Method|Xfmea.UpdateXfmeaFunction]]|| {{:Repository.Xfmea.UpdateXfmeaFunction Method}} | |[[Repository.Xfmea.UpdateXfmeaFunction Method|Xfmea.UpdateXfmeaFunction]]|| {{:Repository.Xfmea.UpdateXfmeaFunction Method}} | ||
|- | |||
|[[Repository.Xfmea.AssignActionToXfmeaCause Method|Xfmea.AssignActionToXfmeaCause]]|| {{:Repository.Xfmea.AssignActionToXfmeaCause Method}} | |||
|- | |||
|[[Repository.Xfmea.AssignControlToXfmeaCause Method|Xfmea.AssignControlToXfmeaCause]]|| {{:Repository.Xfmea.AssignControlToXfmeaCause Method}} | |||
|- | |||
|[[Repository.Xfmea.GetXfmeaCauseActions Method|Xfmea.GetXfmeaCauseActions]]|| {{:Repository.Xfmea.GetXfmeaCauseActions Method}} | |||
|- | |||
|[[Repository.Xfmea.GetXfmeaCauseActionsDictionary Method|Xfmea.GetXfmeaCauseActionsDictionary]]|| {{:Repository.Xfmea.GetXfmeaCauseActionsDictionary Method}} | |||
|- | |||
|[[Repository.Xfmea.GetXfmeaCauseControls Method|Xfmea.GetXfmeaCauseControls]]|| {{:Repository.Xfmea.GetXfmeaCauseControls Method}} | |||
|- | |||
|[[Repository.Xfmea.GetXfmeaCauseControlsDictionary Method|Xfmea.GetXfmeaCauseControlsDictionary]]|| {{:Repository.Xfmea.GetXfmeaCauseControlsDictionary Method}} | |||
|} | |} | ||
===XFRACAS=== | ===<span style="color:#585858">XFRACAS</span>=== | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
| style="width: 240px;"| | | style="width: 240px;"| | ||
|- | |- | ||
|[[Repository.XFRACAS.AddSystemMetric1|XFRACAS.AddSystemMetric1]] ||{{ | |[[Repository.XFRACAS.AddSystemMetric1|XFRACAS.AddSystemMetric1]] ||{{:Repository.XFRACAS.AddSystemMetric1}} | ||
|- | |- | ||
|[[Repository.XFRACAS.AddSystemMetric2|XFRACAS.AddSystemMetric2]]|| {{ | |[[Repository.XFRACAS.AddSystemMetric2|XFRACAS.AddSystemMetric2]]||{{:Repository.XFRACAS.AddSystemMetric2}} | ||
|- | |- | ||
|[[Repository.XFRACAS.AddSystemMetric3|XFRACAS.AddSystemMetric3]]|| {{ | |[[Repository.XFRACAS.AddSystemMetric3|XFRACAS.AddSystemMetric3]]||{{:Repository.XFRACAS.AddSystemMetric3}} | ||
|- | |- | ||
|[[Repository.XFRACAS.GetAllXFRACASEntities|XFRACAS.GetAllXFRACASEntities]]|| {{ | |[[Repository.XFRACAS.GetAllXFRACASEntities|XFRACAS.GetAllXFRACASEntities]]|| {{:Repository.XFRACAS.GetAllXFRACASEntities}} | ||
|- | |- | ||
|[[Repository.XFRACAS.ImportXFRACASXML|XFRACAS.ImportXFRACASXML]]|| {{ | |[[Repository.XFRACAS.ImportXFRACASXML|XFRACAS.ImportXFRACASXML]]|| {{:Repository.XFRACAS.ImportXFRACASXML}} | ||
|- | |- | ||
|[[Repository.XFRACAS.ImportXFRACASXMLFile|XFRACAS.ImportXFRACASXMLFile]]|| {{ | |[[Repository.XFRACAS.ImportXFRACASXMLFile|XFRACAS.ImportXFRACASXMLFile]]|| {{:Repository.XFRACAS.ImportXFRACASXMLFile}} | ||
|- | |- | ||
|[[Repository.XFRACAS.ImportXFRACASXMLString|XFRACAS.ImportXFRACASXMLString]] ||{{ | |[[Repository.XFRACAS.ImportXFRACASXMLString|XFRACAS.ImportXFRACASXMLString]] ||{{:Repository.XFRACAS.ImportXFRACASXMLString}} | ||
|- | |- | ||
|[[Repository.XFRACAS.ProcessXfracasImports|XFRACAS.ProcessXfracasImports]]|| {{ | |[[Repository.XFRACAS.ProcessXfracasImports|XFRACAS.ProcessXfracasImports]]|| {{:Repository.XFRACAS.ProcessXfracasImports}} | ||
|- | |- | ||
|[[Repository.XFRACAS.SerializeXMLObjectToByteArray|XFRACAS.SerializeXMLObjectToByteArray]]|| {{ | |[[Repository.XFRACAS.SerializeXMLObjectToByteArray|XFRACAS.SerializeXMLObjectToByteArray]]||{{:Repository.XFRACAS.SerializeXMLObjectToByteArray}} | ||
|- | |- | ||
|[[Repository.XFRACAS.WriteExceptionToDiagnosticsLog|XFRACAS.WriteExceptionToDiagnosticsLog]] ||{{ | |[[Repository.XFRACAS.WriteExceptionToDiagnosticsLog|XFRACAS.WriteExceptionToDiagnosticsLog]]||{{:Repository.XFRACAS.WriteExceptionToDiagnosticsLog}} | ||
|- | |- | ||
|[[Repository.XFRACAS.WriteMessageToDiagnosticsLog|XFRACAS.WriteMessageToDiagnosticsLog]]||{{ | |[[Repository.XFRACAS.WriteMessageToDiagnosticsLog|XFRACAS.WriteMessageToDiagnosticsLog]]||{{:Repository.XFRACAS.WriteMessageToDiagnosticsLog}} | ||
|} | |||
==Properties== | |||
{| {{APITable}} | |||
|- | |||
| style="width: 250px;"|EnforceRENOCompliance||Indicates whether spaces and special characters are allowed in the names of models created via the Synthesis API. '''Boolean'''. Default value = True. | |||
|- | |||
|Use Events||Indicates whether to enable user-defined event procedures for the <code>Repository</code> object. '''Boolean'''. Default value = False. | |||
|- | |||
|XFRACAS.XFRACASCommandTimeout||Gets or sets the wait time in seconds before terminating the attempt to execute an XFRACAS command. '''Integer'''. | |||
|} | |||
==Events== | |||
{| {{APITable}} | |||
|- | |- | ||
|[[Repository. | | style="width: 250px;"|[[Repository.Message|Message]]||{{:Repository.Message}} | ||
|} | |} |
Latest revision as of 23:53, 13 March 2019
Member of: SynthesisAPI
Other Versions: Version 10
Represents a Synthesis repository.
Remarks: Use any of the first four methods to establish a connection to a Synthesis repository. Once you have a connection, you can use any of the rest of the methods to read/write data to the repository.
Constructors
Name | Description |
---|---|
Repository | Creates an instance of the Repository class. |
Methods
Name | Description |
---|---|
ConnectToAccessRepository | Connects to a standard repository (cannot be used to connect to an enterprise repository). Returns a Boolean value; when true, indicates a successful connection to the repository. |
ConnectToOracleRepository | Connects to an Oracle repository. Returns a Boolean value; when true, indicates a successful connection to the repository. |
ConnectToRepository | Connects to a standard or enterprise repository. Returns a Boolean value; when true, indicates a successful connection to the repository. |
ConnectToSQLRepository | Connects to a SQL Server repository. Returns a Boolean value; when true, indicates a successful connection to the repository. |
DisconnectFromRepository | Disconnects from the current repository. |
Action
Name | Description |
---|---|
Action.AddAction | Adds a new action to the current project. The action description or name must be unique. Returns a Boolean value; when true, indicates a successful save. |
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. |
Action.GetAllActions | Returns an array of cAction objects that represent the action resources 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.GetFMEAActionLocatorLinkPath | Creates a locator link file for the action and returns the path. |
Action.UpdateAction | Updates the properties of a given action resource in the current project. Returns a Boolean value; when true, indicates a successful update. |
BlockSim
Name | Description |
---|---|
BlockSim.ExportBlockSimXMLFile | Exports data from the current BlockSim project to a new XML file. Returns a Boolean value; when true, indicates a successful export. |
BlockSim.GetAllFaultTrees | Gets a list of all BlockSim fault trees associated with a project. Returns a NameIdPair object that represents the name and ID pairs of the fault trees. |
BlockSim.GetAllRBDBlocksData | Gets an array containing the data of all blocks in a BlockSim reliability block diagram (RBD) or fault tree. Returns an RBDBlockData object that represents the properties of each block. |
BlockSim.GetAllRBDs | Gets a list of all BlockSim reliability block diagrams (RBDs) associated with a project. Returns a NameIdPair object that represents the name and ID pairs of the RBDs. |
BlockSim.GetRBDBlockData | Returns an RBDBlockData object that represents the properties of a BlockSim block. |
BlockSim.ImportBlockSimXMLFile | Imports data from an XML file into the current BlockSim project. Returns a Boolean value; when true, indicates a successful import. |
BlockSim.UpdateRBDBlockData | Sends any changes made to a BlockSim block to the Synthesis repository. Returns a Boolean value; when true, indicates a successful save. |
Control
Name | Description |
---|---|
Control.AddXfmeaControl | Adds a new Xfmea control to the current project. Returns a Boolean value; when true, indicates a successful save. |
Control.GetAllXfmeaControls | Returns an array of cXfmeaControl objects that represent the Xfmea controls 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.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. |
Control.UpdateXfmeaControl | Updates the properties of a given control resource in the current project. Returns a Boolean value; when true, indicates a successful update. |
Crew
Name | Description |
---|---|
Crew.AddCrew | Adds a new crew resource to the current project. Returns a Boolean value; when true, indicates a successful save. |
Crew.GetAllCrews | Returns an array of cCrew objects that represent the crew resources 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. |
Crew.UpdateCrew | Updates the properties of a given crew resource in the current project. Returns a Boolean value; when true, indicates a successful save. |
Data Warehouse
Name | Description |
---|---|
DataWarehouse.SaveRawDataSet | Adds a new Synthesis Data Warehouse (SDW) data collection to the associated Repository object. Returns a Boolean value; when true, indicates a successful save. |
Model
Name | Description |
---|---|
Model.AddModel | Adds a new model resource to the current project. Returns a Boolean value; when true, indicates a successful save. |
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. |
Model.GetAllModels | Returns an array of cModel objects that represent the model resources in the current project. |
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.UpdateModel | Updates the properties of a given model resource in the current project. Returns a Boolean value; when true, indicates a successful update. |
Model.GetAllModelsInfo | Deprecated Returns an array of NameIdPair objects that represent the name and ID pairs of the model resources in the current project. This includes internal models automatically created with any new repository (model ID#s 1 to 20). |
Pool
Name | Description |
---|---|
Pool.AddPool | Adds a new spare part pool to the current project. Returns a Boolean value; when true, indicates indicates a successful save. |
Pool.GetAllPools | Returns an array of cPool objects that represent the spare part pools 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. |
Pool.UpdatePool | Updates the properties of a given spare part pool in the current project. Returns a Boolean value; when true, indicates a successful update. |
Profiles
Name | Description |
---|---|
Profile.AddProfile | Adds a new profile resource to the current project. Returns a Boolean value; when true, indicates a successful save. |
Profile.GetProfile | Returns a cProfile object that represents a given profile resource in the current project. Returns nothing if the profile does not exist or is not in the current project. |
Profile.GetAllProfiles | Returns an array of cProfile objects that represent the profile resources in the current project. |
Profile.UpdateProfile | Updates the properties of a given profile resource in the current project. Returns a Boolean value; when true, indicates a successful update. |
Project
Name | Description |
---|---|
Project.GetAllProjects | Returns an array of NameIDPair objects that represent the name and ID pairs of the projects associated with the Repository object. |
Project.GetCurrentProject | Returns a NameIDPair object that represents the name and ID pair of the current project. |
Project.GetUserAccessibleProjects | Returns an array of NameIDPair objects containing all project names and their IDs from the current repository to which the user has access. Connected user must have Admin permissions to obtain the list of projects for another user. Admin permissions are not required to obtain a list of project for your own account. |
Project.GetUserPermissions | Returns an array of UserPermissionEnum of all permissions the user has for the specified project. Connected user must have Admin permissions to obtain the list of permissions for another user. Admin permissions are not required to a list of permissions for your own account. |
Project.SetCurrentProject | Sets the current (active) project for the repository. Returns a Boolean value; when true, indicates a successful connection to that project. |
Task
Name | Description |
---|---|
Task.AddCorrectiveTask | Adds a new corrective task to the current project. Returns a Boolean value; when true, indicates a successful save. |
Task.AddScheduledTask | Adds a new scheduled task to the current project. Returns a Boolean value; when true, indicates a successful save. |
Task.GetAllCorrectiveTasks | Returns an array of cCorrectiveTask objects that represent the corrective tasks in the current project. |
Task.GetAllScheduledTasks | Returns an array of cScheduledTask objects that represent the scheduled tasks in the current project. |
Task.GetAllTaskTypes | Returns an array of TaskTypeInfo objects that represent the RCM++ or RBI task types associated with the Repository object.
|
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. |
Task.UpdateCorrectiveTask | Updates the properties of a given corrective task in the current project. Returns a Boolean value; when true, indicates a successful update. |
Task.UpdateScheduledTask | Updates the properties of a given scheduled task in the current project. Returns a Boolean value; when true, indicates a successful update. |
Unit
Name | Description |
---|---|
Unit.GetAllUnits | Returns an array of UnitInfo objects that represent the units of measurement associated with the Repository object. |
URD
Name | Description |
---|---|
URD.AddURD | Adds a new universal reliability definition (URD) resource to the current project. Returns a Boolean value; when true, indicates a successful save. |
URD.GetAllURDs | Returns an array of cURD objects that represent the universal reliability definitions (URDs) in the current project. |
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. |
URD.UpdateURD | Updates the properties of a given URD resource in the current project. Returns a Boolean value; when true, indicates a successful update. |
Variable
Name | Description |
---|---|
Variables.AddVariable | Adds a new variable resource to the current project. Returns a Boolean value; when true, indicates a successful save. |
Variables.GetAllVariables | Returns an array of cVariable objects that represent the variable resources 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. |
Variables.UpdateVariable | Updates the properties of a given variable resource in the current project. Returns a Boolean value; when true, indicates a successful update. |
XFMEA
Name | Description |
---|---|
Xfmea.AddItemToSystemHierarchy | Adds a new system hierarchy item to the current project. Returns a Boolean value; when true, indicates a successful save. |
Xfmea.AddXfmeaCause | Adds a new cause to an effect. Returns a Boolean value; when true, indicates a successful save. |
Xfmea.AddXfmeaEffect | Adds a new effect to a failure. Returns a Boolean value; when true, indicates a successful save. |
Xfmea.AddXfmeaFailure | Adds a new failure to an FMEA function. Returns a Boolean value; when true, indicates a successful save. |
Xfmea.AddXfmeaFunction | Adds a new FMEA function to a system hierarchy item. Returns a Boolean value; when true, indicates a successful save. |
Xfmea.GetAllItemsInSystemHierarchy | Returns an array of XfmeaItem objects that represent the system hierarchy items in the current project. |
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.GetAllXfmeaCauses | Returns an array of XfmeaCause objects that represent the causes associated with a failure. |
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.GetAllXfmeaEffects | Returns an array of XfmeaEffect objects that represent the effects associated with a failure. |
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.GetAllXfmeaFailures | Returns an array of XfmeaFailure objects that represent the failures associated with an FMEA function. |
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.GetAllXfmeaFunctions | Returns an array of XfmeaFunction objects that represent the FMEA functions associated with a system hierarchy item. |
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.GetItemInSystemHierarchy | Returns an XfmeaItem object that represents a given system hierarchy item in the current project. |
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.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.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.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.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.UpdateXfmeaCause | Updates the properties of a given FMEA cause in the current project. Returns a Boolean value; when true, indicates a successful update. |
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.UpdateXfmeaFailure | Updates the properties of a given FMEA failure in the current project. Returns a Boolean value; when true, indicates a successful update. |
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.AssignActionToXfmeaCause | Assigns an action to a cause. Returns a Boolean value; when true, indicates the action was assigned successfully. |
Xfmea.AssignControlToXfmeaCause | Assigns a control to a cause. Returns a Boolean value; when true, indicates the control was assigned successfully. |
Xfmea.GetXfmeaCauseActions | Returns an array cActions objects for all actions associated to the specified Cause ID. |
Xfmea.GetXfmeaCauseActionsDictionary | Returns a dictionary object containing all actions (cAction) currently assigned to a certain cause 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) |
Xfmea.GetXfmeaCauseControls | Returns an array of cXfmeaControl objects that represent the associated controls for the specified Cause ID in the current project. |
Xfmea.GetXfmeaCauseControlsDictionary | Returns a dictionary object containing all controls (cXfmeaControl) currently assigned to a certain cause 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 control resources are the associated values. (.NET only) |
XFRACAS
Name | Description |
---|---|
XFRACAS.AddSystemMetric1 | Inserts the time/usage value reported on a particular date for a particular serialized system (Metric 1 only). |
XFRACAS.AddSystemMetric2 | Inserts the time/usage values reported on a particular date for a particular serialized system (Metric 1 and 2). |
XFRACAS.AddSystemMetric3 | Inserts the time/usage values reported on a particular date for a particular serialized system (Metric 1, 2 and 3). |
XFRACAS.GetAllXFRACASEntities | Returns an array of NameIDPair objects (effectively Dictionaries) that represent the name and ID pairs of the XFRACAS entities in the database. |
XFRACAS.ImportXFRACASXML | Uploads the XML byte array to the XFRACAS import queue. Returns an Integer that represents the record ID of the byte array. |
XFRACAS.ImportXFRACASXMLFile | Uploads the XML file to the XFRACAS import queue. Returns an Integer that represents the import file's record ID. |
XFRACAS.ImportXFRACASXMLString | Uploads the XML string to the XFRACAS import queue. Returns an Integer that represents the import file's record ID. |
XFRACAS.ProcessXfracasImports | Immediately processes all XML files in the XFRACAS import queue. |
XFRACAS.SerializeXMLObjectToByteArray | Serializes the XML file for import into XFRACAS. Returns a Boolean value; when true, indicates a successful serialization. |
XFRACAS.WriteExceptionToDiagnosticsLog | Writes exception information to the XFRACAS diagnostics log. |
XFRACAS.WriteMessageToDiagnosticsLog | Writes a message to the XFRACAS diagnostics log. |
Properties
Name | Description |
---|---|
EnforceRENOCompliance | Indicates whether spaces and special characters are allowed in the names of models created via the Synthesis API. Boolean. Default value = True. |
Use Events | Indicates whether to enable user-defined event procedures for the Repository object. Boolean. Default value = False.
|
XFRACAS.XFRACASCommandTimeout | Gets or sets the wait time in seconds before terminating the attempt to execute an XFRACAS command. Integer. |
Events
Name | Description |
---|---|
Message | Occurs when an error is produced. Displays an error message. |