Repository Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Undo revision 54538 by Chris Kahn (Talk))
Line 89: Line 89:
== Usage Example ==
== Usage Example ==
In this usage example, the API is used to connect to a repository, retrieve one of the models in it and then calculate the reliability at a specified time, based on that model.
In this usage example, the API is used to connect to a repository, retrieve one of the models in it and then calculate the reliability at a specified time, based on that model.
  {{APIComment|'Declare a new repository connection class.}}
  {{APIComment|'Declare a new repository connection object.}}
{{Template:Repository.Ex}}
{{Template:Repository.Ex}}

Revision as of 22:01, 27 May 2014


Template:Repository Class.Cmt

Constructors

  • Repository Creates a new Repository object for connecting to Synthesis repositories.

Methods

Connect to / Disconnect from Repository

Project

Units of Measurement

  • GetAllUnits Returns an array containing all units of measurement from the current repository.

Models

  • GetAllModelsInfo Returns an array containing all model names and their IDs from the current project.
  • GetModel( Integer ) Returns the model from the current project with the specified ID. Returns nothing if the model does not exist or is not in the current project.
  • GetAllModels Returns an array containing all models from the current project.
  • AddModel( cModel ) Saves a new model in the repository.
  • UpdateModel( cModel ) Updates the model in the repository.

URDs

Variables

Corrective Tasks

Scheduled Tasks

Task Types

  • GetAllTaskTypes Retuns an array containing all task types in the repository.

Crews

Pools

Action

BlockSim

Reliability Data Warehouse (RDW)

XFRACAS

Properties

Synthesis Setup Option

  • EnforceRENOCompliance (as boolean) Disallows spaces and special characters in names of models and analysis workbooks. This will ensure that all models and analysis workbooks can be used in RENO equations.

Usage Example

In this usage example, the API is used to connect to a repository, retrieve one of the models in it and then calculate the reliability at a specified time, based on that model.

 'Declare a new repository connection object. 
 Dim MyRepository As New Repository
 
 'Connect to a Synthesis repository. 
 Dim Success As Boolean = False
 Success = MyRepository.ConnectToRepository("C:\Users\Name\Documents\ReliaSoft\Files\repository.rsr10")
 
 'Get a list of the names/IDs of projects in the connected repository. 
 Dim ListOfProjects() As NameIdPair
 ListOfProjects = MyRepository.Project.GetAllProjects()
 
 'Open the first project in the list. 
 MyRepository.Project.SetCurrentProject(ListOfProjects(0).ID)
 
 'Get a list of the names/IDs of models in the current project. 
 Dim ListOfModels() As NameIdPair
 ListOfModels = MyRepository.Model.GetAllModelsInfo()
 
 'Retrieve the first model in the list. 
 Dim AModel As cModel
 AModel = MyRepository.Model.GetModel(ListOfModels(0).ID)
 
 'Calculate the reliability at time = 50 and save the result. See Reliability. 
 Dim Rel As Double
 Rel = AModel.Reliability(50)
 
 'Disconnect from the repository. 
 MyRepository.DisconnectFromRepository()