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 26: | Line 26: | ||
*'''[[Repository.GetAllModels|GetAllModels]]''' {{APIComment|{{Template:Repository.GetAllModels.Cmt}}}} | *'''[[Repository.GetAllModels|GetAllModels]]''' {{APIComment|{{Template:Repository.GetAllModels.Cmt}}}} | ||
*'''[[Repository.AddModel|AddModel]]''' {{APIComment|{{Template:Repository.AddModel.Cmt}}}} | *'''[[Repository.AddModel|AddModel]]''' {{APIComment|{{Template:Repository.AddModel.Cmt}}}} | ||
*'''[[Repository.UpdateModel|UpdateModel]]''' {{APIComment|{{Repository.UpdateModel.Cmt}}}} | *'''[[Repository.UpdateModel|UpdateModel]]''' {{APIComment|{{Template:Repository.UpdateModel.Cmt}}}} | ||
===== URDs ===== | ===== URDs ===== | ||
*'''[[Repository.GetAllURDs|GetAllURDs]]''' {{APIComment| | *'''[[Repository.GetAllURDs|GetAllURDs]]''' {{APIComment|{{Template:Repository.GetAllURDs.Cmt}}}} | ||
*'''[[Repository.AddURD|AddURD]]''' {{APIComment| | *'''[[Repository.AddURD|AddURD]]''' {{APIComment|{{Template:Repository.AddURD.Cmt}}}} | ||
*'''[[Repository.UpdateURD|UpdateURD]]''' {{APIComment| | *'''[[Repository.UpdateURD|UpdateURD]]''' {{APIComment|{{Template:Repository.UpdateURD.Cmt}}}} | ||
===== Variables ===== | ===== Variables ===== | ||
*'''[[Repository.GetAllVariables|GetAllVariables]]''' {{APIComment| | *'''[[Repository.GetAllVariables|GetAllVariables]]''' {{APIComment|{{Template:Repository.GetAllVariables.Cmt}}}} | ||
*'''[[Repository.AddVariable|AddVariable]]''' {{APIComment| | *'''[[Repository.AddVariable|AddVariable]]''' {{APIComment|{{Template:Repository.AddVariable.Cmt}}}} | ||
*'''[[Repository.UpdateVariable|UpdateVariable]]''' {{APIComment| | *'''[[Repository.UpdateVariable|UpdateVariable]]''' {{APIComment|{{Template:Repository.UpdateVariable.Cmt}}}} | ||
===== Corrective Tasks ===== | ===== Corrective Tasks ===== | ||
*'''[[Repository.GetAllCorrectiveTasks|GetAllCorrectiveTasks]]''' {{APIComment| | *'''[[Repository.GetAllCorrectiveTasks|GetAllCorrectiveTasks]]''' {{APIComment|{{Template:Repository.GetAllCorrectiveTasks.Cmt}}}} | ||
*'''[[Repository.AddCorrectiveTask|AddCorrectiveTask]]''' {{APIComment| | *'''[[Repository.AddCorrectiveTask|AddCorrectiveTask]]''' {{APIComment|{{Template:Repository.AddCorrectiveTask.Cmt}}}} | ||
*'''[[Repository.UpdateCorrectiveTask|UpdateCorrectiveTask]]''' {{APIComment| | *'''[[Repository.UpdateCorrectiveTask|UpdateCorrectiveTask]]''' {{APIComment|{{Template:Repository.UpdateCorrectiveTask.Cmt}}}} | ||
===== Scheduled Tasks ===== | ===== Scheduled Tasks ===== | ||
*'''[[Repository.GetAllScheduledTasks|GetAllScheduledTasks]]''' {{APIComment| | *'''[[Repository.GetAllScheduledTasks|GetAllScheduledTasks]]''' {{APIComment|{[Template:Repository.GetAllScheduledTasks.Cmt}}}} | ||
*'''[[Repository.AddScheduledTask|AddScheduledTask]]''' {{APIComment| | *'''[[Repository.AddScheduledTask|AddScheduledTask]]''' {{APIComment|{{Template:Repository.AddScheduledTask.Cmt}}}} | ||
*'''[[Repository.UpdateScheduledTask|UpdateScheduledTask]]''' {{APIComment| | *'''[[Repository.UpdateScheduledTask|UpdateScheduledTask]]''' {{APIComment|{{Template:Repository.UpdateScheduledTask.Cmt}}}} | ||
===== Task Types ===== | ===== Task Types ===== |
Revision as of 21:21, 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 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 {[Template:Repository.GetAllScheduledTasks.Cmt }}
- 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.