Repository Class: Difference between revisions
Jump to navigation
Jump to search
Albert Szeto (talk | contribs) No edit summary |
Albert Szeto (talk | contribs) No edit summary |
||
Line 3: | Line 3: | ||
== Constructors == | == Constructors == | ||
*'''[[New Repository]]''' {{APIComment|Creates a new Synthesis Repository connection class.}} | *'''[[New Repository]]''' {{APIComment|Creates a new Synthesis Repository connection class.}} | ||
*'''[[XFRACASImportType ]]''' {{APIComment|Enum for the XFRACAS Import Types}} | |||
*'''[[NameIdPair Class]]''' {{APIComment|Class to describe a Name and ID pair}} | |||
*'''[[ToString Class]]''' {{APIComment|Class to return various string}} | |||
*'''[[UnitInfo Class]]''' {{APIComment|Class to describe a Unit}} | |||
== Methods == | == Methods == |
Revision as of 23:06, 19 September 2013
Provides an application the ability to access and edit Synthesis Repositories.
Constructors
- New Repository Creates a new Synthesis Repository connection class.
- XFRACASImportType Enum for the XFRACAS Import Types
- NameIdPair Class Class to describe a Name and ID pair
- ToString Class Class to return various string
- UnitInfo Class Class to describe a Unit
Methods
Connection
- Repository.ConnectToRepository Connects to any (MS Access, MS SQL or Oracle) repository.
- 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 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. If 0 is passed, a fist available project will be set as current.
Unit
- Repository.GetAllUnits Returns the default unit ID.
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 from 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.
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.
XFRACAS
- Repository.ImportBlockSimXMLFile Imports from XML file to the current project.
- Repository.SaveRawDataSet Saves the raw data set in the repository.
- Repository.GetAllXFRACASEntities Returns an array containing all entity names and and their IDs from the current repository.
- Repository.ImportXFRACASXMLFile Uploads an import file for processing and returns the system ID of the uploaded
Properties
- Repository.EnforceRENOCompliance Defines the restrictions on model names. True by default.