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 74: | Line 74: | ||
*'''[[Repository.ImportXFRACASXML|ImportXFRACASXML]]''' {{APIComment|{{Template:Repository.ImportXFRACASXML.Cmt}}}} | *'''[[Repository.ImportXFRACASXML|ImportXFRACASXML]]''' {{APIComment|{{Template:Repository.ImportXFRACASXML.Cmt}}}} | ||
*'''[[Repository.ImportXFRACASXMLFile|ImportXFRACASXMLFile]]''' {{APIComment|{{Template:Repository.ImportXFRACASXMLFile.Cmt}}}} | *'''[[Repository.ImportXFRACASXMLFile|ImportXFRACASXMLFile]]''' {{APIComment|{{Template:Repository.ImportXFRACASXMLFile.Cmt}}}} | ||
*'''[[Repository.ImportXFRACASXMLString|ImportXFRACASXMLString]]''' {{APIComment| | *'''[[Repository.ImportXFRACASXMLString|ImportXFRACASXMLString]]''' {{APIComment|{{Template:Repository.ImportXFRACASXMLString.Cmt}}}} | ||
*'''[[Repository.SerializeXMLObjectToByteArray|SerializeXMLObjectToByteArray]]''' {{APIComment| | *'''[[Repository.SerializeXMLObjectToByteArray|SerializeXMLObjectToByteArray]]''' {{APIComment|{{Template:Repository.SerializeXMLObjectToByteArray.Cmt}}}} | ||
*'''[[Repository.ProcessXfracasImports|ProcessXfracasImports]]''' {{APIComment| | *'''[[Repository.ProcessXfracasImports|ProcessXfracasImports]]''' {{APIComment|{{Template:Repository.ProcessXfracasImports.Cmt}}}} | ||
== Properties == | == Properties == | ||
*'''[[Repository.EnforceRENOCompliance|EnforceRENOCompliance]]''' {{APIComment| | *'''[[Repository.EnforceRENOCompliance|EnforceRENOCompliance]]''' {{APIComment|{{Template:Repository.EnforceRENOCompliance.Cmt}}}} | ||
*'''[[XFRACASImportType]]''' {{APIComment|Enum for the XFRACAS Import Types.}} | *'''[[XFRACASImportType]]''' {{APIComment|Enum for the XFRACAS Import Types.}} | ||
*'''[[NameIdPair Class]]''' {{APIComment|Class to describe a Name and ID pair.}} | *'''[[NameIdPair Class]]''' {{APIComment|Class to describe a Name and ID pair.}} | ||
*'''[[UnitInfo Class]]''' {{APIComment|Class to describe a Unit.}} | *'''[[UnitInfo Class]]''' {{APIComment|Class to describe a Unit.}} |
Revision as of 21:45, 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 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
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.
- NameIdPair Class Class to describe a Name and ID pair.
- UnitInfo Class Class to describe a Unit.