Repository Class: Difference between revisions
Jump to navigation
Jump to search
Chris Kahn (talk | contribs) No edit summary |
Chris Kahn (talk | contribs) No edit summary |
||
Line 7: | Line 7: | ||
== Methods == | == Methods == | ||
===== Connection ===== | ===== Connection ===== | ||
*'''[[Repository.ConnectToRepository|ConnectToRepository]]''' {{APIComment| | *'''[[Repository.ConnectToRepository|ConnectToRepository]]''' {{APIComment|{{Template:Repository.ConnectToRepository.Cmt}}}} | ||
*'''[[Repository.ConnectToAccessRepository|ConnectToAccessRepository]]''' {{APIComment| | *'''[[Repository.ConnectToAccessRepository|ConnectToAccessRepository]]''' {{APIComment|{{Template:Repository.ConnectToAccessRepository.Cmt}}}} | ||
*'''[[Repository.ConnectToSQLRepository|ConnectToSQLRepository]]''' {{APIComment| | *'''[[Repository.ConnectToSQLRepository|ConnectToSQLRepository]]''' {{APIComment|{{Template:Repository.ConnectToSQLRepository.Cmt}}}} | ||
*'''[[Repository.ConnectToOracleRepository|ConnectToOracleRepository]]''' {{APIComment| | *'''[[Repository.ConnectToOracleRepository|ConnectToOracleRepository]]''' {{APIComment|{{Template:Repository.ConnectToOracleRepository.Cmt}}}} | ||
*'''[[Repository.DisconnectFromRepository|DisconnectFromRepository]]''' {{APIComment| | *'''[[Repository.DisconnectFromRepository|DisconnectFromRepository]]''' {{APIComment|{{Template:Repository.DisconnectFromRepository.Cmt}}}} | ||
===== Project ===== | ===== Project ===== | ||
*'''[[Repository.GetAllProjects|GetAllProjects]]''' {{APIComment| | *'''[[Repository.GetAllProjects|GetAllProjects]]''' {{APIComment|{{Template:Repository.GetAllProjects.Cmt}}}} | ||
*'''[[Repository.GetCurrentProject|GetCurrentProject]]''' {{APIComment| | *'''[[Repository.GetCurrentProject|GetCurrentProject]]''' {{APIComment|{{Template:Repository.GetCurrentProject.Cmt}}}} | ||
*'''[[Repository.SetCurrentProject|SetCurrentProject]]''' {{APIComment| | *'''[[Repository.SetCurrentProject|SetCurrentProject]]''' {{APIComment|{{Template:Repository.SetCurrentProject.Cmt}}}} | ||
===== Unit ===== | ===== Unit ===== | ||
*'''[[Repository.GetAllUnits|GetAllUnits]]''' {{APIComment| | *'''[[Repository.GetAllUnits|GetAllUnits]]''' {{APIComment|{{Template:Repository.GetAllUnits.Cmt}}}} | ||
===== Models ===== | ===== Models ===== | ||
*'''[[Repository.GetAllModelsInfo|GetAllModelsInfo]]''' {{APIComment| | *'''[[Repository.GetAllModelsInfo|GetAllModelsInfo]]''' {{APIComment|{{Template:Repository.GetAllModelsInfo.Cmt}}}} | ||
*'''[[Repository.GetModel|GetModel]]''' {{APIComment| | *'''[[Repository.GetModel|GetModel]]''' {{APIComment|{{Template:Repository.GetModel.Cmt}}}} | ||
*'''[[Repository.GetAllModels|GetAllModels]]''' {{APIComment| | *'''[[Repository.GetAllModels|GetAllModels]]''' {{APIComment|{{Template:Repository.GetAllModels.Cmt}}}} | ||
*'''[[Repository.AddModel|AddModel]]''' {{APIComment| | *'''[[Repository.AddModel|AddModel]]''' {{APIComment|{{Template:Repository.AddModel.Cmt}}}} | ||
*'''[[Repository.UpdateModel|UpdateModel]]''' {{APIComment| | *'''[[Repository.UpdateModel|UpdateModel]]''' {{APIComment|{{Repository.UpdateModel.Cmt}}}} | ||
===== URDs ===== | ===== URDs ===== |
Revision as of 21:15, 5 February 2014
Allows Template:Repository Class.Cmt
Constructors
- New Repository Creates a new Synthesis Repository connection class.
Methods
Connection
- 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 from 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.
- SaveRawDataSet Saves the raw data set in the repository.
XFRACAS
- GetAllXFRACASEntities Returns an array containing all entity names and and their IDs from the current repository.
- ImportXFRACASXML Uploads an import file byte stream for processing and returns the system ID of the uploaded
- ImportXFRACASXMLFile Uploads an import file for processing and returns the system ID of the uploaded
- ImportXFRACASXMLString Uploads an import file string for processing and returns the system ID of the uploaded
- 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.
- NameIdPair Class Class to describe a Name and ID pair.
- UnitInfo Class Class to describe a Unit.