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