Repository Class: Difference between revisions
Jump to navigation
Jump to search
Chris Kahn (talk | contribs) No edit summary |
Chris Kahn (talk | contribs) (Undo revision 54538 by Chris Kahn (Talk)) |
||
Line 88: | Line 88: | ||
== 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. | |||
{{APIComment|'Declare a new repository connection class.}} | |||
{{Template:Repository.Ex}} | {{Template:Repository.Ex}} |
Revision as of 20:16, 27 May 2014
Constructors
- Repository Creates a new Repository object for connecting to Synthesis repositories.
Methods
Connect to / Disconnect from Repository
- ConnectToRepository( String ) Connects to any local repository (MS Access, MS SQL or Oracle).
- ConnectToAccessRepository( String ) Connects to an MS Access repository.
- ConnectToSQLRepository( String, String, [Boolean], [String], [String], [String] ) Connects to an MS SQL repository.
- ConnectToOracleRepository( Integer ,String, String, String, String ) Connects to an Oracle repository.
- DisconnectFromRepository Disconnects from the current repository.
Project
- GetAllProjects Returns an array containing all project names and their IDs from the current repository.
- GetCurrentProject Returns the name and ID of the current project.
- SetCurrentProject( Integer ) Opens (sets as current) a project with the specified ID.
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
- GetAllURDs Returns an array containing all URDs from the current project.
- AddURD( cURD ) Saves a new URD in the repository.
- UpdateURD( cURD ) Updates the URD in the repository.
Variables
- GetAllVariables Returns an array containing all variables in the current project.
- AddVariable( cVariable ) Saves a new variable in the repository.
- UpdateVariable( cVariable ) Updates the variable in the repository.
Corrective Tasks
- GetAllCorrectiveTasks Returns an array containing all corrective tasks from the current project.
- AddCorrectiveTask( cCorrectiveTask ) Saves the corrective task in the repository.
- UpdateCorrectiveTask( cCorrectiveTask ) Updates the corrective task in the repository.
Scheduled Tasks
- GetAllScheduledTasks Returns an array containing all scheduled tasks from the current project.
- AddScheduledTask( cScheduledTask ) Saves the scheduled task in the repository.
- UpdateCorrectiveTask( cScheduledTask ) Updates the scheduled task in the repository.
Task Types
- GetAllTaskTypes Retuns an array containing all task types in the repository.
Crews
- GetAllCrews Returns an array containing all crews from the current project.
- AddCrew( cCrew ) Saves the crew in the repository.
- UpdateCrew( cCrew ) Updates the crew in the repository.
Pools
- GetAllPools Returns an array containing all spare parts pools from the current project.
- AddPool( cPool ) Saves the spare parts pool in the repository.
- UpdatePool( cPool ) Updates the spare parts pool in the repository.
Action
- GetAllActions Returns an array containing all actions from the current project.
- AddAction( cAction ) Saves the action in the repository.
- UpdateAction( cAction ) Updates the action in the repository.
BlockSim
- ImportBlockSimXMLFile( String ) Imports from an XML file to the current project.
- ExportBlockSimXMLFile( String ) Creates a new BlockSim XML file and exports items from the current project. If the XML file already exists it will be overridden.
Reliability Data Warehouse (RDW)
XFRACAS
- GetAllXFRACASEntities
- ImportXFRACASXML( Integer, XFRACASImportType, Byte(), String, String ) Uploads an import file byte stream for processing and returns the system ID of the uploaded byte array.
- ImportXFRACASXMLFile( Integer, XFRACASImportType, String, String ) Uploads an import file for processing and returns the system ID of the uploaded XML file.
- ImportXFRACASXMLString(( Integer, XFRACASImportType, String, String, String ) Uploads an import file string for processing and returns the system ID of the uploaded XML string.
- SerializeXMLObjectToByteArray( Byte, Object ) A helper function to create an array of bytes from a serializable XML object.
- ProcessXfracasImports Runs the import process.
- WriteToDiagnosticsLog(string, XFRACASDiagnosticEntryType) Writes a message to the diagnostics log
- WriteToDiagnosticsLog(System.Exception, XFRACASDiagnosticEntryType, String) Writes exception information to the diagnostics log
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 class. 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()