Repository Class: Difference between revisions
Jump to navigation
Jump to search
Chris Kahn (talk | contribs) |
Chris Kahn (talk | contribs) |
||
Line 34: | Line 34: | ||
''' Variables ''' | ''' Variables ''' | ||
*[[Repository.GetAllVariables]] {{APIComment|{{Template:Repository.GetAllVariables.Cmt}}}} | *[[Repository.GetAllVariables|GetAllVariables]] {{APIComment|{{Template:Repository.GetAllVariables.Cmt}}}} | ||
*[[Repository.AddVariable]] {{APIComment|{{Template:Repository.AddVariable.Cmt}}}} | *[[Repository.AddVariable|AddVariable( cVariable )]] {{APIComment|{{Template:Repository.AddVariable.Cmt}}}} | ||
*[[Repository.UpdateVariable]] {{APIComment|{{Template:Repository.UpdateVariable.Cmt}}}} | *[[Repository.UpdateVariable|UpdateVariable( cVariable )]] {{APIComment|{{Template:Repository.UpdateVariable.Cmt}}}} | ||
''' Corrective Tasks ''' | ''' Corrective Tasks ''' | ||
*[[Repository.GetAllCorrectiveTasks]] {{APIComment|{{Template:Repository.GetAllCorrectiveTasks.Cmt}}}} | *[[Repository.GetAllCorrectiveTasks|GetAllCorrectiveTasks]] {{APIComment|{{Template:Repository.GetAllCorrectiveTasks.Cmt}}}} | ||
*[[Repository.AddCorrectiveTask]] {{APIComment|{{Template:Repository.AddCorrectiveTask.Cmt}}}} | *[[Repository.AddCorrectiveTask|AddCorrectiveTask( cCorrectiveTask )]] {{APIComment|{{Template:Repository.AddCorrectiveTask.Cmt}}}} | ||
*[[Repository.UpdateCorrectiveTask]] {{APIComment|{{Template:Repository.UpdateCorrectiveTask.Cmt}}}} | *[[Repository.UpdateCorrectiveTask|UpdateCorrectiveTask( cCorrectiveTask )]] {{APIComment|{{Template:Repository.UpdateCorrectiveTask.Cmt}}}} | ||
''' Scheduled Tasks ''' | ''' Scheduled Tasks ''' | ||
*[[Repository.GetAllScheduledTasks]] {{APIComment|{{Template:Repository.GetAllScheduledTasks.Cmt}}}} | *[[Repository.GetAllScheduledTasks|GetAllScheduledTasks]] {{APIComment|{{Template:Repository.GetAllScheduledTasks.Cmt}}}} | ||
*[[Repository.AddScheduledTask]] {{APIComment|{{Template:Repository.AddScheduledTask.Cmt}}}} | *[[Repository.AddScheduledTask|AddScheduledTask( cScheduledTask )]] {{APIComment|{{Template:Repository.AddScheduledTask.Cmt}}}} | ||
*[[Repository.UpdateScheduledTask]] {{APIComment|{{Template:Repository.UpdateScheduledTask.Cmt}}}} | *[[Repository.UpdateScheduledTask|UpdateScheduledTask( cScheduledTask )]] {{APIComment|{{Template:Repository.UpdateScheduledTask.Cmt}}}} | ||
''' Task Types ''' | ''' Task Types ''' | ||
*[[Repository.GetAllTaskTypes]] {{APIComment|{{Template:Repository.GetAllTaskTypes.Cmt}}}} | *[[Repository.GetAllTaskTypes|GetAllTaskTypes]] {{APIComment|{{Template:Repository.GetAllTaskTypes.Cmt}}}} | ||
''' Crews ''' | ''' Crews ''' | ||
*[[Repository.GetAllCrews]] {{APIComment|{{Template:Repository.GetAllCrews.Cmt}}}} | *[[Repository.GetAllCrews|GetAllCrews]] {{APIComment|{{Template:Repository.GetAllCrews.Cmt}}}} | ||
*[[Repository.AddCrew]] {{APIComment|{{Template:Repository.AddCrew.Cmt}}}} | *[[Repository.AddCrew|AddCrew( cCrew )]] {{APIComment|{{Template:Repository.AddCrew.Cmt}}}} | ||
*[[Repository.UpdateCrew]] {{APIComment|{{Template:Repository.UpdateCrew.Cmt}}}} | *[[Repository.UpdateCrew|UpdateCrew( cCrew )]] {{APIComment|{{Template:Repository.UpdateCrew.Cmt}}}} | ||
''' Pools ''' | ''' Pools ''' | ||
*[[Repository.GetAllPools]] {{APIComment|{{Template:Repository.GetAllPools.Cmt}}}} | *[[Repository.GetAllPools|GetAllPools]] {{APIComment|{{Template:Repository.GetAllPools.Cmt}}}} | ||
*[[Repository.AddPool]] {{APIComment|{{Template:Repository.AddPool.Cmt}}}} | *[[Repository.AddPool|AddPool( cPool )]] {{APIComment|{{Template:Repository.AddPool.Cmt}}}} | ||
*[[Repository.UpdatePool]] {{APIComment|{{Template:Repository.UpdatePool.Cmt}}}} | *[[Repository.UpdatePool|UpdatePool( cPool )]] {{APIComment|{{Template:Repository.UpdatePool.Cmt}}}} | ||
''' Action ''' | ''' Action ''' | ||
*[[Repository.GetAllActions]] {{APIComment|{{Template:Repository.GetAllActions.Cmt}}}} | *[[Repository.GetAllActions|GetAllActions]] {{APIComment|{{Template:Repository.GetAllActions.Cmt}}}} | ||
*[[Repository.AddAction]] {{APIComment|{{Template:Repository.AddAction.Cmt}}}} | *[[Repository.AddAction|AddAction( cAction )]] {{APIComment|{{Template:Repository.AddAction.Cmt}}}} | ||
*[[Repository.UpdateAction]] {{APIComment|{{Template:Repository.UpdateAction.Cmt}}}} | *[[Repository.UpdateAction|UpdateAction( cAction )]] {{APIComment|{{Template:Repository.UpdateAction.Cmt}}}} | ||
''' BlockSim ''' | ''' BlockSim ''' | ||
*[[Repository.ImportBlockSimXMLFile]] {{APIComment|{{Template:Repository.ImportBlockSimXMLFile.Cmt}}}} | *[[Repository.ImportBlockSimXMLFile|ImportBlockSimXMLFile]] {{APIComment|{{Template:Repository.ImportBlockSimXMLFile.Cmt}}}} | ||
*[[Repository.ExportBlockSimXMLFile]] {{APIComment|{{Template:Repository.ExportBlockSimXMLFile.Cmt}}}} | *[[Repository.ExportBlockSimXMLFile|ExportBlockSimXMLFile]] {{APIComment|{{Template:Repository.ExportBlockSimXMLFile.Cmt}}}} | ||
''' Save RawDataSet ''' | ''' Save RawDataSet ''' | ||
*[[Repository.SaveRawDataSet]] {{APIComment|{{Template:Repository.SaveRawDataSet.Cmt}}}} | *[[Repository.SaveRawDataSet|SaveRawDataSet]] {{APIComment|{{Template:Repository.SaveRawDataSet.Cmt}}}} | ||
''' XFRACAS ''' | ''' XFRACAS ''' | ||
*[[Repository.GetAllXFRACASEntities]] {{APIComment|{{Template:Repository.GetAllXFRACASEntities.Cmt}}}} | *[[Repository.GetAllXFRACASEntities|GetAllXFRACASEntities]] {{APIComment|{{Template:Repository.GetAllXFRACASEntities.Cmt}}}} | ||
*[[Repository.ImportXFRACASXML]] {{APIComment|{{Template:Repository.ImportXFRACASXML.Cmt}}}} | *[[Repository.ImportXFRACASXML|ImportXFRACASXML]] {{APIComment|{{Template:Repository.ImportXFRACASXML.Cmt}}}} | ||
*[[Repository.ImportXFRACASXMLFile]] {{APIComment|{{Template:Repository.ImportXFRACASXMLFile.Cmt}}}} | *[[Repository.ImportXFRACASXMLFile|ImportXFRACASXMLFile]] {{APIComment|{{Template:Repository.ImportXFRACASXMLFile.Cmt}}}} | ||
*[[Repository.ImportXFRACASXMLString]] {{APIComment|{{Template:Repository.ImportXFRACASXMLString.Cmt}}}} | *[[Repository.ImportXFRACASXMLString|ImportXFRACASXMLString]] {{APIComment|{{Template:Repository.ImportXFRACASXMLString.Cmt}}}} | ||
*[[Repository.SerializeXMLObjectToByteArray]] {{APIComment|{{Template:Repository.SerializeXMLObjectToByteArray.Cmt}}}} | *[[Repository.SerializeXMLObjectToByteArray|SerializeXMLObjectToByteArray]] {{APIComment|{{Template:Repository.SerializeXMLObjectToByteArray.Cmt}}}} | ||
*[[Repository.ProcessXfracasImports]] {{APIComment|{{Template:Repository.ProcessXfracasImports.Cmt}}}} | *[[Repository.ProcessXfracasImports|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:26, 26 February 2014
Constructors
- New Repository Creates a new Synthesis Repository connection class.
Methods
Connect/Disconnect to Repository
- ConnectToRepository( Boolean ) Connects to any local repository (MS Access, MS SQL or Oracle).
- ConnectToAccessRepository( String ) Connects to an MS Access repository.
- ConnectToSQLRepository( String, String, [Boolean], [String], [String], [String] ) Connects to an MS SQL repository.
- ConnectToOracleRepository( Integer ,String, String, String, String ) 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( Integer ) 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
- GetAllModelsInfo Returns an array containing all model names and their IDs from the current project.
- GetModel( Integer ) 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( cModel ) Saves a new model in the repository.
- UpdateModel( cModel ) Updates the model in the repository.
URDs
- GetAllURDs Returns an array containing all URDs from the current project.
- AddURD( cURD ) Saves a new URD in the repository.
- UpdateURD( cURD ) Updates the URD in the repository.
Variables
- GetAllVariables Returns an array containing all variables in the current project.
- AddVariable( cVariable ) Saves a new variable in the repository.
- UpdateVariable( cVariable ) Updates the variable in the repository.
Corrective Tasks
- GetAllCorrectiveTasks Returns an array containing all corrective tasks from the current project.
- AddCorrectiveTask( cCorrectiveTask ) Saves the corrective task in the repository.
- UpdateCorrectiveTask( cCorrectiveTask ) Updates the corrective task in the repository.
Scheduled Tasks
- GetAllScheduledTasks Returns an array containing all scheduled tasks from the current project.
- AddScheduledTask( cScheduledTask ) Saves the scheduled task in the repository.
- UpdateScheduledTask( cScheduledTask ) 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( cCrew ) Saves the crew in the repository.
- UpdateCrew( cCrew ) Updates the crew in the repository.
Pools
- GetAllPools Returns an array containing all spare parts pools from the current project.
- AddPool( cPool ) Saves the spare parts pool in the repository.
- UpdatePool( cPool ) Updates the spare parts pool in the repository.
Action
- GetAllActions Returns an array containing all actions from the current project.
- AddAction( cAction ) Saves the action in the repository.
- UpdateAction( cAction ) 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.