Repository Class: Difference between revisions
Jump to navigation
Jump to search
John Leavitt (talk | contribs) |
Chris Kahn (talk | contribs) No edit summary |
||
Line 6: | Line 6: | ||
== Methods == | == Methods == | ||
===== | ===== Connect/Disconnect to Repository ===== | ||
*'''[[Repository.ConnectToRepository|ConnectToRepository]]''' {{APIComment|{{Template:Repository.ConnectToRepository.Cmt}}}} | *'''[[Repository.ConnectToRepository|ConnectToRepository]]''' {{APIComment|{{Template:Repository.ConnectToRepository.Cmt}}}} | ||
*'''[[Repository.ConnectToAccessRepository|ConnectToAccessRepository]]''' {{APIComment|{{Template:Repository.ConnectToAccessRepository.Cmt}}}} | *'''[[Repository.ConnectToAccessRepository|ConnectToAccessRepository]]''' {{APIComment|{{Template:Repository.ConnectToAccessRepository.Cmt}}}} |
Revision as of 23:03, 26 February 2014
Constructors
- New Repository Creates a new Synthesis Repository connection class.
Methods
Connect/Disconnect to Repository
- ConnectToRepository Connects to any local repository (MS Access, MS SQL or Oracle).
- ConnectToAccessRepository Connects to an MS Access repository.
- ConnectToSQLRepository Connects to an MS SQL repository.
- ConnectToOracleRepository 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 Opens (sets as current) a project with the specified ID.
Unit
- 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 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 Saves a new model in the repository.
- UpdateModel Updates the model in the repository.
URDs
- GetAllURDs Returns an array containing all URDs from the current project.
- AddURD Saves a new URD in the repository.
- UpdateURD Updates the URD in the repository.
Variables
- GetAllVariables Returns an array containing all variables in the current project.
- AddVariable Saves a new variable in the repository.
- UpdateVariable Updates the variable in the repository.
Corrective Tasks
- GetAllCorrectiveTasks Returns an array containing all corrective tasks from the current project.
- AddCorrectiveTask Saves the corrective task in the repository.
- UpdateCorrectiveTask Updates the corrective task in the repository.
Scheduled Tasks
- GetAllScheduledTasks Returns an array containing all scheduled tasks from the current project.
- AddScheduledTask Saves the scheduled task in the repository.
- UpdateScheduledTask 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 Saves the crew in the repository.
- UpdateCrew Updates the crew in the repository.
Pools
- GetAllPools Returns an array containing all spare parts pools from the current project.
- AddPool Saves the spare parts pool in the repository.
- UpdatePool Updates the spare parts pool in the repository.
Action
- GetAllActions Returns an array containing all actions from the current project.
- AddAction Saves the action in the repository.
- UpdateAction Updates the action in the repository.
BlockSim
- ImportBlockSimXMLFile Imports from an XML file to the current project.
- ExportBlockSimXMLFile Creates a new BlockSim XML file and exports items from the current project. If the XML file already exists it will be overridden.
Save RawDataSet
XFRACAS
- GetAllXFRACASEntities
- ImportXFRACASXML Uploads an import file byte stream for processing and returns the system ID of the uploaded byte array.
- ImportXFRACASXMLFile Uploads an import file for processing and returns the system ID of the uploaded XML file.
- ImportXFRACASXMLString Uploads an import file string for processing and returns the system ID of the uploaded XML string.
- SerializeXMLObjectToByteArray A helper function to create an array of bytes from a serializable XML object.
- ProcessXfracasImports Runs the import process.
Properties
- EnforceRENOCompliance Defines the restrictions on model names. True by default.
- XFRACASImportType Enum for the XFRACAS Import Types.