11853 lines
538 KiB
XML
Executable File
11853 lines
538 KiB
XML
Executable File
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>RSG.Configuration</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:RSG.Configuration.AutomationConfig">
|
|
<summary>
|
|
Automation Configuration.
|
|
</summary>
|
|
<remarks>
|
|
DHM: Please note this does not currently deserialise well over WCF because the Environment
|
|
is never constructed. That functionality needs some thought.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:RSG.Configuration.AutomationConfig.DefaultAutomationBranchName">
|
|
<summary>
|
|
The default branch for which we would use should an automation application not specify the desired
|
|
branch to use.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.AutomationConfig.ConfigurationFilename">
|
|
<summary>
|
|
configuration filename and extension
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.AutomationConfig.ServicesConfigFilename">
|
|
<summary>
|
|
services configuration filename and extension
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.AutomationConfig.LogContext">
|
|
<summary>
|
|
Log context.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.AutomationConfig.#ctor(System.Xml.Linq.XElement,RSG.Configuration.IConfig)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.AutomationConfig"/> class.
|
|
</summary>
|
|
<param name="automationConfigElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<param name="config">
|
|
Parent <see cref="T:RSG.Configuration.IConfig"/> object.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.AutomationConfig.Environment">
|
|
<summary>
|
|
Gets the <see cref="T:RSG.Base.IEnvironment"/>; inheriting from Project and Config.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.AutomationConfig.Name">
|
|
<summary>
|
|
Gets the branch name of the automation config
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.AutomationConfig.BinDirectory">
|
|
<summary>
|
|
Gets the binary directory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.AutomationConfig.ConfigDirectory">
|
|
<summary>
|
|
Gets the config directory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.AutomationConfig.ScriptDirectory">
|
|
<summary>
|
|
Gets the script directory.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.AutomationConfig.Load(RSG.Base.Logging.ILog,RSG.Configuration.IConfig)">
|
|
<summary>
|
|
Parse AutomationConfigs metadata file.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="config">
|
|
Parent <see cref="T:RSG.Configuration.IConfig"/> object.
|
|
</param>
|
|
<returns>
|
|
Set of objects that implement the <see cref="T:RSG.Configuration.IAutomationConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.AutomationConfig.GetAutomationConfig(RSG.Configuration.IProject)">
|
|
<summary>
|
|
Get the <see cref="F:RSG.Configuration.AutomationConfig.DefaultAutomationBranchName"/> automation configuration.
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<returns>
|
|
A new <see cref="T:RSG.Configuration.IAutomationConfig"/> object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.AutomationConfig.GetAutomationConfigs(RSG.Configuration.IProject)">
|
|
<summary>
|
|
Get the automation configuration with specified name.
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<returns>
|
|
A new set of <see cref="T:RSG.Configuration.IAutomationConfig"/> objects.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.AutomationConfig.GetAutomationConfig(RSG.Base.Logging.Universal.IUniversalLog,RSG.Configuration.CommandOptions,System.Object)">
|
|
<summary>
|
|
Get the automation configuration.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="commandOptions">
|
|
Queries the commandline options to find the particular branch requested -
|
|
and fallsback to a default if not specified.
|
|
</param>
|
|
<param name="dll">
|
|
Object?!?!?!
|
|
</param>
|
|
<returns>
|
|
A new <see cref="T:RSG.Configuration.IAutomationConfig"/> object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.AutomationConfig.GetAutomationConfig(RSG.Base.Logging.ILog,RSG.Configuration.IProject,System.String)">
|
|
<summary>
|
|
Get the automation configuration.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="project">
|
|
Project object.
|
|
</param>
|
|
<param name="automationBranch">
|
|
Automation branch name.
|
|
</param>
|
|
<returns>
|
|
A new <see cref="T:RSG.Configuration.IAutomationConfig"/> object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.AutomationConfig.GetDefaultAutomationConfigName(RSG.Configuration.CommandOptions,System.String@,System.Object)">
|
|
<summary>
|
|
Returns the default automation config name that can be
|
|
overriden from app settings or commandline.
|
|
</summary>
|
|
<param name="commandOptions">
|
|
Queries the commandline options to find the particular branch requested - and fallsback to a default if not specified.
|
|
</param>
|
|
<param name="info">
|
|
Message regarding where the branch came from for logging.
|
|
</param>
|
|
<param name="dll">
|
|
Object?!?!?!
|
|
</param>
|
|
<returns>
|
|
Automation config name.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.AutomationConfig.Import(RSG.Base.IEnvironment)">
|
|
<summary>
|
|
Import settings into an IEnvironment object.
|
|
</summary>
|
|
<param name="environment">
|
|
<see cref="T:RSG.Base.IEnvironment"/> to import into.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.AutomationConfig.ToString">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.AutomationConfig.ExpandedPaths">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.AutomationConfig.CommonExpandedPath">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.AutomationConfig.FullPathBinDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.AutomationConfig.FullPathConfigDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.AutomationConfig.FullPathScriptDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.AutomationConfig.FullServicesConfigPath">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.AutomationConfig.Parse(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Parse automation branch spec from an XElement.
|
|
</summary>
|
|
<param name="automationConfigElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Automation.AutomationDependencyBuild">
|
|
<summary>
|
|
Implementation of the <see cref="T:RSG.Configuration.Automation.IAutomationDependencyBuild"/> interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationDependencyBuild.CriticalLimitMinutes">
|
|
<summary>
|
|
Gets the critical limit in minutes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationDependencyBuild.WarnLimitMinutes">
|
|
<summary>
|
|
Gets the warning limit in minutes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationDependencyBuild.WebAlias">
|
|
<summary>
|
|
Gets the web alias.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationDependencyBuild.Load(RSG.Configuration.IProject,RSG.Configuration.Metadata.Automation.AutomationDependencyBuild)">
|
|
<summary>
|
|
Load Automation Dependency Build configuration from an XML element.
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="metadata">
|
|
Metadata information.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Automation.IAutomationDependencyBuild"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationDependencyBuild.Load(RSG.Configuration.IProject,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Load Automation Dependency Build configuration from an XML element.
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Automation.IAutomationDependencyBuild"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Automation.AutomationDisplayEvent">
|
|
<summary>
|
|
Automation event.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationDisplayEvent.EventName">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationDisplayEvent.Limit">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationDisplayEvent.Load(RSG.Configuration.IProject,RSG.Configuration.Metadata.Automation.AutomationDisplayEvent)">
|
|
<summary>
|
|
Load Automation Display Event configuration from an metadata element.
|
|
</summary>
|
|
<param name="project">Project information.</param>
|
|
<param name="metadata">Metadata information.</param>
|
|
<returns>New dependency build config instance.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationDisplayEvent.Load(RSG.Configuration.IProject,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Load Automation Dependency Build configuration from an XML element.
|
|
</summary>
|
|
<param name="project">
|
|
Project object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<returns>
|
|
A new <see cref="T:RSG.Configuration.Automation.IAutomationDisplayEvent"/> instance.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Automation.IAutomationDependencyBuild">
|
|
<summary>
|
|
Information on dependency builds
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationDependencyBuild.WebAlias">
|
|
<summary>
|
|
Gets the web alias.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationDependencyBuild.WarnLimitMinutes">
|
|
<summary>
|
|
Gets the warning limit in minutes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationDependencyBuild.CriticalLimitMinutes">
|
|
<summary>
|
|
Gets the critical limit in minutes.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Automation.IAutomationDisplayEvent">
|
|
<summary>
|
|
Interface that defines an automation event.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationDisplayEvent.EventName">
|
|
<summary>
|
|
Gets the event name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationDisplayEvent.Limit">
|
|
<summary>
|
|
Gets the limit.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Automation.ViewMode">
|
|
<summary>
|
|
View mode to give a hint to automation views on how to display a service.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Automation.ViewMode.JobList">
|
|
<summary>
|
|
Present the jobs as a simple list.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Automation.ViewMode.JobMatrixSummary">
|
|
<summary>
|
|
Present only the summary for each matrix group and the status of the last processed changelist.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Automation.ViewMode.JobMatrixStatic">
|
|
<summary>
|
|
Present the jobs as a matrix grouped-by changelist (i.e. Codebuilder) served from local file
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Automation.ViewMode.JobMatrixLight">
|
|
<summary>
|
|
Present the jobs as a matrix grouped-by changelist (i.e. Codebuilder) as plain html
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Automation.ViewMode.JobMatrix">
|
|
<summary>
|
|
Present the jobs as a matrix grouped-by changelist (i.e. Codebuilder).
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Automation.ViewMode.TriggerSummary">
|
|
<summary>
|
|
Shows list of triggers and a break down of their jobs
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Automation.ViewMode.ProgressingHostTurnaround">
|
|
<summary>
|
|
Processing host turnaround report
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Automation.AutomationConsoleConfig">
|
|
<summary>
|
|
Automation Service Console configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationConsoleConfig.BranchName">
|
|
<summary>
|
|
Gets the branch this service is associated with.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationConsoleConfig.Arguments">
|
|
<summary>
|
|
Gets the console arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationConsoleConfig.Load(RSG.Configuration.Metadata.Automation.AutomationConsoleConfig)">
|
|
<summary>
|
|
Load Console configuration data from metadata.
|
|
</summary>
|
|
<param name="metadata">Metadata instance.</param>
|
|
<returns>Console config instance. Empty config if param is null.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationConsoleConfig.Load(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Load Console configuration data from XML element.
|
|
</summary>
|
|
<param name="xmlConsoleElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Automation.IAutomationConsoleConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationConsoleConfig.CreateEmpty">
|
|
<summary>
|
|
Create empty Console configuration data.
|
|
</summary>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Automation.IAutomationConsoleConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Automation.AutomationServiceConfig">
|
|
<summary>
|
|
Automation Service configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceConfig.ServiceType">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceConfig.Studio">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceConfig.FriendlyName">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceConfig.Visible">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceConfig.ServerHost">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceConfig.DBPollingDisabled">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceConfig.Views">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceConfig.Console">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceConfig.TaskIds">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceConfig.DownloadOptions">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceConfig.Icon">
|
|
<inheritdoc />
|
|
<remarks>
|
|
This is used in Automation_Bin but never set.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceConfig.AutomationClientConfig">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceConfig.DashboardUrl">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServiceConfig.Load(RSG.Configuration.IProject,RSG.Configuration.Metadata.Automation.AutomationServiceConfig,System.String)">
|
|
<summary>
|
|
Load Automation Service configuration from metadata.
|
|
</summary>
|
|
<param name="project">Project config information.</param>
|
|
<param name="metadata">Metadata instance.</param>
|
|
<param name="dashboardUrl">Dashboard url</param>
|
|
<returns>New automation service config instance.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServiceConfig.Load(RSG.Configuration.IProject,System.Xml.Linq.XElement,System.String)">
|
|
<summary>
|
|
Load Automation Service configuration from an XML element.
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<param name="dashboardUrl">
|
|
Dashboard url.
|
|
</param>
|
|
<returns>
|
|
A new <see cref="T:RSG.Configuration.Automation.AutomationServiceConfig"/> instance.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServiceConfig.ResourceExists(System.Reflection.Assembly,System.String)">
|
|
<summary>
|
|
Check if a resource exists rather than relying on exception handling to use a generic icon.
|
|
</summary>
|
|
<param name="assembly">
|
|
Assembly object.
|
|
</param>
|
|
<param name="resourcePath">
|
|
Resource path.
|
|
</param>
|
|
<returns>
|
|
true if resource exists; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServiceConfig.GetResourcePaths(System.Reflection.Assembly)">
|
|
<summary>
|
|
Gets all the resource paths for the assembly
|
|
</summary>
|
|
<param name="assembly">
|
|
Assembly object.
|
|
</param>
|
|
<returns>
|
|
Resource paths.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServiceConfig.GetDashboardViewLogUrl(System.Guid)">
|
|
<summary>
|
|
Gets the view log url for the job passed in
|
|
</summary>
|
|
<param name="jobId">
|
|
Job identifier.
|
|
</param>
|
|
<returns>
|
|
Log view <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServiceConfig.GetDashboardDownloadLogUrl(System.Guid,System.String)">
|
|
<summary>
|
|
Gets the download log url for the job passed in
|
|
</summary>
|
|
<param name="jobId">
|
|
Job identifier.
|
|
</param>
|
|
<param name="logFilename">
|
|
Defaulted to job.ulog. Can be overwritten as we have others such as tlog.
|
|
</param>
|
|
<returns>
|
|
Log download <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Automation.AutomationServicesConfig">
|
|
<summary>
|
|
Implementation of the <see cref="T:RSG.Configuration.Automation.IAutomationServiceConfig"/> interface.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServicesConfig.#ctor(System.Collections.Generic.IEnumerable{RSG.Configuration.Automation.IAutomationServiceConfig},System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Automation.AutomationServicesConfig"/> class.
|
|
</summary>
|
|
<param name="services">
|
|
Automation services configuration details.
|
|
</param>
|
|
<param name="dashboardUrl">
|
|
Base URL for the dashboard.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServicesConfig.Services">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServicesConfig.DashboardUrl">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServicesConfig.Load(RSG.Base.ITypedServiceProvider,RSG.Configuration.IProject)">
|
|
<summary>
|
|
Load Automation Service configuration for a project.
|
|
</summary>
|
|
<param name="serviceProvider">
|
|
Application Service Provider.
|
|
</param>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Automation.IAutomationServicesConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServicesConfig.Load(RSG.Configuration.IProject,System.String)">
|
|
<summary>
|
|
Load Automation Service configuration from a metadata file.
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="filename">
|
|
Filename.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Automation.IAutomationServicesConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServicesConfig.LoadAll(RSG.Configuration.IProject)">
|
|
<summary>
|
|
Get all automation branch configs together. Used in Max to allow switching between
|
|
prod (default in max) and staging.
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<returns>
|
|
A dictionary containing all of the <see cref="T:RSG.Configuration.Automation.IAutomationServicesConfig"/> objects for a project.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServicesConfig.GetAllServices">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServicesConfig.GetAllServices(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServicesConfig.GetAllServices(RSG.Configuration.IStudio)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServicesConfig.GetService(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServicesConfig.GetServiceView(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Automation.AutomationServiceViewConfig">
|
|
<summary>
|
|
Automation Service SubView Configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceViewConfig.Service">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceViewConfig.DisabledViewModes">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceViewConfig.DefaultHiddenColumns">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceViewConfig.Name">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceViewConfig.WebAlias">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceViewConfig.ViewMode">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceViewConfig.AllowAnonymous">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceViewConfig.FilterKey">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceViewConfig.FilterValue">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceViewConfig.Branch">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceViewConfig.PrioritisedGroupKeys">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceViewConfig.SuccessfulBuildDependencies">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceViewConfig.EventsToDisplay">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceViewConfig.CacheViewData">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.AutomationServiceViewConfig.DashboardUrl">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServiceViewConfig.Load(RSG.Configuration.IProject,RSG.Configuration.Automation.IAutomationServiceConfig,RSG.Configuration.Metadata.Automation.AutomationViewConfig,System.String)">
|
|
<summary>
|
|
Load Automation Service SubView configuration from metadata
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="service">
|
|
Service.
|
|
</param>
|
|
<param name="metadata">
|
|
Metadata config.
|
|
</param>
|
|
<param name="dashboardUrl">
|
|
Dashboard URL.
|
|
</param>
|
|
<returns>
|
|
A new instance of <see cref="T:RSG.Configuration.Automation.AutomationServiceViewConfig"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServiceViewConfig.Load(RSG.Configuration.IProject,RSG.Configuration.Automation.IAutomationServiceConfig,System.Xml.Linq.XElement,System.String)">
|
|
<summary>
|
|
Load Automation Service SubView configuration from an XML element.
|
|
</summary>
|
|
<param name="project"></param>
|
|
<param name="service"></param>
|
|
<param name="xmlElem"></param>
|
|
<param name="dashboardUrl"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.AutomationServiceViewConfig.GetDashboardUrl">
|
|
<summary>
|
|
Gets dashboard url for default
|
|
</summary>
|
|
<returns>
|
|
Dasboard URL.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Automation.IAutomationConsoleConfig">
|
|
<summary>
|
|
Automation Service Console configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationConsoleConfig.BranchName">
|
|
<summary>
|
|
Gets the branch this service is associated with.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationConsoleConfig.Arguments">
|
|
<summary>
|
|
Gets the Automation Console argument string.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Automation.IAutomationServiceConfig">
|
|
<summary>
|
|
Automation Service Configuration interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceConfig.ServiceType">
|
|
<summary>
|
|
Gets the Service type name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceConfig.Studio">
|
|
<summary>
|
|
Gets the Service studio location.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceConfig.FriendlyName">
|
|
<summary>
|
|
Gets the Service friendly-name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceConfig.Visible">
|
|
<summary>
|
|
Gets a value indicating whether the service is visible to users.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceConfig.ServerHost">
|
|
<summary>
|
|
Gets the Server Host to connect.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceConfig.DBPollingDisabled">
|
|
<summary>
|
|
Gets a value indicating whether DB polling should be disabled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceConfig.Views">
|
|
<summary>
|
|
Gets the automation Service Views.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceConfig.Console">
|
|
<summary>
|
|
Gets the console configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceConfig.TaskIds">
|
|
<summary>
|
|
Gets the task identifiers for the automation service.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceConfig.DownloadOptions">
|
|
<summary>
|
|
Gets the download options for this service.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceConfig.Icon">
|
|
<summary>
|
|
Gets the automation service icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceConfig.AutomationClientConfig">
|
|
<summary>
|
|
Gets the name of the config that this service uses from the automation client service config
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceConfig.DashboardUrl">
|
|
<summary>
|
|
Gets the base dashboard URL.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.IAutomationServiceConfig.GetDashboardViewLogUrl(System.Guid)">
|
|
<summary>
|
|
Gets the view log url for the job passed in
|
|
</summary>
|
|
<param name="jobId">
|
|
Job identifier.
|
|
</param>
|
|
<returns>
|
|
Dashboard log view url.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.IAutomationServiceConfig.GetDashboardDownloadLogUrl(System.Guid,System.String)">
|
|
<summary>
|
|
Gets the download log url for the job passed in
|
|
</summary>
|
|
<param name="jobId">Job ID</param>
|
|
<param name="logFilename">Log file</param>
|
|
<returns>
|
|
Dashboard log download url.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Automation.IAutomationServicesConfig">
|
|
<summary>
|
|
Contains information for the displaying things such as dashboard views
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServicesConfig.Services">
|
|
<summary>
|
|
Gets the automation services configuration details.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServicesConfig.DashboardUrl">
|
|
<summary>
|
|
Gets the URL for the dashboard
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.IAutomationServicesConfig.GetAllServices">
|
|
<summary>
|
|
Return all the parameters for all studios and services.
|
|
</summary>
|
|
<returns>Enumeration of the parameters.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.IAutomationServicesConfig.GetAllServices(System.String)">
|
|
<summary>
|
|
Return all service parameters for a particular service type.
|
|
</summary>
|
|
<param name="serviceType">Service type name.</param>
|
|
<returns>Enumeration of the parameters.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.IAutomationServicesConfig.GetAllServices(RSG.Configuration.IStudio)">
|
|
<summary>
|
|
Return all service parameters for a particular studio.
|
|
</summary>
|
|
<param name="studio">Service studio filter.</param>
|
|
<returns>Enumeration of the configs.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.IAutomationServicesConfig.GetService(System.String)">
|
|
<summary>
|
|
Return a service config for a particular server host.
|
|
</summary>
|
|
<param name="serverHost">Server host filter.</param>
|
|
<returns>Config for a server.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.IAutomationServicesConfig.GetServiceView(System.String)">
|
|
<summary>
|
|
Return a service view config for a particular web alias.
|
|
</summary>
|
|
<param name="webAlias">Web alias for filter.</param>
|
|
<returns>Service view config. </returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Automation.IAutomationServiceViewConfig">
|
|
<summary>
|
|
Automation Service SubView Configuration interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceViewConfig.Service">
|
|
<summary>
|
|
Gets a reference to parent Service
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceViewConfig.DisabledViewModes">
|
|
<summary>
|
|
Gets a set of disabled view modes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceViewConfig.DefaultHiddenColumns">
|
|
<summary>
|
|
Gets the default hidden column names.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceViewConfig.Name">
|
|
<summary>
|
|
Gets the name of the View
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceViewConfig.WebAlias">
|
|
<summary>
|
|
Gets the Web Alias for Portal.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceViewConfig.AllowAnonymous">
|
|
<summary>
|
|
Gets a value indicating whether to allow Anonymous User Access
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceViewConfig.ViewMode">
|
|
<summary>
|
|
Gets the View Mode
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceViewConfig.FilterKey">
|
|
<summary>
|
|
Gets the Filtering The IJobs of the SubView.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceViewConfig.FilterValue">
|
|
<summary>
|
|
Gets the Value Of the Above Property For Filtering
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceViewConfig.Branch">
|
|
<summary>
|
|
Gets the branch name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceViewConfig.PrioritisedGroupKeys">
|
|
<summary>
|
|
Gets the set of group keys which are prioritised to the left
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceViewConfig.SuccessfulBuildDependencies">
|
|
<summary>
|
|
Gets the alias for an automation you want to show at job of matrix
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceViewConfig.EventsToDisplay">
|
|
<summary>
|
|
Gets the set of events to show
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceViewConfig.CacheViewData">
|
|
<summary>
|
|
Gets a value indicating whether to inform if we want to cache the data generated. Examples of this is the tools dashboard
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Automation.IAutomationServiceViewConfig.DashboardUrl">
|
|
<summary>
|
|
Gets the dashboard URL.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Automation.IAutomationServiceViewConfig.GetDashboardUrl">
|
|
<summary>
|
|
Gets dashboard url for default
|
|
</summary>
|
|
<returns>
|
|
Dasboard url.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Automation.StatusViewMode">
|
|
<summary>
|
|
View mode choices for rendering the Services Status page
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Automation.StatusViewMode.JobsStatus">
|
|
<summary>
|
|
Present the status of the services with jobs summary info from DB
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Automation.StatusViewMode.Diagnostics">
|
|
<summary>
|
|
Present the services Diagnostics querying the Services Asynchronously
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Automation.StatusViewMode.DiagnosticsSync">
|
|
<summary>
|
|
Present the services Diagnostics querying the Services Synchronously
|
|
Used to generate the file for Static View
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Automation.StatusViewMode.DiagnosticsStatic">
|
|
<summary>
|
|
Present the services Diagnostics from a locally stored serialised file
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Automation.StatusViewMode.Default">
|
|
<summary>
|
|
Default view-mode.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.ConfigurationMessageCodes">
|
|
<summary>
|
|
Class that defines a message code for the Configuration system.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0001">
|
|
<summary>
|
|
Message code for a missing configuration file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0002">
|
|
<summary>
|
|
Message code for fatal missing or unexpected XML file structure.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0003">
|
|
<summary>
|
|
Message code for non-fatal missing or unexpected XML file structure.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0004">
|
|
<summary>
|
|
Message code for not finding user-specified core project.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0005">
|
|
<summary>
|
|
Message code for not finding user-specified DLC project.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0006">
|
|
<summary>
|
|
Message code for problems with loading the local configuration file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0007">
|
|
<summary>
|
|
Message code for when the local XML file is not up to date
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0008">
|
|
<summary>
|
|
Message code for a missing Content-Pack configuration file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0009">
|
|
<summary>
|
|
Message code for no Content-Pack configuration file (i.e. null or empty).
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0010">
|
|
<summary>
|
|
Message code for no Content Pack Type defined.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0011">
|
|
<summary>
|
|
Message code for warning that a Previous Content Pack is defined but not used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0012">
|
|
<summary>
|
|
Message code for requiring a Previous Content Pack but it is not defined.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0013">
|
|
<summary>
|
|
Message code for duplicate Target platforms being defined.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0014">
|
|
<summary>
|
|
Message code for unknown target type being specified.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0015">
|
|
<summary>
|
|
Message code for Sparse Target specifying base target that doesn't exist.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0016">
|
|
<summary>
|
|
Message code for failing to parse Content Packs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0017">
|
|
<summary>
|
|
Message code for warning that a Base Content Pack is defined but not used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0018">
|
|
<summary>
|
|
Message code for requiring a Base Content Pack but it is not defined.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0019">
|
|
<summary>
|
|
Message code for failing to parse the Content Pack Type
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.CFG0020">
|
|
<summary>
|
|
Message code for failing to parse the Content Pack Flags
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationMessageCodes.Prefix">
|
|
<summary>
|
|
Error prefix code.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigurationMessageCodes.ConfigurationMessageCode.#ctor(System.UInt16,RSG.Base.Logging.LogLevel,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.ConfigurationMessageCodes.ConfigurationMessageCode"/>
|
|
class.
|
|
</summary>
|
|
<param name="number">
|
|
The four digit numeric identifier for the message code.
|
|
</param>
|
|
<param name="level">
|
|
The level the message should be logged at.
|
|
</param>
|
|
<param name="messageFormat">
|
|
The message format to use when logging messages for this message code.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.ContentPackFlags">
|
|
<summary>
|
|
Flags Enumeration defining the different flags that can be attached to an <see cref="T:RSG.Configuration.IProjectDLC"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ContentPackFlags.None">
|
|
<summary>
|
|
No Flags Defined
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ContentPackFlags.NonCEROCompliant">
|
|
<summary>
|
|
Content Packs with this flag contain explicit, non CERO compliant assets/textures.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ContentPackFlags.TitleUpdateEnabled">
|
|
<summary>
|
|
Content Packs with this flag contain explicit, non CERO compliant assets/textures.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.ContentPackType">
|
|
<summary>
|
|
Enumeration defining the type of a <see cref="T:RSG.Configuration.IProjectDLC"/>. There are several
|
|
types available and they can be treated differently in the Asset Pipeline and by
|
|
other tools.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ContentPackType.Undefined">
|
|
<summary>
|
|
Content Pack type is undefined. This should be caught and errored.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ContentPackType.DataPackFromCore">
|
|
<summary>
|
|
Content Pack built ontop of the core project. E.g. an optional singleplayer
|
|
package.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ContentPackType.DataPackFromAnotherContentPack">
|
|
<summary>
|
|
Content Pack built on a chain of other Content Packs. E.g. a multiplayer
|
|
package where the end user will have all previous packages in the chain.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ContentPackType.DataPackTitleUpdate">
|
|
<summary>
|
|
Content Pack that is specifically the Title Update. This is also built ontop
|
|
of the core project but certain data is allowed here that isn't in a regular
|
|
Content Pack (e.g. shaders and material presets).
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ContentPackType.OptionalDataPack">
|
|
<summary>
|
|
Content Pack built upon another pack, which acts as an optional extension.
|
|
E.g. a non-CERO compliant pack with restricted assets.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ContentPackType.OptionalDataPackFromCore">
|
|
<summary>
|
|
Content Pack built upon the core pack, which acts as an optional extension.
|
|
E.g. a non-CERO compliant pack with restricted assets.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Hub.HubConfig">
|
|
<summary>
|
|
Contains the hub configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.HubConfig.MessageCodeRoot">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.HubConfig.ProjectRoot">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.HubConfig.ProjectSpaceKey">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.HubConfig.ToolsRoot">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.HubConfig.RestService">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.HubConfig.RestServiceOptions">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.HubConfig.ReadOnlyPassword">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Hub.HubRestServiceOptions">
|
|
<summary>
|
|
Implementation of <see cref="T:RSG.Configuration.Hub.IHubRestServiceOptions"/> interface.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Hub.HubRestServiceOptions.Default">
|
|
<summary>
|
|
Default options.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Hub.HubRestServiceOptions.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Hub.HubRestServiceOptions"/> class.
|
|
</summary>
|
|
<param name="linkResponseUri">
|
|
REST link response that will be replaced by the <see cref="P:RSG.Configuration.Hub.HubRestServiceOptions.LinkReplacementUri"/>.
|
|
</param>
|
|
<param name="linkReplacementUri">
|
|
REST link replacing the <see cref="P:RSG.Configuration.Hub.HubRestServiceOptions.LinkResponseUri"/>.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.HubRestServiceOptions.LinkResponseUri">
|
|
<summary>
|
|
Gets or sets the REST link response <see cref="T:System.Uri"/> that should be replaced.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.HubRestServiceOptions.LinkReplacementUri">
|
|
<summary>
|
|
Gets or sets the REST link replacement <see cref="T:System.Uri"/> that should be substituted.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Hub.IHubConfig">
|
|
<summary>
|
|
Defines the interface for retrieving hub configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.IHubConfig.MessageCodeRoot">
|
|
<summary>
|
|
Gets the message code URI on the hub.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.IHubConfig.ProjectRoot">
|
|
<summary>
|
|
Gets the Uri to the root page for the current project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.IHubConfig.ProjectSpaceKey">
|
|
<summary>
|
|
Gets the project space key.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.IHubConfig.ToolsRoot">
|
|
<summary>
|
|
Gets the Uri to the root page for tools.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.IHubConfig.RestService">
|
|
<summary>
|
|
Gets the Uri to the REST service.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.IHubConfig.RestServiceOptions">
|
|
<summary>
|
|
Gets the REST service options.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.IHubConfig.ReadOnlyPassword">
|
|
<summary>
|
|
Gets the encrypted Password to use to access hub related features
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Hub.IHubRestServiceOptions">
|
|
<summary>
|
|
Hub REST Service options interface; defines configurable options for the Hub
|
|
REST service.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.IHubRestServiceOptions.LinkResponseUri">
|
|
<summary>
|
|
Gets the REST link response <see cref="T:System.String"/> that should be replaced.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Hub.IHubRestServiceOptions.LinkReplacementUri">
|
|
<summary>
|
|
Gets the REST link replacement <see cref="T:System.String"/> that should be substituted.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.ICommandOptionsProvider">
|
|
<summary>
|
|
When implemented represents an object that can provide an instance of the
|
|
<see cref="P:RSG.Configuration.ICommandOptionsProvider.CommandOptions"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ICommandOptionsProvider.CommandOptions">
|
|
<summary>
|
|
Gets the command options.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IConfigProvider">
|
|
<summary>
|
|
Interface from which config information can be obtained.
|
|
</summary>
|
|
</member>
|
|
<member name="E:RSG.Configuration.IConfigProvider.BranchChanged">
|
|
<summary>
|
|
Event occurs when the <see cref="P:RSG.Configuration.IConfigProvider.Branch"/> property changes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfigProvider.ApplicationCollection">
|
|
<summary>
|
|
Gets the application collection for the current project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfigProvider.Branch">
|
|
<summary>
|
|
Gets or sets the currently active branch.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfigProvider.BugstarConfig">
|
|
<summary>
|
|
Gets the Bugstar configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfigProvider.Config">
|
|
<summary>
|
|
Gets the main configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfigProvider.HubConfig">
|
|
<summary>
|
|
Gets the hub configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfigProvider.LevelCollection">
|
|
<summary>
|
|
Gets the level collection for the current project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfigProvider.Project">
|
|
<summary>
|
|
Gets the currently active project.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IFileExtension">
|
|
<summary>
|
|
Interface that defines file extension metadata.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IFileExtension.ContentType">
|
|
<summary>
|
|
Gets the MIME content type for the extension.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IFileExtension.Extension">
|
|
<summary>
|
|
Gets the Extension (including ".") for the file association.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IFileExtension.Handler">
|
|
<summary>
|
|
Gets the Handler which handles this extension.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IFileExtension.PerceivedType">
|
|
<summary>
|
|
Gets the PerceivedType value to the PerceivedType to which the file belongs, if any. This string is not used by Windows
|
|
versions prior to Windows Vista.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IFileHandler">
|
|
<summary>
|
|
Handler for file extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IFileHandler.Application">
|
|
<summary>
|
|
Gets the application the handler belongs to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IFileHandler.Commands">
|
|
<summary>
|
|
Gets the set of commands this filehandler can execute.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IFileHandler.Description">
|
|
<summary>
|
|
Gets the description for this file association.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IFileHandler.HandlerId">
|
|
<summary>
|
|
Gets the name for registry in HKEY_CLASSES_ROOT and to link it to an <see cref="T:RSG.Configuration.IFileExtension" />. Any non printable ASCII
|
|
chars will be left out.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IFileHandler.IconPath">
|
|
<summary>
|
|
Gets the path to the icon for this file association.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IFileHandlerCommand">
|
|
<summary>
|
|
Handler command for a particular Windows Explorer shell action (such as Open)
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IFileHandlerCommand.ArgsFormat">
|
|
<summary>
|
|
Gets the arguments, where {0} is the file path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IFileHandlerCommand.Command">
|
|
<summary>
|
|
Gets the shell command to execute, like open.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IFileHandlerCommand.ShellDescription">
|
|
<summary>
|
|
Gets the description that is shown in the shell.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IFileHandlerCommand.ExecutablePath">
|
|
<summary>
|
|
Gets the executable path.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.ILabelledVersion">
|
|
<summary>
|
|
Version that comes from a label.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ILabelledVersion.LabelName">
|
|
<summary>
|
|
Gets the name of the label.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IMapCollection">
|
|
<summary>
|
|
Represents a set of maps.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IMapCollection.Item(System.String)">
|
|
<summary>
|
|
Gets or sets a map based off of it's name.
|
|
</summary>
|
|
<param name="name">
|
|
The name of the map to retrieve.
|
|
</param>
|
|
<returns>
|
|
The map with the specified name.
|
|
</returns>
|
|
<exception cref="T:RSG.Configuration.MapNotFoundException">
|
|
The specified map is not found.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IMapCollection.AddMap(System.String,RSG.Configuration.IMap)">
|
|
<summary>
|
|
Adds the map with the specified name to the collection.
|
|
</summary>
|
|
<param name="name">
|
|
The name of the map to add.
|
|
</param>
|
|
<param name="map">
|
|
The map to add.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IMapCollection.TryGetMap(System.String,RSG.Configuration.IMap@)">
|
|
<summary>
|
|
Gets the map associated with the specified name.
|
|
</summary>
|
|
<param name="name">
|
|
The name of the map to get.
|
|
</param>
|
|
<param name="map">
|
|
When this method returns, the map associated with the specified key, if the key is found; otherwise
|
|
<c>null</c>.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the collection contains a map with the specified name; otherwise, <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.ConfigBaseWithPathCache">
|
|
<summary>
|
|
Abstract base class for configuration class that store paths that we need to query.
|
|
</summary>
|
|
<remarks>
|
|
This is used for <see cref="T:RSG.Configuration.ITarget"/>, <see cref="T:RSG.Configuration.IBranch"/> and <see cref="T:RSG.Configuration.IProject"/>
|
|
implementations to support <see cref="M:RSG.Configuration.Implementation.ConfigBaseWithPathCache.IsRootedPath(System.String,System.String@)"/> methods.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ConfigBaseWithPathCache._pathsCache">
|
|
<summary>
|
|
Cache of all of our paths for use in <see cref="M:RSG.Configuration.Implementation.ConfigBaseWithPathCache.IsRootedPath(System.String,System.String@)"/> method.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ConfigBaseWithPathCache.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.ConfigBaseWithPathCache"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ConfigBaseWithPathCache.IsRootedPath(System.String,System.String@)">
|
|
<summary>
|
|
Return whether the passed in path is from any of this branch's
|
|
directories.
|
|
</summary>
|
|
<param name="path">
|
|
Input path to determine if this is under any of this branch's
|
|
directories.
|
|
</param>
|
|
<param name="prefix">
|
|
Branch directory that is mnatched is returned.
|
|
</param>
|
|
<returns>
|
|
true if there is a match; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ConfigBaseWithPathCache.AddPathToCache(System.String)">
|
|
<summary>
|
|
Add a path into our cache.
|
|
</summary>
|
|
<param name="path">
|
|
Path to add.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.FileExtension">
|
|
<summary>
|
|
Represents an file extension.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.FileExtension.#ctor(RSG.Configuration.IFileHandler,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Creates a new instance of <see cref="T:RSG.Configuration.Implementation.FileExtension"/>.
|
|
</summary>
|
|
<param name="handler">Handler that handles opening a file with this extension</param>
|
|
<param name="xElement">XML node that represents this item.</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.FileExtension.ContentType">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.FileExtension.Extension">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.FileExtension.Handler">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.FileExtension.PerceivedType">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.FileHandler">
|
|
<summary>
|
|
Handler for file extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.FileHandler.#ctor(RSG.Configuration.IApplication,System.Xml.Linq.XElement,RSG.Base.IEnvironment)">
|
|
<summary>
|
|
Creates instance of <see cref="T:RSG.Configuration.Implementation.FileHandler" />.
|
|
</summary>
|
|
<param name="application">Application that has this handler.</param>
|
|
<param name="xElement">XML node that represents this item.</param>
|
|
<param name="environment">Environment for replacing.</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.FileHandler.Application">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.FileHandler.Commands">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.FileHandler.Description">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.FileHandler.HandlerId">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.FileHandler.IconPath">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.FileHandler.Equals(System.Object)">
|
|
<summary>Determines whether the specified object is equal to the current object.</summary>
|
|
<returns>true if the specified object is equal to the current object; otherwise, false.</returns>
|
|
<param name="obj">The object to compare with the current object. </param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.FileHandler.GetHashCode">
|
|
<summary>Serves as the default hash function. </summary>
|
|
<returns>A hash code for the current object.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.FileHandler.Equals(RSG.Configuration.Implementation.FileHandler)">
|
|
<summary>
|
|
Checks if the supplied item is the same as this one.
|
|
</summary>
|
|
<param name="other">Item to compare with.</param>
|
|
<returns>
|
|
true if objects are equal; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.FileHandlerCommand">
|
|
<summary>
|
|
Handler command for a particular Windows Explorer shell action (such as Open)
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.FileHandlerCommand.DefaultCommand">
|
|
<summary>
|
|
Default command to use if the <see cref="P:RSG.Configuration.Implementation.FileHandlerCommand.Command"/> is not found.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.FileHandlerCommand.#ctor(RSG.Configuration.IFileHandler,System.Xml.Linq.XElement,RSG.Base.IEnvironment)">
|
|
<summary>
|
|
Creates new instance of <see cref="T:RSG.Configuration.Implementation.FileHandlerCommand"/>.
|
|
</summary>
|
|
<param name="handler">Handler for this command.</param>
|
|
<param name="xElement">XML node that represents this item.</param>
|
|
<param name="environment">Environment for substituting.</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.FileHandlerCommand.ArgsFormat">
|
|
<summary>
|
|
Gets the arguments, where {0} is the file path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.FileHandlerCommand.Command">
|
|
<summary>
|
|
Gets the shell command to execute, like open.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.FileHandlerCommand.ShellDescription">
|
|
<summary>
|
|
Gets the description that is shown in the shell
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.FileHandlerCommand.ExecutablePath">
|
|
<summary>
|
|
Gets executable path
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.MapCollection">
|
|
<summary>
|
|
Represents a collection of map objects.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.MapCollection.#ctor(System.Collections.Generic.IList{RSG.Configuration.IMap})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.MapCollection"/> class for the specified list of maps.
|
|
</summary>
|
|
<param name="maps">
|
|
The list of maps to add to the collection.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.MapCollection.Item(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.MapCollection.AddMap(System.String,RSG.Configuration.IMap)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.MapCollection.GetEnumerator">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.MapCollection.System#Collections#IEnumerable#GetEnumerator">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.MapCollection.TryGetMap(System.String,RSG.Configuration.IMap@)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.ProjectSummaryContentPack">
|
|
<summary>
|
|
Implementation of the <see cref="T:RSG.Configuration.IProjectSummaryContentPack"/> interface.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectSummaryContentPack.XmlElemContentPackType">
|
|
<summary>
|
|
XML element name for parsing <see cref="P:RSG.Configuration.Implementation.ProjectSummaryContentPack.ContentPackType"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectSummaryContentPack.XmlElemContentPackFlags">
|
|
<summary>
|
|
XML element name for parsing <see cref="P:RSG.Configuration.Implementation.ProjectSummaryContentPack.ContentPackFlags"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectSummaryContentPack.XmlElemPreviousContentPack">
|
|
<summary>
|
|
XML element name for parsing <see cref="P:RSG.Configuration.Implementation.ProjectSummaryContentPack.PreviousContentPack"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectSummaryContentPack.XmlElemBaseContentPack">
|
|
<summary>
|
|
XML element name for parsing <see cref="P:RSG.Configuration.Implementation.ProjectSummaryContentPack.BaseContentPack"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectSummaryContentPack.XmlTitleUpdateEnabled">
|
|
<summary>
|
|
XML element name for checking id the title Update is enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectSummaryContentPack._contentPackType">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ProjectSummaryContentPack.ContentPackType"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectSummaryContentPack._contentPackFlags">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ProjectSummaryContentPack.ContentPackFlags"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectSummaryContentPack._previousContentPack">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ProjectSummaryContentPack.PreviousContentPack"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectSummaryContentPack._baseContentPack">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ProjectSummaryContentPack.BaseContentPack"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectSummaryContentPack.#ctor(RSG.Base.Logging.ILog,RSG.Base.IEnvironment,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.ProjectSummaryContentPack"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="environment">
|
|
Environment object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectSummaryContentPack.ContentPackType">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectSummaryContentPack.ContentPackFlags">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectSummaryContentPack.PreviousContentPack">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectSummaryContentPack.BaseContentPack">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.SparseTarget">
|
|
<summary>
|
|
Sparse Target abstraction; representing a Sparse Target for building data.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.SparseTarget._resourceCompilersUseBaseTarget">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.SparseTarget.ResourceCompilersUseBaseTarget"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.SparseTarget.#ctor(RSG.Base.Logging.ILog,RSG.Configuration.IBranch,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.SparseTarget"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="branch">
|
|
Parent branch object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.SparseTarget.BaseTarget">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.SparseTarget.ResourceCompilersUseBaseTarget">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.SparseTarget.GetRagebuilderExecutable">
|
|
<inheritdoc />
|
|
<remarks>
|
|
We override this to ensure we use our base targets executable.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.SparseTarget.ParseTarget(RSG.Base.Logging.ILog,RSG.Configuration.IBranch,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Parse a Sparse Target data element.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="branch">
|
|
Parent branch object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.ToolsRootToolsConfig">
|
|
<summary>
|
|
<see cref="T:RSG.Configuration.IToolsConfig"/> implementation which bases the various paths off of a specific tools root directory.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ToolsRootToolsConfig.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.ToolsRootToolsConfig"/> class using the specified tools root
|
|
directory.
|
|
</summary>
|
|
<param name="toolsRootDirectory">
|
|
The directory for the tools root.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsRootToolsConfig.ToolsRootDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsRootToolsConfig.ToolsAutomationDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsRootToolsConfig.ToolsBinDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsRootToolsConfig.ToolsConfigDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsRootToolsConfig.ToolsLogsDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsRootToolsConfig.ToolsTempDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsRootToolsConfig.ToolsLibDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.ToolsVersion">
|
|
<summary>
|
|
Implementation of the <see cref="T:RSG.Configuration.Installer.IWriteableToolsVersion"/> interface.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ToolsVersion.XmlElemExpectedToolsVersion">
|
|
<summary>
|
|
XML element name for the <see cref="P:RSG.Configuration.Implementation.ToolsVersion.ExpectedToolsVersion"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ToolsVersion.XmlElemExpectedGameVersion">
|
|
<summary>
|
|
XML element name for the <see cref="P:RSG.Configuration.Implementation.ToolsVersion.ExpectedGameVersion"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ToolsVersion._filename">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ToolsVersion.Filename"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ToolsVersion.#ctor(RSG.Base.Logging.ILog,RSG.Configuration.IConfig)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.ToolsVersion"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="config">
|
|
Parent configuration object.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsVersion.Filename">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsVersion.ExpectedToolsVersion">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsVersion.ExpectedGameVersion">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ToolsVersion.Reload(RSG.Base.Logging.ILog)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ToolsVersion.SetExpectedGameVersion(System.String)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ToolsVersion.SetExpectedToolsVersion(System.String)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ToolsVersion.Save(RSG.Base.Logging.ILog)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ToolsVersion.ParseVersionConfig(RSG.Base.Logging.ILog,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
Parse version configuration file.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlDoc">
|
|
<see cref="T:System.Xml.Linq.XDocument"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.Version">
|
|
<summary>
|
|
Representation of a version.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Version.LabelRegEx">
|
|
<summary>
|
|
Regular expression for $(label)_$(major).$(minor).
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Version.#ctor(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.Version"/> class from
|
|
an <see cref="T:System.Xml.Linq.XElement"/>.
|
|
</summary>
|
|
<param name="xmlVersionElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Version.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.Version"/> class from a label.
|
|
</summary>
|
|
<param name="label">
|
|
Label string.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Version.Major">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Version.Minor">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Version.Label">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Version.CompareTo(RSG.Configuration.IVersion)">
|
|
<summary>
|
|
Compares the current object with another object of the same type.
|
|
</summary>
|
|
<param name="other">
|
|
An object to compare with this object.
|
|
</param>
|
|
<returns>
|
|
A value that indicates the relative order of the objects being compared.
|
|
The return value has the following meanings: Value Meaning Less than zero
|
|
This object is less than the other parameter.Zero This object is equal to
|
|
other. Greater than zero This object is greater than other.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Version.CompareTo(System.Object)">
|
|
<summary>
|
|
Compares the current object with another object.
|
|
</summary>
|
|
<param name="obj">
|
|
An object to compare with this object.
|
|
</param>
|
|
<returns>
|
|
A value that indicates the relative order of the objects being compared.
|
|
The return value has the following meanings: Value Meaning Less than zero
|
|
This object is less than the other parameter.Zero This object is equal to
|
|
other. Greater than zero This object is greater than other.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Version.ToString">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.StudioPerforceServer">
|
|
<summary>
|
|
Holds information for various perforce servers for a studio.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.StudioPerforceServer.#ctor(RSG.Configuration.StudioServerType,System.String,System.String,System.String)">
|
|
<summary>
|
|
Constructor
|
|
</summary>
|
|
<param name="type">The studio server type.</param>
|
|
<param name="alias">The alias for this perforce server</param>
|
|
<param name="server">The server and port for this perforce server</param>
|
|
<param name="swarmServer">The swarm server associated with this perforce server.</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.StudioPerforceServer.ServerType">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.StudioPerforceServer.Alias">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.StudioPerforceServer.Server">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.StudioPerforceServer.SwarmServer">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.Map">
|
|
<summary>
|
|
Internal implementation of <see cref="T:RSG.Configuration.IMap"/> which loads it's data from an Xml
|
|
element.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Map._description">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Implementation.Map.Description"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Map._imageSource">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Implementation.Map.ImageSource"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Map._maxBounds">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Implementation.Map.MaxBounds"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Map._minBounds">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Implementation.Map.MinBounds"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Map._name">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Implementation.Map.Name"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Map._thumbnailSource">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Implementation.Map.ThumbnailSource"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Map.Description">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Map.ImageSource">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Map.MaxBounds">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Map.MinBounds">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Map.Name">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Map.ThumbnailSource">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.ToolsBranch">
|
|
<summary>
|
|
Class to define a distribution of tools (i.e. a tools-branch). In our new
|
|
branching strategy this is considered for example "development" or "release".
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ToolsBranch.#ctor(RSG.Configuration.IConfig,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.ToolsBranch"/> class.
|
|
</summary>
|
|
<param name="config">
|
|
Configuration object.
|
|
</param>
|
|
<param name="xmlBranchElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsBranch.Config">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsBranch.Name">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsBranch.FriendlyName">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsBranch.Description">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsBranch.ToolsRootDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsBranch.ToolsBinDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsBranch.ToolsConfigDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsBranch.ToolsLogsDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsBranch.ToolsInstaller">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ToolsBranch.ToolsQuickInstaller">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ToolsBranch.Import(RSG.Base.IEnvironment)">
|
|
<summary>
|
|
Import settings into an IEnvironment object.
|
|
</summary>
|
|
<param name="environment">
|
|
<see cref="T:RSG.Base.IEnvironment"/> to import into.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.VersionControlSettings">
|
|
<summary>
|
|
Branch encapsulation; representing a project branch defining a set of
|
|
paths and targets.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.VersionControlSettings._server">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.VersionControlSettings.Server"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.VersionControlSettings._username">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.VersionControlSettings.Username"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.VersionControlSettings._workspace">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.VersionControlSettings.Workspace"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.VersionControlSettings.#ctor(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.VersionControlSettings"/> class.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.VersionControlSettings.#ctor(System.String,System.String,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.VersionControlSettings"/> class.
|
|
</summary>
|
|
<param name="server">
|
|
Server hostname.
|
|
</param>
|
|
<param name="username">
|
|
Username.
|
|
</param>
|
|
<param name="workspace">
|
|
Workspace.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.VersionControlSettings.Server">
|
|
<summary>
|
|
Gets the perforce server to connect to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.VersionControlSettings.Username">
|
|
<summary>
|
|
Gets the username to use when connecting to perforce.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.VersionControlSettings.Workspace">
|
|
<summary>
|
|
Gets the workspace to use when connecting to perforce.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.Application">
|
|
<summary>
|
|
Represents a Rockstar tools application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Application._bootstrapped">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Application.Bootstrapped"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Application._bugstarComponentId">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Application.BugstarComponentId"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Application._createShortcut">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Application.CreateShortcut"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Application._defaultArguments">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Application.DefaultArguments"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Application._defaultBugOwner">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Application.DefaultBugOwner"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Application._executablePath">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Application.ExecutablePath"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Application._name">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Application.Name"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Application._shutdownRequired">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Application.ShutdownRequired"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Application._urlProtocols">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Application.UrlProtocols"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.#ctor(System.Xml.Linq.XElement,RSG.Base.IEnvironment)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.Application"/> class using the
|
|
specified Xml element and environment.
|
|
</summary>
|
|
<param name="applicationElem">
|
|
The Xml element containing the application configuration data.
|
|
</param>
|
|
<param name="environment">
|
|
The environment to use for resolving tools variables in the config data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.Application.ProcessAccessFlags">
|
|
<summary>
|
|
PInvoke access flags.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Application.ProcessAccessFlags.QueryLimitedInformation">
|
|
<summary>
|
|
Required to retrieve certain information about a process.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Application.Bootstrapped">
|
|
<summary>
|
|
Gets a value indicating whether this application is bootstrapped and handles modifications
|
|
to its binaries when running.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Application.BugstarComponentId">
|
|
<summary>
|
|
Gets the Bugstar component id to use for this application when logging bugs.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Application.FeedLink">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Application.DaysToShowNewNews">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Application.HelpLink">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Application.CreateShortcut">
|
|
<summary>
|
|
Gets a value indicating whether this application should appear in the start menu and
|
|
the tools shortcut menu.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Application.DefaultArguments">
|
|
<summary>
|
|
Gets the default arguments to use when launching the executable.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Application.DefaultBugOwner">
|
|
<summary>
|
|
Gets the default bug owner for this application.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Application.ExecutablePath">
|
|
<summary>
|
|
Gets the path to the executable.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Application.Name">
|
|
<summary>
|
|
Gets the name of the application.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Application.PackageName">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Application.ShutdownRequired">
|
|
<summary>
|
|
Gets a value indicating whether this application needs to be shutdown when performing
|
|
operations such as syncing or installing a new project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Application.StartMenuFolderPath">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Application.UrlProtocols">
|
|
<summary>
|
|
Gets the URL protocols that this application handles.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Application.FileExtensions">
|
|
<summary>
|
|
Gets the file associations that this application handles.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.IsInstanceRunning">
|
|
<summary>
|
|
Determines whether an instance of the application is already running in release mode (*.exe) or in debug mode (*.vshost.exe).
|
|
</summary>
|
|
<returns>
|
|
True if an instance of the application is running, otherwise false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.IsInstanceRunningInProject">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.LaunchApplication">
|
|
<summary>
|
|
Launches the application.
|
|
</summary>
|
|
<returns>
|
|
The process object corresponding to the launched application.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.LaunchApplication(System.String)">
|
|
<summary>
|
|
Launches the application using the specified arguments.
|
|
</summary>
|
|
<param name="arguments">
|
|
The arguments to use when launching the application.
|
|
</param>
|
|
<returns>
|
|
The process object corresponding to the launched application.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.LaunchApplication(System.Diagnostics.ProcessStartInfo)">
|
|
<summary>
|
|
Launches the application using the specified process start info.
|
|
</summary>
|
|
<param name="startInfo">
|
|
The process start information to use when launching the application.
|
|
</param>
|
|
<returns>
|
|
The process object corresponding to the launched application.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.LaunchApplicationWithCommand(System.String,System.String)">
|
|
<summary>
|
|
Launch application for the given filepath, and given shell command.
|
|
</summary>
|
|
<param name="filePath">Filepath with valid extension that can be opened with application.</param>
|
|
<param name="command">Shell command to use to open file</param>
|
|
<returns>
|
|
The process object corresponding to the launched application.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.CanOpenExtensionWithCommand(System.String,System.String)">
|
|
<summary>
|
|
Reports if the application can open the specified extension, with the specified shell command.
|
|
</summary>
|
|
<param name="extension">Extension (including '.') to open.</param>
|
|
<param name="command">Shell command to use ('Open' for example)</param>
|
|
<returns>True if this instance can open a file with the given extension.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.CanOpenExtension(System.String)">
|
|
<summary>
|
|
Reports if the application can open the specified extension, with the specified shell command.
|
|
</summary>
|
|
<param name="extension">Extension (including '.') to open.</param>
|
|
<returns>True if this instance can open a file with the given extension.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.KillRunningInstances(RSG.Base.Logging.ILog)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.KillRunningInstancesInProject(RSG.Base.Logging.ILog)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.CloseRunningInstances(RSG.Base.Logging.ILog)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.CloseRunningInstancesInProject(RSG.Base.Logging.ILog)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.QueryFullProcessImageName(System.IntPtr,System.Int32,System.Text.StringBuilder,System.Int32@)">
|
|
<summary>
|
|
Retrieves the full name of the executable image for the specified process. (by Process Handle)
|
|
</summary>
|
|
<param name="hProcess">
|
|
A handle to the process. This handle must be created with the PROCESS_QUERY_INFORMATION or PROCESS_QUERY_LIMITED_INFORMATION access right.
|
|
</param>
|
|
<param name="dwFlags">
|
|
0 = The name should use the Win32 path format.
|
|
0x00000001 = hardware path.
|
|
</param>
|
|
<param name="lpExeName">
|
|
The path to the executable image. If the function succeeds, this string is null-terminated.
|
|
</param>
|
|
<param name="lpdwSize">
|
|
On input, specifies the size of the lpExeName buffer, in characters. On success, receives the number of characters written to the buffer, not including the null-terminating character.
|
|
</param>
|
|
<returns>
|
|
If the function succeeds, the return value is nonzero.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.OpenProcess(RSG.Configuration.Implementation.Application.ProcessAccessFlags,System.Boolean,System.Int32)">
|
|
<summary>
|
|
Opens an existing local process object.
|
|
</summary>
|
|
<param name="processAccess">
|
|
The access to the process object. This access right is checked against the security descriptor for the process. This parameter can be one or more of the process access rights.
|
|
</param>
|
|
<param name="bInheritHandle">
|
|
If this value is TRUE, processes created by this process will inherit the handle. Otherwise, the processes do not inherit this handle.
|
|
</param>
|
|
<param name="processId">
|
|
The identifier of the local process to be opened.
|
|
</param>
|
|
<returns>
|
|
f the function succeeds, the return value is an open handle to the specified process.
|
|
If the function fails, the return value is NULL.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.GetRunningInstances">
|
|
<summary>
|
|
Obtains all executable processes that are running.
|
|
</summary>
|
|
<returns>Processes.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.KillRunningInstances(System.Collections.Generic.IEnumerable{System.Diagnostics.Process},RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Attempts to kill all processes.
|
|
</summary>
|
|
<param name="appProcesses">Processes to kill.</param>
|
|
<param name="log">Log.</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.CloseRunningInstances(System.Collections.Generic.IEnumerable{System.Diagnostics.Process},RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Attempts to send shutdown messages to all processes.
|
|
</summary>
|
|
<param name="appProcesses">Processes to close.</param>
|
|
<param name="log">Log.</param>
|
|
<returns>False if any issues sending the shutdown message occurs.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Application.GetProcessesForProject(System.Collections.Generic.IEnumerable{System.Diagnostics.Process})">
|
|
<summary>
|
|
Determines if the processes provided are relevant to this application configuration
|
|
by checking against the <see cref="P:RSG.Configuration.Implementation.Application.ExecutablePath"/> stripped of its drive root.
|
|
This will allow filtering of applications across projects.
|
|
</summary>
|
|
<param name="processes">Processes to check.</param>
|
|
<returns>Processes that are relevant to this application configuration.</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.ApplicationCollection">
|
|
<summary>
|
|
Represents a collection of tools applications.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ApplicationCollection.ApplicationXmlElementName">
|
|
<summary>
|
|
Gets the name of the XML element in an application config file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ApplicationCollection._applications">
|
|
<summary>
|
|
Primary lookup for our applications based on their name.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ApplicationCollection.#ctor(RSG.Base.Logging.ILog,RSG.Configuration.IProject)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.ApplicationCollection"/> using the
|
|
specified log and project.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ApplicationCollection.Item(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ApplicationCollection.Item(RSG.Configuration.RockstarApplication)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ApplicationCollection.ContainsApplication(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ApplicationCollection.ContainsApplication(RSG.Configuration.RockstarApplication)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ApplicationCollection.GetEnumerator">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ApplicationCollection.System#Collections#IEnumerable#GetEnumerator">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ApplicationCollection.TryGetApplication(System.String,RSG.Configuration.IApplication@)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ApplicationCollection.TryGetApplication(RSG.Configuration.RockstarApplication,RSG.Configuration.IApplication@)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ApplicationCollection.GetApplicationToExcuteCommand(System.String,System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ApplicationCollection.GetApplicationToOpenExtension(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ApplicationCollection.ParseApplicationFiles(RSG.Base.Logging.ILog,System.String,RSG.Base.IEnvironment)">
|
|
<summary>
|
|
Parses the application configuration files.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="applicationsConfigDirectory">
|
|
Directory for configuration files.
|
|
</param>
|
|
<param name="environment">
|
|
Environment.
|
|
</param>
|
|
<returns>
|
|
Set of <see cref="T:RSG.Configuration.IApplication"/> objects.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ApplicationCollection.ParseApplicationFile(System.String,RSG.Base.IEnvironment,System.String)">
|
|
<summary>
|
|
Parses a single application collection element.
|
|
</summary>
|
|
<param name="filepath">
|
|
File to load.
|
|
</param>
|
|
<param name="environment">
|
|
Environment.
|
|
</param>
|
|
<param name="overrideFilePath">Path to optional override file.</param>
|
|
<returns>
|
|
A new object implementing the <see cref="T:RSG.Configuration.IApplication"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.AssetPrefix">
|
|
<summary>
|
|
Asset prefixes for the pipeline and all tools.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.AssetPrefix._mapPrefix">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.AssetPrefix.MapPrefix"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.AssetPrefix.#ctor(RSG.Configuration.IProject)">
|
|
<summary>
|
|
Constructor (for compatibility where XML data doesn't exist).
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.AssetPrefix.#ctor(RSG.Configuration.IProject,System.String)">
|
|
<summary>
|
|
Constructor (overriding map prefix).
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="mapPrefix">
|
|
Map prefix.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.AssetPrefix.#ctor(RSG.Configuration.IProjectCore,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Constructor (from XML data).
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.AssetPrefix.Name">
|
|
<summary>
|
|
Gets the project name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.AssetPrefix.IsDLC">
|
|
<summary>
|
|
Gets a value indicating whether this is for a DLC project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.AssetPrefix.MapPrefix">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.Branch">
|
|
<summary>
|
|
Branch encapsulation; representing a project branch defining a set of
|
|
paths and targets.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch.CoreBranchEnvironmentPrefix">
|
|
<summary>
|
|
Prefix for core branch variable
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch.TuOrCoreBranchEnvironmentPrefix">
|
|
<summary>
|
|
Prefix for tu_or_core branch variable
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._name">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Name"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._assetsDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Assets"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._automationArtefactsDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.AutomationArtefacts"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._contentFilename">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Content"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._exportDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Export"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._sourceDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Source"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._processedDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Processed"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._metadataDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Metadata"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._metadataDefinitionsDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Definitions"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._audioDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Audio"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._buildDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Build"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._commonDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Common"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._shadersDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Shaders"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._codeDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Code"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._rageCodeDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.RageCode"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._animationDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Anim"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._artDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Art"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._resourceDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Resource"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._independentResourceDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.IndependentResource"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._platformResourceDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.PlatformResource"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._previewDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Preview"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._scriptDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Script"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._fragmentTuneDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.FragmentTune"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._textDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.Text"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._uiDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.UI"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Branch._vaultAssetsPath">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Branch.VaultAssetsPath"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Branch.#ctor(RSG.Base.Logging.ILog,RSG.Configuration.IProject,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.Branch"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="project">
|
|
Parent project.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Project">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Name">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Locked">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Environment">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Art">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Anim">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Assets">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.AutomationArtefacts">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Content">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Export">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Source">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Processed">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Metadata">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Definitions">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Audio">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Build">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Common">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Shaders">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Code">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.RageCode">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Resource">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.IndependentResource">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.PlatformResource">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Preview">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Script">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.FragmentTune">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Text">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.UI">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.VaultAssetsPath">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.Targets">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.PlatformConversionTools">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.BuildLabel">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Branch.RageBuilderCommonArgs">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Branch.IsRootedPath(System.String,System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Branch.Import(RSG.Base.IEnvironment)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Branch.ParseLocal(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Branch.ToString">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Branch.ImportCoreBranch(RSG.Base.IEnvironment,System.String)">
|
|
<summary>
|
|
Import Core branch prefixed variables in environment
|
|
</summary>
|
|
<param name="environment">environment to import in</param>
|
|
<param name="prefix">core or tu_or_core prefix</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Branch.ImportTuOrCoreBranch(RSG.Base.IEnvironment)">
|
|
<summary>
|
|
Import Tu or Core branch prefixed variables in environment
|
|
</summary>
|
|
<param name="environment">environment to import in</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Branch.CreatePathCache">
|
|
<summary>
|
|
Method to populate all of the paths by calling <see cref="M:RSG.Configuration.Implementation.ConfigBaseWithPathCache.AddPathToCache(System.String)"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Branch.ParseBranch(RSG.Base.Logging.ILog,System.Xml.Linq.XElement,System.Boolean)">
|
|
<summary>
|
|
Parse branch element data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<param name="local">
|
|
Value indicating whether we are loading users local settings file.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Branch.ParseDirectories(RSG.Base.Logging.ILog,System.Xml.Linq.XElement,System.Boolean)">
|
|
<summary>
|
|
Parse new directory format structure.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<param name="local">
|
|
Value indicating whether we are loading users local settings file.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Branch.ParseBranchTarget(RSG.Base.Logging.ILog,System.Xml.Linq.XElement,System.Boolean)">
|
|
<summary>
|
|
Parse branch target element data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<param name="local">
|
|
Value indicating whether we are loading users local settings file.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Branch.ParseConversionTool(RSG.Base.Logging.ILog,System.Xml.Linq.XElement,System.Boolean)">
|
|
<summary>
|
|
Parse branch conversion tool element data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<param name="local">
|
|
Value indicating whether we are loading users local settings file.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Branch.Import(RSG.Base.IEnvironment,System.String)">
|
|
<summary>
|
|
Import settings implementation; taking prefix to handle "core" settings
|
|
and active variants.
|
|
</summary>
|
|
<param name="environment">
|
|
Environment object.
|
|
</param>
|
|
<param name="prefix">
|
|
Prefix is applicable.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.Config">
|
|
<summary>
|
|
Entry Configuration class for system-wide globals for current tools
|
|
branch. This includes the project context for the current tools branch.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Config.ExpectedConfigVersion">
|
|
<summary>
|
|
Expected configuration format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Config._forceUpdateHostNameAndUserStudio">
|
|
<summary>
|
|
Indicates whether or not dynamic data (like the DNS and user studio) should be refreshed from source, and not use the local values from the local config file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Config._studios">
|
|
<summary>
|
|
Available <see cref="T:RSG.Configuration.IStudio"/> collection.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Config._toolsBranches">
|
|
<summary>
|
|
Available <see cref="T:RSG.Configuration.IToolsBranch"/> collection.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Config._versionControlSettings">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Config.VersionControlSettings"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Config._userStudioKey">
|
|
<summary>
|
|
User studio name.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Config.#ctor(RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="log">
|
|
Logger object.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Config.#ctor(RSG.Base.Logging.ILog,RSG.Configuration.IToolsConfig,System.Boolean)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.Config"/> class using the
|
|
specified log object, tools root path and skip version check flag.
|
|
</summary>
|
|
<param name="log">Instance of the log</param>
|
|
<param name="dynamicConfig">Dynamic tools configuration data.</param>
|
|
<param name="forceUpdateHostNameAndUserStudio">
|
|
Forces the DNS hostname and user studio to be updated, and not use the local config value.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.ConfigVersion">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.Filename">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.WriteableVersion">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.Version">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.ToolsRootDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.ToolsAutomationDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.ToolsBinDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.ToolsLibDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.ToolsConfigDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.ToolsLogsDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.ToolsTempDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.ToolsInstaller">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.ToolsQuickInstaller">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.Project">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.Projects">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.CurrentStudio">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.Studios">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.CurrentToolsBranch">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.DefaultEndUserToolsBranch">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.ToolsBranches">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.InstallTime">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.Username">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.HostName">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.EmailAddress">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.IsAutomationMachine">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.VersionControlEnabled">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.AlwaysUpdateFileAssociations">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.AutodeskMaxInstallationSelection">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.VersionControlSettings">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.Environment">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Config.DefaultProjectName">
|
|
<summary>
|
|
Gets the default project name. This is not available outside of the
|
|
configuration assembly so applications are not tempted to use it.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Config.GetConfigFilename(System.String)">
|
|
<summary>
|
|
Return global tools configuration filename.
|
|
</summary>
|
|
<param name="toolsRoot">
|
|
Tools root directory.
|
|
</param>
|
|
<returns>
|
|
Global tool configuration filename.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Config.Import(RSG.Base.IEnvironment)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Config.DetermineBranchForFilenames(System.Collections.Generic.IEnumerable{System.String})">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Config.Reload(RSG.Base.Logging.ILog)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Config.SaveLocal">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Config.SetVersionControlSettings(System.String,System.String,System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Config.ParseConfig(RSG.Base.Logging.ILog,System.Xml.Linq.XDocument,System.Boolean)">
|
|
<summary>
|
|
Parse top-level configuration data elements.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlDoc">
|
|
<see cref="T:System.Xml.Linq.XDocument"/> to parse.
|
|
</param>
|
|
<param name="local">
|
|
Value indicating whether we are loading local user settings file.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Config.ParseStudioFile(RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Parse top-level Studio metadata file.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Config.SetCurrentToolsBranch">
|
|
<summary>
|
|
Sets the current tools branch.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Config.SetCurrentStudio(RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Sets the current studio property based on subnet mask.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Config.GetBranchForFilename(System.Collections.Generic.IEnumerable{RSG.Configuration.IBranch},System.String,RSG.Configuration.IBranch@,System.String@)">
|
|
<summary>
|
|
Get branch for a particular filename.
|
|
</summary>
|
|
<param name="branches">
|
|
Set of <see cref="T:RSG.Configuration.IBranch"/> objects to test.
|
|
</param>
|
|
<param name="filename">
|
|
Input filename.
|
|
</param>
|
|
<param name="branch">
|
|
Output branch (or null).
|
|
</param>
|
|
<param name="prefixPath">
|
|
Output prefix path (or empty string).
|
|
</param>
|
|
<returns>
|
|
true if branch found; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.ConfigBase">
|
|
<summary>
|
|
Base configuration class that contains common functions that all config base
|
|
classes may need (such as attribute parsing methods).
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ConfigBase.GetAttrValue(System.Xml.Linq.XElement,System.String,System.String@)">
|
|
<summary>
|
|
Read an attribute value from an XElement.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to read attribute from.
|
|
</param>
|
|
<param name="attr">
|
|
Attribute name.
|
|
</param>
|
|
<param name="value">
|
|
Value to update.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ConfigBase.ReadAttribute``1(System.Xml.Linq.XElement,System.String)">
|
|
<summary>
|
|
Read attribute of a particular type.
|
|
</summary>
|
|
<typeparam name="T">
|
|
Value type.
|
|
</typeparam>
|
|
<param name="elem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to read attribute from.
|
|
</param>
|
|
<param name="attr">
|
|
Attribute name.
|
|
</param>
|
|
<returns>
|
|
Attribute value.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.Environment">
|
|
<summary>
|
|
Environment class to allow variable string substitution.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Environment._reverseSubstFixupPrefixes">
|
|
<summary>
|
|
Prefixes for reverse subst fixup
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Environment._variables">
|
|
<summary>
|
|
Local dictionary of Name -> Value pairs.
|
|
</summary>
|
|
This should not be public; use the Add/Remove method for validating
|
|
entries.
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Environment.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.Environment"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Environment.#ctor(RSG.Base.IEnvironment)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.Environment"/> class
|
|
from an existing <see cref="T:RSG.Base.IEnvironment"/>.
|
|
</summary>
|
|
<param name="environment">
|
|
Environment to clone.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Environment.#ctor(RSG.Configuration.ICanImportEnvironment)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.Environment"/> class.
|
|
</summary>
|
|
<param name="configObject">
|
|
Initial object to import.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Environment.Depth">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Environment.Item(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Environment.Add(System.String,System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Environment.Add(System.String,System.String,RSG.Base.EnvironmentBracketType)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Environment.Lookup(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Environment.Subst(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Environment.ReverseSubst(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Environment.RequiresSubst(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Environment.Reset">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Environment.Clear">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Environment.Push">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Environment.Pop">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Environment.GetEnumerator">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Environment.System#Collections#IEnumerable#GetEnumerator">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.ForceFlags">
|
|
<summary>
|
|
Force flags configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ForceFlags.#ctor(RSG.Configuration.IProject)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.ForceFlags"/> class.
|
|
</summary>
|
|
<param name="project">
|
|
Parent project.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ForceFlags.#ctor(RSG.Configuration.IProject,System.Boolean)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.ForceFlags"/> class.
|
|
</summary>
|
|
<param name="project">
|
|
Parent project.
|
|
</param>
|
|
<param name="allNewContent">
|
|
Value indicating whether this is all new content.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ForceFlags.#ctor(RSG.Configuration.IProject,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.ForceFlags"/> class.
|
|
</summary>
|
|
<param name="project">
|
|
Parent project.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ForceFlags.AllNewContent">
|
|
<summary>
|
|
Gets a value indicating whether all data content is new (e.g. "New DLC" for maps).
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.Level">
|
|
<summary>
|
|
A level object; implementing the <see cref="T:RSG.Configuration.ILevel"/> interface.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Level._environment">
|
|
<summary>
|
|
Private environment object to evaluate paths.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Level._id">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Level.Id"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Level._name">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Level.Name"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Level._friendlyName">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Level.FriendlyName"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Level._commonDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Level.CommonDirectory"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Level._exportDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Level.ExportDirectory"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Level._processedDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Level.ProcessedDirectory"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Level._metadataFilename">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Level.MetadataFilename"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Level._vaultAssetPath">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Level.VaultAssetsPath"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Level._bugstarId">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Level.BugstarId"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Level._backgroundMaps">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Level.BackgroundMaps"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Level._mapsSource">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Level.MapsSource"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Level._vectorMapFilename">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.Level.VectorMapFile"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Level.#ctor(RSG.Base.IEnvironment,System.Guid,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Nullable{System.UInt32},RSG.Configuration.IMapCollection,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.Level"/> object.
|
|
</summary>
|
|
<param name="enviroment">
|
|
Environment.
|
|
</param>
|
|
<param name="identifier">
|
|
Level identifier.
|
|
</param>
|
|
<param name="name">
|
|
Level name.
|
|
</param>
|
|
<param name="friendlyName">
|
|
Level friendly-name.
|
|
</param>
|
|
<param name="commonDirectory">
|
|
Level common directory.
|
|
</param>
|
|
<param name="exportDirectory">
|
|
Level export directory.
|
|
</param>
|
|
<param name="processedDirectory">
|
|
Level processed directory.
|
|
</param>
|
|
<param name="metadataFilename">
|
|
Level metadata filename.
|
|
</param>
|
|
<param name="vaultAssetsPath">
|
|
Level Vault Assets path.
|
|
</param>
|
|
<param name="vectorMapFilename">
|
|
Vector map filename for the level.
|
|
</param>
|
|
<param name="bugstarId">
|
|
Level Bugstar identifier.
|
|
</param>
|
|
<param name="backgroundMaps">
|
|
Background image information.
|
|
</param>
|
|
<param name="mapsSource">
|
|
The source for the maps information.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Level.Id">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Level.Name">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Level.FriendlyName">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Level.CommonDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Level.ExportDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Level.ProcessedDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Level.MetadataFilename">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Level.VaultAssetsPath">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Level.BugstarId">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Level.BackgroundMaps">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Level.MapsSource">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Level.VectorMapFile">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Level.IsLevelFile(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Level.IsLevelFile(System.Collections.Generic.IEnumerable{RSG.Configuration.ITarget},System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Level.IsLevelVaultAsset(System.String)">
|
|
<summary>
|
|
Return whether the passed in Vault Asset Path is part of the level.
|
|
</summary>
|
|
<param name="vaultAssetPath">
|
|
Absolute path to the Vault Asset.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the file is part of the level; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Level.IsLevelVaultAsset(System.Uri)">
|
|
<summary>
|
|
Return whether the passed in Vault Asset Path is part of the level.
|
|
</summary>
|
|
<param name="vaultAssetPath">
|
|
Absolute Uri to the Vault Asset.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the file is part of the level; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Level.IsLevelFileFromTarget(RSG.Configuration.ITarget,System.String)">
|
|
<summary>
|
|
Determine whether a file is under a target directory.
|
|
</summary>
|
|
<param name="targets">
|
|
The list of targets to check
|
|
</param>
|
|
<param name="filepath">
|
|
Filepath to check
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the file is part of the level; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.LevelCollection">
|
|
<summary>
|
|
Represents the levels within a game project.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.LevelCollection._defaultLevel">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Implementation.LevelCollection.Default"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.LevelCollection._levels">
|
|
<summary>
|
|
Storage for our ILevel objects.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.LevelCollection.#ctor(System.Collections.Generic.IEnumerable{RSG.Configuration.ILevel},System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.LevelCollection"/> class using the
|
|
specified list of levels and the default level name.
|
|
</summary>
|
|
<param name="levels">
|
|
Set of <see cref="T:RSG.Configuration.ILevel"/> objects.
|
|
</param>
|
|
<param name="defaultLevelName">
|
|
Default level name.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.LevelCollection.Default">
|
|
<summary>
|
|
Gets the default level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.LevelCollection.Item(System.Guid)">
|
|
<summary>
|
|
Gets a level by it's id.
|
|
</summary>
|
|
<param name="id">
|
|
The unique id for the level.
|
|
</param>
|
|
<returns>
|
|
The level which is identified by the specified <paramref name="id"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.LevelCollection.Item(System.String)">
|
|
<summary>
|
|
Gets a level by it's name.
|
|
</summary>
|
|
<param name="name">
|
|
The unique name for the level.
|
|
</param>
|
|
<returns>
|
|
The level which is identified by the specified <paramref name="name"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.LevelCollection.GetEnumerator">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.LevelCollection.System#Collections#IEnumerable#GetEnumerator">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.LevelCollection.GetLevelForFilename(System.String)">
|
|
<summary>
|
|
Return level for specified filename (if one exists, null otherwise).
|
|
</summary>
|
|
<param name="filename">
|
|
Filename to find level for.
|
|
</param>
|
|
<returns>
|
|
<see cref="T:RSG.Configuration.ILevel"/> for specified filename (if one exists, null otherwise).
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.LevelCollection.GetLevelForFilename(System.Collections.Generic.IEnumerable{RSG.Configuration.ITarget},System.String)">
|
|
<summary>
|
|
Return level for specified filename (if one exists, null otherwise).
|
|
</summary>
|
|
<param name="targets">
|
|
Set of targets to check.
|
|
</param>
|
|
<param name="filename">
|
|
Filename to find level for.
|
|
</param>
|
|
<returns>
|
|
<see cref="T:RSG.Configuration.ILevel"/> for specified filename (if one exists, null otherwise).
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.LevelCollection.GetUniqueLevelForFilenames(System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Return unique level for all files.
|
|
</summary>
|
|
<param name="filenames">
|
|
Filenames to test.
|
|
</param>
|
|
<returns>
|
|
Unique level for all the filenames.
|
|
</returns>
|
|
<exception cref="T:RSG.Configuration.LevelNotUniqueException">
|
|
Exception raised when all the filenames do not correspond to the same level.
|
|
</exception>
|
|
<exception cref="T:RSG.Configuration.LevelNotFoundException">
|
|
Exception raised when no level is found for the filenames.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.LevelCollection.GetLevelsForFilenames(System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Return set of levels used by specified files.
|
|
</summary>
|
|
<param name="filenames">
|
|
Filenames to test.</param>
|
|
<returns>
|
|
Set of <see cref="T:RSG.Configuration.ILevel"/> objects.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.LevelCollection.GetLevelsForFilenames(System.Collections.Generic.IEnumerable{RSG.Configuration.ITarget},System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Return set of levels used by specified files.
|
|
</summary>
|
|
<param name="targets">
|
|
Set of targets.
|
|
</param>
|
|
<param name="filenames">
|
|
Filenames to test.
|
|
</param>
|
|
<returns>
|
|
Set of <see cref="T:RSG.Configuration.ILevel"/> objects.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.LevelCollection.GetLevelForVaultAssetPath(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.LevelCollection.GetLevelForVaultAssetPath(RSG.Base.IO.VaultPath)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.LevelCollection.GetUniqueLevelForVaultAssetPaths(System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Return unqiue level for all specified Vault Asset Path.
|
|
</summary>
|
|
<param name="vaultAssetPaths">
|
|
Vault Asset Paths.
|
|
</param>
|
|
<returns>
|
|
Unqiue level for all specified Vault Asset Path.
|
|
</returns>
|
|
<exception cref="T:RSG.Configuration.LevelNotUniqueException">
|
|
Exception raised when all the Vault Assets do not correspond to the same level.
|
|
</exception>
|
|
<exception cref="T:RSG.Configuration.LevelNotFoundException">
|
|
Exception raised when no level is found for the Vault Assets.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.LevelCollection.GetUniqueLevelForVaultAssetPaths(System.Collections.Generic.IEnumerable{RSG.Base.IO.VaultPath})">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.LevelCollection.GetLevelsForVaultAssetPaths(System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Return set of levels for all specified Vault Asset Path.
|
|
</summary>
|
|
<param name="vaultAssetPaths">
|
|
Vault Asset Paths.
|
|
</param>
|
|
<returns>
|
|
Set of levels for all specified Vault Asset Path.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.LevelCollection.GetLevelsForVaultAssetPaths(System.Collections.Generic.IEnumerable{RSG.Base.IO.VaultPath})">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.LevelCollection.TryGetLevel(System.Guid,RSG.Configuration.ILevel@)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.LevelCollection.TryGetLevel(System.String,RSG.Configuration.ILevel@)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.ProjectCore">
|
|
<summary>
|
|
Core project encapsulation; representing a project defining a set of
|
|
branches and targets.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectCore._projectSummary">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ProjectCore.ProjectSummary"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectCore._dlcProjects">
|
|
<summary>
|
|
Private field for storing DLC project content-packs.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectCore.#ctor(RSG.Base.Logging.ILog,RSG.Configuration.IConfig,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.ProjectCore"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="config">
|
|
Config object parent.
|
|
</param>
|
|
<param name="xmlProjectSummary">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectCore.Name">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectCore.FriendlyName">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectCore.RootDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectCore.Filename">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectCore.LocalFilename">
|
|
<summary>
|
|
Gets the local configuration filename for user settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectCore.ProjectSummary">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectCore.DLCProjects">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectCore.Import(RSG.Base.IEnvironment)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectCore.Reload(RSG.Base.Logging.ILog)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectCore.SaveLocal">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectCore.ToString">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectCore.ParseContentPacks(RSG.Base.Logging.ILog,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
Parse content packs configuration data elements.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlDocContentPacks">
|
|
<see cref="T:System.Xml.Linq.XDocument"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.ProjectBase">
|
|
<summary>
|
|
Base project encapsulation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectBase.CoreProjectPrefix">
|
|
<summary>
|
|
Environment prefix string for pulling in core project variables.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectBase.TuOrCoreProjectPrefix">
|
|
<summary>
|
|
Environment prefix string for pulling in tu_or_core project variables.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectBase._automationDataDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ProjectBase.AutomationDataDirectory"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectBase._cacheDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ProjectBase.CacheDirectory"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectBase._vaultDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ProjectBase.VaultDirectory"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectBase.#ctor(RSG.Base.Logging.ILog,RSG.Configuration.IConfig)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.ProjectBase"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="config">
|
|
Config object parent.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.AutomationDataDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.Name">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.FriendlyName">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.RootDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.Filename">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.CacheDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.VaultDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.HasLevels">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.ForceFlags">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.AssetPrefix">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.Config">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.ToolsEmailAddresses">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.Branches">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.Labels">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.DefaultPlatforms">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.Environment">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectBase.DefaultBranchName">
|
|
<summary>
|
|
Gets or sets the default branch name.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectBase.Import(RSG.Base.IEnvironment)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectBase.Reload(RSG.Base.Logging.ILog)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectBase.ToString">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectBase.ImportBasic(RSG.Base.IEnvironment,System.String)">
|
|
<summary>
|
|
Import the basics (from initial config XML load). This is required for
|
|
DLC packs to ensure we can resolve $(root) in the filename path.
|
|
</summary>
|
|
<param name="environment">
|
|
Environment object.
|
|
</param>
|
|
<param name="prefix">
|
|
Prefix to apply.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectBase.Import(RSG.Base.IEnvironment,System.String)">
|
|
<summary>
|
|
Import settings implementation; taking prefix to handle "core" settings
|
|
and active variants.
|
|
</summary>
|
|
<param name="environment">
|
|
Environment object.
|
|
</param>
|
|
<param name="prefix">
|
|
Prefix to apply.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectBase.ParseProject(RSG.Base.Logging.ILog,System.Xml.Linq.XDocument,System.Boolean)">
|
|
<summary>
|
|
Parse top-level project configuration data elements.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlDoc">
|
|
<see cref="T:System.Xml.Linq.XDocument"/> to parse.
|
|
</param>
|
|
<param name="local">
|
|
Value indicating whether we are loading the local user-settings file.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectBase.CreatePathCache">
|
|
<summary>
|
|
Method to populate all of the paths by calling <see cref="M:RSG.Configuration.Implementation.ConfigBaseWithPathCache.AddPathToCache(System.String)"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectBase.ParseProjectAttributes(System.Xml.Linq.XDocument,System.Boolean)">
|
|
<summary>
|
|
Parse top-level project data attributes.
|
|
</summary>
|
|
<param name="xmlDoc">
|
|
<see cref="T:System.Xml.Linq.XDocument"/> to parse.
|
|
</param>
|
|
<param name="local">
|
|
Value indicating whether we are parsing the user settings file.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectBase.SetupDefaultBranch(RSG.Base.Logging.ILog,System.Xml.Linq.XDocument,System.Boolean)">
|
|
<summary>
|
|
Setup default branch properties.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlDoc">
|
|
<see cref="T:System.Xml.Linq.XDocument"/> to parse.
|
|
</param>
|
|
<param name="local">
|
|
Value indicating whether we are parsing the user settings file.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectBase.ParseBranch(RSG.Base.Logging.ILog,System.Xml.Linq.XElement,System.Boolean)">
|
|
<summary>
|
|
Parse project branch element.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<param name="local">
|
|
Value indicating whether we are parsing the user settings file.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectBase.ParseDefaultPlatform(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Parse project default platform element.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectBase.ParseLabel(RSG.Base.Logging.ILog,System.Xml.Linq.XElement,System.Boolean)">
|
|
<summary>
|
|
Parse project label element.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<param name="local">
|
|
Value indicating whether we are parsing the user settings file.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.ProjectContentPack">
|
|
<summary>
|
|
DLC project (content-pack) encapsulation; with a reference to the core project.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectContentPack._projectSummary">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ProjectContentPack.ProjectSummary"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectContentPack._coreProject">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ProjectContentPack.CoreProject"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectContentPack.#ctor(RSG.Base.Logging.ILog,RSG.Configuration.IProjectCore,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.ProjectContentPack"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="coreProject">
|
|
Parent <see cref="T:RSG.Configuration.IProjectCore"/>.
|
|
</param>
|
|
<param name="xmlProjectSummary">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectContentPack.Name">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectContentPack.FriendlyName">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectContentPack.RootDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectContentPack.Filename">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectContentPack.ProjectSummary">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectContentPack.CoreProject">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectContentPack.Reload(RSG.Base.Logging.ILog)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectContentPack.Import(RSG.Base.IEnvironment)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectContentPack.WalkContentPackChain(System.Boolean)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectContentPack.WalkProjectChain(System.Boolean)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectContentPack.IsTitleUpdateContentPackEnabled">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectContentPack.SetupBranchDLCTargets">
|
|
<summary>
|
|
Initialise Branch DLC targets.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.ProjectSummary">
|
|
<summary>
|
|
Project summary interface; for reading summary information about
|
|
available projects when the configuration data may not be available.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectSummary._environment">
|
|
<summary>
|
|
Private field for the <see cref="T:RSG.Configuration.Implementation.Environment"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectSummary._key">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ProjectSummary.Key"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectSummary._friendlyName">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ProjectSummary.FriendlyName"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectSummary._rootDirectory">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ProjectSummary.RootDirectory"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectSummary._configurationFilename">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ProjectSummary.ConfigurationFilename"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectSummary.#ctor(RSG.Base.IEnvironment,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.ProjectSummary"/> class.
|
|
</summary>
|
|
<param name="environment">
|
|
Environment.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectSummary.Key">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectSummary.FriendlyName">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectSummary.RootDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectSummary.ConfigurationFilename">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.ProjectSummaryCore">
|
|
<summary>
|
|
Implementation of the <see cref="T:RSG.Configuration.IProjectSummaryCore"/> interface.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectSummaryCore._contentPacksConfigurationFilename">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ProjectSummaryCore.ContentPacksConfigurationFilename"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.ProjectSummaryCore._localConfigurationFilename">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.ProjectSummaryCore.LocalConfigurationFilename"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.ProjectSummaryCore.#ctor(RSG.Base.IEnvironment,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.ProjectSummaryCore"/> class.
|
|
</summary>
|
|
<param name="environment">
|
|
Environment.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectSummaryCore.ContentPacksConfigurationFilename">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.ProjectSummaryCore.LocalConfigurationFilename">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.RageConversionTool">
|
|
<summary>
|
|
Implementation of the <see cref="T:RSG.Configuration.IPlatformConversionTool"/> for RAGE/Ragebuilder.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.RageConversionTool._executablePath">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Implementation.RageConversionTool.ExecutablePath"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.RageConversionTool.#ctor(RSG.Configuration.IBranch,RSG.Platform.Platform,System.String,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.RageConversionTool"/> class.
|
|
</summary>
|
|
<param name="branch">
|
|
Branch object.
|
|
</param>
|
|
<param name="platform">
|
|
Platform.
|
|
</param>
|
|
<param name="exe">
|
|
Executable path.
|
|
</param>
|
|
<param name="args">
|
|
Executable arguments.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.RageConversionTool.#ctor(RSG.Base.Logging.ILog,RSG.Configuration.IBranch,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.RageConversionTool"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="branch">
|
|
Branch object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.RageConversionTool.Platform">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.RageConversionTool.Branch">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.RageConversionTool.ExecutablePath">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.RageConversionTool.Arguments">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.RageConversionTool.ParseRagebuilder(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Parse Ragebuilder data from XML.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.Runline">
|
|
<summary>
|
|
Runline implementation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Runline.#ctor(RSG.Configuration.RunlineMode,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.Runline"/> class.
|
|
</summary>
|
|
<param name="mode">
|
|
<see cref="T:RSG.Configuration.RunlineMode"/> value.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Runline.Mode">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Runline.Command">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Runline.CanFail">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Runline.RunOnce">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Runline.Always">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Runline.Users">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Runline.Version">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.Studio">
|
|
<summary>
|
|
Studio object; representing a studio option for a user in our
|
|
configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Studio.#ctor(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.Studio"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlStudioElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.Name">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.FriendlyName">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.AbbreviatedName">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.IPNetworks">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.PerforceServers">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.DefaultPerforceServer">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.PerforceAutomationDataServer">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.PerforceMocapServer">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.PerforceSwarmServer">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.PerforceSwarmAutomationDataServer">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.NetworkDrive">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.ExchangeServer">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.Domain">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.ActiveDirectoryDomain">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.BuilderUser">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.BuilderName">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.TimeZoneId">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.Icons">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.DistributedNetworkPath">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Studio.BugstarId">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Studio.GetTimeZoneInfo">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Studio.Equals(System.Object)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Studio.ToString">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Studio.GetHashCode">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Studio.ParseStudioElement(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Parse studio attributes from an XElement.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlStudioElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Studio.ParseSubnetMasks(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Parses the subnet masks data from an XElement.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<returns>
|
|
Collection of <see cref="T:RSG.Base.Net.IPNetwork"/> objects.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Studio.ParsePerforceServers(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Parses the studio perforce server data from an XElement.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<returns>
|
|
Dictionary of <see cref="T:RSG.Configuration.Implementation.StudioPerforceServer"/> organised by <see cref="T:RSG.Configuration.StudioServerType"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Implementation.Target">
|
|
<summary>
|
|
Target abstraction; representing a target platform defining the
|
|
architecture and build directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Target.XmlAttrPlatform">
|
|
<summary>
|
|
XML attribute name for getting platform name.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Target.XmlAttrEnabled">
|
|
<summary>
|
|
XML attribute name for getting whether target is enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Target._nonFinalResourcePath">
|
|
<summary>
|
|
Private field used for the <see cref="P:RSG.Configuration.Implementation.Target.NonFinalResourcePath"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Target._resourcePath">
|
|
<summary>
|
|
Private field used for the <see cref="P:RSG.Configuration.Implementation.Target.ResourcePath"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Target._shaderPath">
|
|
<summary>
|
|
Private field used for the <see cref="P:RSG.Configuration.Implementation.Target.ShaderPath"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Target._shaderExtension">
|
|
<summary>
|
|
Private field used for the <see cref="P:RSG.Configuration.Implementation.Target.ShaderExtension"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Implementation.Target._isEnabled">
|
|
<summary>
|
|
Private field used for the <see cref="P:RSG.Configuration.Implementation.Target.Enabled"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Target.#ctor(RSG.Base.Logging.ILog,RSG.Configuration.IBranch,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Implementation.Target"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="branch">
|
|
Parent branch object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Target.Branch">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Target.NonFinalResourcePath">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Target.Platform">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Target.ResourcePath">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Target.ShaderPath">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Target.ShaderExtension">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Target.Enabled">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Implementation.Target.Environment">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Target.Import(RSG.Base.IEnvironment)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Target.GetRagebuilderExecutable">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Target.GetRagebuilderConvertXGEArguments">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Target.GetRagebuilderConvertXGEScript">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Target.GetRagebuilderScriptDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Target.GetRagebuilderConvertLocalArguments">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Target.CreatePathCache">
|
|
<summary>
|
|
Method to populate all of the paths by calling <see cref="M:RSG.Configuration.Implementation.ConfigBaseWithPathCache.AddPathToCache(System.String)"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Target.ParseTarget(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Parse a target data element.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Target.ParseTargetAttributes(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Parse a target attributes data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Target.ParseDirectories(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Parse a targets directory data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Implementation.Target.GetRagebuilderArguments(System.Boolean)">
|
|
<summary>
|
|
Return Ragebuilder argument string.
|
|
</summary>
|
|
<param name="isLocal">
|
|
Value indicating whether the process is executing locally.
|
|
</param>
|
|
<returns>
|
|
Arguments string.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IStudioPerforceServer">
|
|
<summary>
|
|
Represents a Studio Perforce Server and its related swarm server (if any).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudioPerforceServer.ServerType">
|
|
<summary>
|
|
Gets the swarm server associated with this perforce server.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudioPerforceServer.Alias">
|
|
<summary>
|
|
Gets the alias name used for this perforce server.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudioPerforceServer.Server">
|
|
<summary>
|
|
Gets the server and port for the perforce server.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudioPerforceServer.SwarmServer">
|
|
<summary>
|
|
Gets the swarm server associated with this perforce server.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.LogUtilities">
|
|
<summary>
|
|
Utilities class for logging.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.LogUtilities.ContextStringFormat">
|
|
<summary>
|
|
String format for logging a Context to show in the standalone Ulog Viewer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.LogUtilities.OpenLog(System.String,RSG.Configuration.IConfigProvider)">
|
|
<summary>
|
|
Attempts to find <see cref="F:RSG.Configuration.RockstarApplication.UniversalLogViewer"/> and use it to open a log.
|
|
</summary>
|
|
<param name="filepath">Path the log file.</param>
|
|
<param name="cfgProvider">Configuration provider.</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.StudioServerType">
|
|
<summary>
|
|
Type of studio server.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.StudioServerType.StudioPerforceServer">
|
|
<summary>
|
|
Default perforce server for studio.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.StudioServerType.StudioAutomationDataServer">
|
|
<summary>
|
|
Automation data server for studio.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.StudioServerType.StudioMocapServer">
|
|
<summary>
|
|
Mocap server for studio.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Installer.IWriteableToolsVersion">
|
|
<summary>
|
|
Writeable version of <see cref="T:RSG.Configuration.IToolsVersion"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IWriteableToolsVersion.ExpectedToolsVersion">
|
|
<summary>
|
|
Gets or sets the <see cref="T:RSG.Configuration.IVersion"/> of the tools the user has locally. This can
|
|
be inaccurate and if absolute accuracy is required you must hit our Deployment
|
|
Service instead.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IWriteableToolsVersion.ExpectedGameVersion">
|
|
<summary>
|
|
Gets or sets the <see cref="T:RSG.Configuration.IVersion"/> of the game the user is expected to have locally.
|
|
This can be inaccurate and if absolute accuracy is required you must hit our
|
|
Deployment Service instead.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Installer.IWriteableToolsVersion.SetExpectedGameVersion(System.String)">
|
|
<summary>
|
|
Sets <see cref="P:RSG.Configuration.Installer.IWriteableToolsVersion.ExpectedGameVersion"/> to a new label.
|
|
</summary>
|
|
<param name="label">
|
|
Version string.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Installer.IWriteableToolsVersion.SetExpectedToolsVersion(System.String)">
|
|
<summary>
|
|
Sets <see cref="P:RSG.Configuration.Installer.IWriteableToolsVersion.ExpectedToolsVersion"/> to a new label.
|
|
</summary>
|
|
<param name="label">
|
|
Version string.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Installer.IWriteableToolsVersion.Save(RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Saves new versions to file and reloads this config.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Installer.IWritableConfig">
|
|
<summary>
|
|
Writable Configuration class for system-wide globals for current tools
|
|
branch. ONLY USED BY THE INSTALLER.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IWritableConfig.InstallTime">
|
|
<summary>
|
|
Gets or sets the last install time.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IWritableConfig.Username">
|
|
<summary>
|
|
Gets or sets the local user's username.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IWritableConfig.HostName">
|
|
<summary>
|
|
Gets or sets the host name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IWritableConfig.EmailAddress">
|
|
<summary>
|
|
Gets or sets the local user's email address.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IWritableConfig.IsAutomationMachine">
|
|
<summary>
|
|
Gets or sets a value indicating whether the local machine is an automation machine.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IWritableConfig.VersionControlEnabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether version control is enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IWritableConfig.AlwaysUpdateFileAssociations">
|
|
<summary>
|
|
Gets or sets a value indicating whether the file associations should be updated during install.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IWritableConfig.WriteableVersion">
|
|
<summary>
|
|
Gets the writable version of <see cref="T:RSG.Configuration.IToolsVersion"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IWritableConfig.AutodeskMaxInstallationSelection">
|
|
<summary>
|
|
Gets or sets the autodesk installation selection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Installer.IWritableConfig.SaveLocal">
|
|
<summary>
|
|
Save local settings.
|
|
</summary>
|
|
<returns>
|
|
true on success; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Installer.IWritableConfig.SetVersionControlSettings(System.String,System.String,System.String)">
|
|
<summary>
|
|
Sets the version control settings.
|
|
</summary>
|
|
<param name="server">
|
|
Version control server host.
|
|
</param>
|
|
<param name="username">
|
|
Version control username.
|
|
</param>
|
|
<param name="workspace">
|
|
Version control workspace.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Installer.IWritableProject">
|
|
<summary>
|
|
Writable Project interface. ONLY USED BY THE INSTALLER.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IWritableProject.DefaultBranchName">
|
|
<summary>
|
|
Gets or sets the locally configured default branch name for this project.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Installer.IWritableProject.SaveLocal">
|
|
<summary>
|
|
Save local settings.
|
|
</summary>
|
|
<returns>
|
|
true if successful; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Installer.ApplicationInstall">
|
|
<summary>
|
|
Implementation of the <see cref="T:RSG.Configuration.Installer.IApplicationInstall"/> interface.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Installer.ApplicationInstall.#ctor(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Installer.ApplicationInstall"/> class.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.ApplicationInstall.Name">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.ApplicationInstall.Versions">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Installer.IApplicationInstall">
|
|
<summary>
|
|
Interface defining applications that can install at the end of the tools installer
|
|
process.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IApplicationInstall.Name">
|
|
<summary>
|
|
Gets the application name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IApplicationInstall.Versions">
|
|
<summary>
|
|
Gets the version setup for project (used by installer).
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Installer.IInstallerConfig">
|
|
<summary>
|
|
Installer configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IInstallerConfig.Filename">
|
|
<summary>
|
|
Gets the filename installer config has loaded.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IInstallerConfig.Installs">
|
|
<summary>
|
|
Gets the applications to install information.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.IInstallerConfig.Runlines">
|
|
<summary>
|
|
Gets the installer runlines.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Installer.InstallerConfig">
|
|
<summary>
|
|
Installer configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Installer.InstallerConfig.#ctor(RSG.Configuration.IProject)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Installer.InstallerConfig"/> class.
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.InstallerConfig.Filename">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.InstallerConfig.Installs">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Installer.InstallerConfig.Runlines">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Installer.InstallerConfig.Parse(System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
Parse the <see cref="T:System.Xml.Linq.XDocument"/>.
|
|
</summary>
|
|
<param name="doc">
|
|
Document to parse.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IProjectSummaryContentPack">
|
|
<summary>
|
|
Project Content-Pack (DLC) summary interface; for reading summary information
|
|
about available content packages.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProjectSummaryContentPack.ContentPackType">
|
|
<summary>
|
|
Gets the <see cref="P:RSG.Configuration.IProjectSummaryContentPack.ContentPackType"/> for this content-pack.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProjectSummaryContentPack.ContentPackFlags">
|
|
<summary>
|
|
Gets the <see cref="P:RSG.Configuration.IProjectSummaryContentPack.ContentPackFlags"/> for this content-pack.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProjectSummaryContentPack.PreviousContentPack">
|
|
<summary>
|
|
Gets the previous <see cref="T:RSG.Configuration.IProjectDLC"/> for this content-pack; which
|
|
represents the previous shipped content-pack. This sets up the chain of
|
|
<see cref="T:RSG.Configuration.IProjectDLC"/> packs so we can reference content previously
|
|
shipped (e.g. props).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProjectSummaryContentPack.BaseContentPack">
|
|
<summary>
|
|
Gets the base <see cref="T:RSG.Configuration.IProjectDLC"/> for this optional content-pack; which
|
|
represents the base pack upon which this one is built. If this <see cref="P:RSG.Configuration.IProjectSummaryContentPack.ContentPackType"/>
|
|
is not an <see cref="F:RSG.Configuration.ContentPackType.OptionalDataPack"/>, this value will be null.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.ISparseTarget">
|
|
<summary>
|
|
Interface that defines a Sparse Target for data builds.
|
|
</summary>
|
|
<remarks>
|
|
See https://hub.rockstargames.com/display/RSGTOOLS/Asset+Pipeline+Spec+-+Sparse+Target+Data.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ISparseTarget.BaseTarget">
|
|
<summary>
|
|
Gets the associated base <see cref="T:RSG.Configuration.ITarget"/> platform for data builds.
|
|
</summary>
|
|
<see cref="T:RSG.Configuration.ITarget"/>
|
|
<remarks>
|
|
See https://hub.rockstargames.com/display/RSGTOOLS/Asset+Pipeline+Spec+-+Sparse+Target+Data.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ISparseTarget.ResourceCompilersUseBaseTarget">
|
|
<summary>
|
|
Gets a value indicating whether to use the Base Target for Resource Compilers.
|
|
</summary>
|
|
<remarks>
|
|
This allows us to abstract base platforms as sparse targets should produce
|
|
the same data as their base target.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IToolsConfig">
|
|
<summary>
|
|
Interface that defines our core tools configuration variables.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsConfig.ToolsRootDirectory">
|
|
<summary>
|
|
Gets the absolute root path to tools distribution branch
|
|
(i.e. RS_TOOLSROOT).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsConfig.ToolsAutomationDirectory">
|
|
<summary>
|
|
Gets the absolute root path to tools automation directory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsConfig.ToolsBinDirectory">
|
|
<summary>
|
|
Gets the tools binary directory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsConfig.ToolsConfigDirectory">
|
|
<summary>
|
|
Gets the tools configuration data absolute path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsConfig.ToolsLogsDirectory">
|
|
<summary>
|
|
Gets the tools log file directory absolute path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsConfig.ToolsTempDirectory">
|
|
<summary>
|
|
Gets the tools temporary files absolute path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsConfig.ToolsLibDirectory">
|
|
<summary>
|
|
Gets the tools lib directory absolute path.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IToolsVersion">
|
|
<summary>
|
|
Tools version interface; the main components within this interface are the two
|
|
properties for expected local versions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsVersion.ExpectedToolsVersion">
|
|
<summary>
|
|
Gets the <see cref="T:RSG.Configuration.IVersion"/> of the tools the user has locally. This can
|
|
be inaccurate and if absolute accuracy is required you must hit our Deployment
|
|
Service instead.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsVersion.ExpectedGameVersion">
|
|
<summary>
|
|
Gets the <see cref="T:RSG.Configuration.IVersion"/> of the game the user is expected to have locally.
|
|
This can be inaccurate and if absolute accuracy is required you must hit our
|
|
Deployment Service instead.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IToolsVersion.Reload(RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Reloads the data from file.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.LabelUtil">
|
|
<summary>
|
|
Label enumeration helper methods.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.LabelUtil.LabelFromConfigurationString(System.String)">
|
|
<summary>
|
|
Returns a label value from a String representation.
|
|
</summary>
|
|
<param name="label">Label string.</param>
|
|
<returns>
|
|
Label value.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.LabelUtil.GenerateLabel(RSG.Configuration.Label,RSG.Configuration.IProject,RSG.Base.IEnvironment)">
|
|
<summary>
|
|
Generates a label name for game builds based on a specialized tokens.
|
|
</summary>
|
|
<param name="labelType">
|
|
Label type.
|
|
</param>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="env">
|
|
Environment.
|
|
</param>
|
|
<returns>
|
|
Label name.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.LabelUtil.GenerateWorkspace(RSG.Configuration.Label,RSG.Configuration.IProject,RSG.Base.IEnvironment)">
|
|
<summary>
|
|
Generates a workspace name for game builds based on a specialized tokens.
|
|
</summary>
|
|
<param name="labelType">
|
|
Label type.
|
|
</param>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="env">
|
|
Environment.
|
|
</param>
|
|
<returns>
|
|
Workspace name.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.LabelUtil.CreateLabelEnvironment(RSG.Configuration.ICanImportEnvironment,System.Int32,System.Int32)">
|
|
<summary>
|
|
Creates an environment for creating a label based on the branch.
|
|
</summary>
|
|
<param name="branch">
|
|
Branch.
|
|
</param>
|
|
<param name="majorVersion">
|
|
Major version.
|
|
</param>
|
|
<param name="minorVersion">
|
|
Minor version.
|
|
</param>
|
|
<returns>
|
|
A new <see cref="T:RSG.Base.IEnvironment"/> object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.LabelUtil.GetLabelName(RSG.Configuration.Label,System.Int32,System.Int32,RSG.Configuration.ICanImportEnvironment,RSG.Configuration.IProject,System.String)">
|
|
<summary>
|
|
Generates a label name.
|
|
</summary>
|
|
<param name="type">
|
|
Label type.
|
|
</param>
|
|
<param name="majorVersion">
|
|
Major version.
|
|
</param>
|
|
<param name="minorVersion">
|
|
Minor version.
|
|
</param>
|
|
<param name="branch">
|
|
Branch.
|
|
</param>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="prefix">
|
|
Prefix.
|
|
</param>
|
|
<returns>
|
|
Workspace name.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.LabelUtil.GetWorkspaceName(RSG.Configuration.Label,System.Int32,System.Int32,RSG.Configuration.ICanImportEnvironment,RSG.Configuration.IProject,System.String)">
|
|
<summary>
|
|
Generates a workspace name.
|
|
</summary>
|
|
<param name="type">
|
|
Label type.
|
|
</param>
|
|
<param name="majorVersion">
|
|
Major version.
|
|
</param>
|
|
<param name="minorVersion">
|
|
Minor version.
|
|
</param>
|
|
<param name="branch">
|
|
Branch.
|
|
</param>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="prefix">
|
|
Prefix.
|
|
</param>
|
|
<returns>
|
|
Workspace name.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.LabelUtil.ApplyLabelPrefix(System.String,System.String)">
|
|
<summary>
|
|
Formats the label to also have a prefix if specified.
|
|
</summary>
|
|
<param name="label">
|
|
Label.
|
|
</param>
|
|
<param name="prefix">
|
|
Prefix.
|
|
</param>
|
|
<returns>
|
|
Prefixed label.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.MapNotFoundException">
|
|
<summary>
|
|
Exception raised under circumstances when a map is not found for
|
|
a particular query.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.MapNotFoundException.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.MapNotFoundException"/> class.
|
|
</summary>
|
|
<param name="mapName">
|
|
Name of the map that wasn't found.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.LevelNotUniqueException">
|
|
<summary>
|
|
Exception raised under circumstances where a unique level was expected
|
|
but not found.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.LevelNotUniqueException.#ctor(System.Int32)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.LevelNotUniqueException"/> class.
|
|
</summary>
|
|
<param name="levelCount">
|
|
Number of levels.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.LevelNotUniqueException.#ctor(System.Int32,System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.LevelNotUniqueException"/> class.
|
|
</summary>
|
|
<param name="levelCount">
|
|
Number of levels.
|
|
</param>
|
|
<param name="inner">
|
|
Inner exception.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.LevelNotUniqueException.LevelCount">
|
|
<summary>
|
|
Gets the number of levels found (should be 0, or > 1).
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IgnoredConnectionSources.IIgnoredConnectionSourcesConfig">
|
|
<summary>
|
|
Rag configuration interface.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IgnoredConnectionSources.IIgnoredConnectionSourcesConfig.ShouldIgnoreConnectionsFrom(System.Net.IPAddress)">
|
|
<summary>
|
|
Returns a value indicating whether we should ignore connections from the
|
|
specified IP address.
|
|
</summary>
|
|
<param name="address">
|
|
The address to check whether we should ignore.
|
|
</param>
|
|
<returns>
|
|
<c>True</c> if the address should be ignored; otherwise, <c>False</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IgnoredConnectionSources.IgnoredConnectionSourcesConfig">
|
|
<summary>
|
|
Ignored connection sources configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.IgnoredConnectionSources.IgnoredConnectionSourcesConfig._ignoredConnectionSources">
|
|
<summary>
|
|
The list of ip addresses from which we should always ignore new game connections.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IgnoredConnectionSources.IgnoredConnectionSourcesConfig.#ctor(System.Collections.Generic.IDictionary{System.String,System.Net.IPAddress})">
|
|
<summary>
|
|
Creates a new instance of the <see cref="T:RSG.Configuration.IgnoredConnectionSources.IgnoredConnectionSourcesConfig"/> class
|
|
</summary>
|
|
<param name="ignoredConnectionSources">
|
|
The list of connection sources to ignore.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IgnoredConnectionSources.IgnoredConnectionSourcesConfig.ShouldIgnoreConnectionsFrom(System.Net.IPAddress)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig._branchName">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.BranchName"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig._arguments">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Arguments"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig" /> by setting the fields in the constructor
|
|
</summary>
|
|
<summary>
|
|
Sets the value of the class
|
|
</summary>
|
|
<param name="branchNameParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.BranchName"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig"/>.
|
|
</param>
|
|
<param name="argumentsParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Arguments"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.#ctor(RSG.Configuration.Metadata.Automation.AutomationConsoleConfig)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.#ctor(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Constructor from XElement.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
XElement that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.#ctor(System.Xml.Linq.XElement,System.Boolean)">
|
|
<summary>
|
|
constructor which load from xmlElement and take in account the inheritance.Do not use yourself it's reserved for deserialization purpose
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.BranchNameDefault">
|
|
<summary>
|
|
Return the Default value of BranchNameDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.ArgumentsDefault">
|
|
<summary>
|
|
Return the Default value of ArgumentsDefault
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Reset">
|
|
<summary>
|
|
Reset the structure to it's Default Values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Set(System.String,System.String)">
|
|
<summary>
|
|
Sets the value of the class
|
|
</summary>
|
|
<param name="branchNameParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.BranchName"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig"/>.
|
|
</param>
|
|
<param name="argumentsParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Arguments"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.GetName">
|
|
<summary>
|
|
Get the name of the class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.GetInstanceName">
|
|
<summary>
|
|
Get the parcodegen name of the instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Clone">
|
|
<summary>
|
|
Creates a new instance that is a copy of this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.CloneMembers(System.Object)">
|
|
<summary>
|
|
Copies member values from other instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Copy(System.Object)">
|
|
<summary>
|
|
Copies member values from other instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.CopyFromObject(System.Object)">
|
|
<summary>
|
|
Copies member values from an object inheriting from RSG.Configuration.Metadata.Automation.AutomationConsoleConfig
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Reset(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Reset the structure to it's Default Values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Load(System.String,RSG.Configuration.Metadata.Automation.AutomationConsoleConfig@)">
|
|
<summary>
|
|
Creates a new AutomationConsoleConfig instance from a file.
|
|
</summary>
|
|
<param name="filename">
|
|
A URI string that references the file to load.
|
|
</param>
|
|
<param name="objectLoaded">
|
|
the object loaded.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Load(System.IO.Stream,RSG.Configuration.Metadata.Automation.AutomationConsoleConfig@)">
|
|
<summary>
|
|
Creates a new AutomationConsoleConfig instance from a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream that contains the parCodeGen data.
|
|
</param>
|
|
<param name="objectLoaded">
|
|
the object loaded.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Load(System.String)">
|
|
<summary>
|
|
Creates a new AutomationConsoleConfig instance from a file.
|
|
</summary>
|
|
<param name="filename">
|
|
A URI string that references the file to load.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Load(System.IO.Stream)">
|
|
<summary>
|
|
Creates a new AutomationConsoleConfig instance from a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream that contains the parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Save(System.String)">
|
|
<summary>
|
|
Serialise this instance to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Save(System.IO.Stream)">
|
|
<summary>
|
|
Serialise this instance to a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
Stream that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Deserialise the XElement into this object.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
XElement to deserialise.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Serialise(System.String)">
|
|
<summary>
|
|
Serialise this instance to an XElement.
|
|
</summary>
|
|
<param name="name">
|
|
Top-level XElement name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.SerialiseWithoutDefault(System.String)">
|
|
<summary>
|
|
Serialise this instance to an XElement.
|
|
</summary>
|
|
<param name="name">
|
|
Top-level XElement name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.SaveWithoutDefault(System.String)">
|
|
<summary>
|
|
Serialise this instance to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.SaveWithoutDefault(System.IO.Stream)">
|
|
<summary>
|
|
Serialise this instance to a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
Stream that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.SystemStringDeepComparer(System.String,System.String)">
|
|
<summary>
|
|
Check if two BranchName are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.MemberEquals(System.Object)">
|
|
<summary>
|
|
Check if all members are equals to the members of the object provided
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.GetHashCode">
|
|
<summary>
|
|
Return the hashcode of the instance
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationConsoleConfig.Equals(System.Object)">
|
|
<summary>
|
|
Return the hashcode of the instance
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild._webAlias">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.WebAlias"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild._warnLimitMinutes">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.WarnLimitMinutes"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild._criticalLimitMinutes">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.CriticalLimitMinutes"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.#ctor(System.String,System.Int32,System.Int32)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild" /> by setting the fields in the constructor
|
|
</summary>
|
|
<summary>
|
|
Sets the value of the class
|
|
</summary>
|
|
<param name="webAliasParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.WebAlias"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild"/>.
|
|
</param>
|
|
<param name="warnLimitMinutesParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.WarnLimitMinutes"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild"/>.
|
|
</param>
|
|
<param name="criticalLimitMinutesParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.CriticalLimitMinutes"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.#ctor(RSG.Configuration.Metadata.Automation.AutomationDependencyBuild)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.#ctor(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Constructor from XElement.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
XElement that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.#ctor(System.Xml.Linq.XElement,System.Boolean)">
|
|
<summary>
|
|
constructor which load from xmlElement and take in account the inheritance.Do not use yourself it's reserved for deserialization purpose
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.WarnLimitMinutesMinimum">
|
|
<summary>
|
|
Return the minimum value of WarnLimitMinutes
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.WarnLimitMinutesMaximum">
|
|
<summary>
|
|
Return the maximum value of WarnLimitMinutes
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.CriticalLimitMinutesMinimum">
|
|
<summary>
|
|
Return the minimum value of CriticalLimitMinutes
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.CriticalLimitMinutesMaximum">
|
|
<summary>
|
|
Return the maximum value of CriticalLimitMinutes
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.WebAliasDefault">
|
|
<summary>
|
|
Return the Default value of WebAliasDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.WarnLimitMinutesDefault">
|
|
<summary>
|
|
Return the Default value of WarnLimitMinutesDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.CriticalLimitMinutesDefault">
|
|
<summary>
|
|
Return the Default value of CriticalLimitMinutesDefault
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.Reset">
|
|
<summary>
|
|
Reset the structure to it's Default Values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.Set(System.String,System.Int32,System.Int32)">
|
|
<summary>
|
|
Sets the value of the class
|
|
</summary>
|
|
<param name="webAliasParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.WebAlias"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild"/>.
|
|
</param>
|
|
<param name="warnLimitMinutesParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.WarnLimitMinutes"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild"/>.
|
|
</param>
|
|
<param name="criticalLimitMinutesParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.CriticalLimitMinutes"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.GetName">
|
|
<summary>
|
|
Get the name of the class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.GetInstanceName">
|
|
<summary>
|
|
Get the parcodegen name of the instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.Clone">
|
|
<summary>
|
|
Creates a new instance that is a copy of this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.CloneMembers(System.Object)">
|
|
<summary>
|
|
Copies member values from other instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.Copy(System.Object)">
|
|
<summary>
|
|
Copies member values from other instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.CopyFromObject(System.Object)">
|
|
<summary>
|
|
Copies member values from an object inheriting from RSG.Configuration.Metadata.Automation.AutomationDependencyBuild
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.Reset(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Reset the structure to it's Default Values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.Load(System.String,RSG.Configuration.Metadata.Automation.AutomationDependencyBuild@)">
|
|
<summary>
|
|
Creates a new AutomationDependencyBuild instance from a file.
|
|
</summary>
|
|
<param name="filename">
|
|
A URI string that references the file to load.
|
|
</param>
|
|
<param name="objectLoaded">
|
|
the object loaded.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.Load(System.IO.Stream,RSG.Configuration.Metadata.Automation.AutomationDependencyBuild@)">
|
|
<summary>
|
|
Creates a new AutomationDependencyBuild instance from a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream that contains the parCodeGen data.
|
|
</param>
|
|
<param name="objectLoaded">
|
|
the object loaded.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.Load(System.String)">
|
|
<summary>
|
|
Creates a new AutomationDependencyBuild instance from a file.
|
|
</summary>
|
|
<param name="filename">
|
|
A URI string that references the file to load.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.Load(System.IO.Stream)">
|
|
<summary>
|
|
Creates a new AutomationDependencyBuild instance from a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream that contains the parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.Save(System.String)">
|
|
<summary>
|
|
Serialise this instance to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.Save(System.IO.Stream)">
|
|
<summary>
|
|
Serialise this instance to a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
Stream that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Deserialise the XElement into this object.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
XElement to deserialise.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.Serialise(System.String)">
|
|
<summary>
|
|
Serialise this instance to an XElement.
|
|
</summary>
|
|
<param name="name">
|
|
Top-level XElement name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.SerialiseWithoutDefault(System.String)">
|
|
<summary>
|
|
Serialise this instance to an XElement.
|
|
</summary>
|
|
<param name="name">
|
|
Top-level XElement name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.SaveWithoutDefault(System.String)">
|
|
<summary>
|
|
Serialise this instance to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.SaveWithoutDefault(System.IO.Stream)">
|
|
<summary>
|
|
Serialise this instance to a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
Stream that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.SystemStringDeepComparer(System.String,System.String)">
|
|
<summary>
|
|
Check if two WebAlias are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.SystemInt32DeepComparer(System.Int32,System.Int32)">
|
|
<summary>
|
|
Check if two WarnLimitMinutes are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.MemberEquals(System.Object)">
|
|
<summary>
|
|
Check if all members are equals to the members of the object provided
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.GetHashCode">
|
|
<summary>
|
|
Return the hashcode of the instance
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDependencyBuild.Equals(System.Object)">
|
|
<summary>
|
|
Return the hashcode of the instance
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent._eventName">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.EventName"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent._limit">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Limit"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.#ctor(System.String,System.Int32)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent" /> by setting the fields in the constructor
|
|
</summary>
|
|
<summary>
|
|
Sets the value of the class
|
|
</summary>
|
|
<param name="eventNameParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.EventName"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent"/>.
|
|
</param>
|
|
<param name="limitParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Limit"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.#ctor(RSG.Configuration.Metadata.Automation.AutomationDisplayEvent)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.#ctor(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Constructor from XElement.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
XElement that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.#ctor(System.Xml.Linq.XElement,System.Boolean)">
|
|
<summary>
|
|
constructor which load from xmlElement and take in account the inheritance.Do not use yourself it's reserved for deserialization purpose
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.LimitMinimum">
|
|
<summary>
|
|
Return the minimum value of Limit
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.LimitMaximum">
|
|
<summary>
|
|
Return the maximum value of Limit
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.EventNameDefault">
|
|
<summary>
|
|
Return the Default value of EventNameDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.LimitDefault">
|
|
<summary>
|
|
Return the Default value of LimitDefault
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Reset">
|
|
<summary>
|
|
Reset the structure to it's Default Values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Set(System.String,System.Int32)">
|
|
<summary>
|
|
Sets the value of the class
|
|
</summary>
|
|
<param name="eventNameParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.EventName"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent"/>.
|
|
</param>
|
|
<param name="limitParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Limit"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.GetName">
|
|
<summary>
|
|
Get the name of the class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.GetInstanceName">
|
|
<summary>
|
|
Get the parcodegen name of the instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Clone">
|
|
<summary>
|
|
Creates a new instance that is a copy of this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.CloneMembers(System.Object)">
|
|
<summary>
|
|
Copies member values from other instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Copy(System.Object)">
|
|
<summary>
|
|
Copies member values from other instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.CopyFromObject(System.Object)">
|
|
<summary>
|
|
Copies member values from an object inheriting from RSG.Configuration.Metadata.Automation.AutomationDisplayEvent
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Reset(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Reset the structure to it's Default Values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Load(System.String,RSG.Configuration.Metadata.Automation.AutomationDisplayEvent@)">
|
|
<summary>
|
|
Creates a new AutomationDisplayEvent instance from a file.
|
|
</summary>
|
|
<param name="filename">
|
|
A URI string that references the file to load.
|
|
</param>
|
|
<param name="objectLoaded">
|
|
the object loaded.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Load(System.IO.Stream,RSG.Configuration.Metadata.Automation.AutomationDisplayEvent@)">
|
|
<summary>
|
|
Creates a new AutomationDisplayEvent instance from a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream that contains the parCodeGen data.
|
|
</param>
|
|
<param name="objectLoaded">
|
|
the object loaded.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Load(System.String)">
|
|
<summary>
|
|
Creates a new AutomationDisplayEvent instance from a file.
|
|
</summary>
|
|
<param name="filename">
|
|
A URI string that references the file to load.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Load(System.IO.Stream)">
|
|
<summary>
|
|
Creates a new AutomationDisplayEvent instance from a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream that contains the parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Save(System.String)">
|
|
<summary>
|
|
Serialise this instance to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Save(System.IO.Stream)">
|
|
<summary>
|
|
Serialise this instance to a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
Stream that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Deserialise the XElement into this object.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
XElement to deserialise.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Serialise(System.String)">
|
|
<summary>
|
|
Serialise this instance to an XElement.
|
|
</summary>
|
|
<param name="name">
|
|
Top-level XElement name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.SerialiseWithoutDefault(System.String)">
|
|
<summary>
|
|
Serialise this instance to an XElement.
|
|
</summary>
|
|
<param name="name">
|
|
Top-level XElement name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.SaveWithoutDefault(System.String)">
|
|
<summary>
|
|
Serialise this instance to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.SaveWithoutDefault(System.IO.Stream)">
|
|
<summary>
|
|
Serialise this instance to a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
Stream that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.SystemStringDeepComparer(System.String,System.String)">
|
|
<summary>
|
|
Check if two EventName are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.SystemInt32DeepComparer(System.Int32,System.Int32)">
|
|
<summary>
|
|
Check if two Limit are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.MemberEquals(System.Object)">
|
|
<summary>
|
|
Check if all members are equals to the members of the object provided
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.GetHashCode">
|
|
<summary>
|
|
Return the hashcode of the instance
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDisplayEvent.Equals(System.Object)">
|
|
<summary>
|
|
Return the hashcode of the instance
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationDownloadOption._name">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Name"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationDownloadOption._enabled">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Enabled"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDownloadOption" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.#ctor(System.String,System.Boolean)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDownloadOption" /> by setting the fields in the constructor
|
|
</summary>
|
|
<summary>
|
|
Sets the value of the class
|
|
</summary>
|
|
<param name="nameParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Name"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDownloadOption"/>.
|
|
</param>
|
|
<param name="enabledParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Enabled"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDownloadOption"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.#ctor(RSG.Configuration.Metadata.Automation.AutomationDownloadOption)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDownloadOption" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.#ctor(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Constructor from XElement.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
XElement that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.#ctor(System.Xml.Linq.XElement,System.Boolean)">
|
|
<summary>
|
|
constructor which load from xmlElement and take in account the inheritance.Do not use yourself it's reserved for deserialization purpose
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.NameDefault">
|
|
<summary>
|
|
Return the Default value of NameDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.EnabledDefault">
|
|
<summary>
|
|
Return the Default value of EnabledDefault
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Reset">
|
|
<summary>
|
|
Reset the structure to it's Default Values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Set(System.String,System.Boolean)">
|
|
<summary>
|
|
Sets the value of the class
|
|
</summary>
|
|
<param name="nameParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Name"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDownloadOption"/>.
|
|
</param>
|
|
<param name="enabledParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Enabled"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationDownloadOption"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.GetName">
|
|
<summary>
|
|
Get the name of the class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.GetInstanceName">
|
|
<summary>
|
|
Get the parcodegen name of the instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Clone">
|
|
<summary>
|
|
Creates a new instance that is a copy of this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.CloneMembers(System.Object)">
|
|
<summary>
|
|
Copies member values from other instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Copy(System.Object)">
|
|
<summary>
|
|
Copies member values from other instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.CopyFromObject(System.Object)">
|
|
<summary>
|
|
Copies member values from an object inheriting from RSG.Configuration.Metadata.Automation.AutomationDownloadOption
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Reset(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Reset the structure to it's Default Values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Load(System.String,RSG.Configuration.Metadata.Automation.AutomationDownloadOption@)">
|
|
<summary>
|
|
Creates a new AutomationDownloadOption instance from a file.
|
|
</summary>
|
|
<param name="filename">
|
|
A URI string that references the file to load.
|
|
</param>
|
|
<param name="objectLoaded">
|
|
the object loaded.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Load(System.IO.Stream,RSG.Configuration.Metadata.Automation.AutomationDownloadOption@)">
|
|
<summary>
|
|
Creates a new AutomationDownloadOption instance from a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream that contains the parCodeGen data.
|
|
</param>
|
|
<param name="objectLoaded">
|
|
the object loaded.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Load(System.String)">
|
|
<summary>
|
|
Creates a new AutomationDownloadOption instance from a file.
|
|
</summary>
|
|
<param name="filename">
|
|
A URI string that references the file to load.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Load(System.IO.Stream)">
|
|
<summary>
|
|
Creates a new AutomationDownloadOption instance from a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream that contains the parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Save(System.String)">
|
|
<summary>
|
|
Serialise this instance to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Save(System.IO.Stream)">
|
|
<summary>
|
|
Serialise this instance to a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
Stream that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Deserialise the XElement into this object.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
XElement to deserialise.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Serialise(System.String)">
|
|
<summary>
|
|
Serialise this instance to an XElement.
|
|
</summary>
|
|
<param name="name">
|
|
Top-level XElement name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.SerialiseWithoutDefault(System.String)">
|
|
<summary>
|
|
Serialise this instance to an XElement.
|
|
</summary>
|
|
<param name="name">
|
|
Top-level XElement name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.SaveWithoutDefault(System.String)">
|
|
<summary>
|
|
Serialise this instance to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.SaveWithoutDefault(System.IO.Stream)">
|
|
<summary>
|
|
Serialise this instance to a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
Stream that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.SystemStringDeepComparer(System.String,System.String)">
|
|
<summary>
|
|
Check if two Name are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.SystemBooleanDeepComparer(System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Check if two Enabled are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.MemberEquals(System.Object)">
|
|
<summary>
|
|
Check if all members are equals to the members of the object provided
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.GetHashCode">
|
|
<summary>
|
|
Return the hashcode of the instance
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationDownloadOption.Equals(System.Object)">
|
|
<summary>
|
|
Return the hashcode of the instance
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationServiceConfig._serviceType">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.ServiceType"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationServiceConfig._studio">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Studio"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationServiceConfig._friendlyName">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.FriendlyName"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationServiceConfig._serverHost">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.ServerHost"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationServiceConfig._automationClientConfig">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.AutomationClientConfig"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationServiceConfig._visible">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Visible"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationServiceConfig._dBPollingDisabled">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.DBPollingDisabled"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationServiceConfig._console">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Console"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationServiceConfig._views">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Views"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationServiceConfig._tasks">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Tasks"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationServiceConfig._downloadOptions">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.DownloadOptions"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.#ctor(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Boolean,RSG.Configuration.Metadata.Automation.AutomationConsoleConfig,System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationViewConfig},System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationTaskId},System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationDownloadOption})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig" /> by setting the fields in the constructor
|
|
</summary>
|
|
<summary>
|
|
Sets the value of the class
|
|
</summary>
|
|
<param name="serviceTypeParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.ServiceType"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="studioParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Studio"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="friendlyNameParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.FriendlyName"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="serverHostParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.ServerHost"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="automationClientConfigParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.AutomationClientConfig"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="visibleParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Visible"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="dBPollingDisabledParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.DBPollingDisabled"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="consoleParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Console"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="viewsParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Views"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="tasksParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Tasks"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="downloadOptionsParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.DownloadOptions"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.#ctor(RSG.Configuration.Metadata.Automation.AutomationServiceConfig)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.#ctor(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Constructor from XElement.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
XElement that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.#ctor(System.Xml.Linq.XElement,System.Boolean)">
|
|
<summary>
|
|
constructor which load from xmlElement and take in account the inheritance.Do not use yourself it's reserved for deserialization purpose
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.ServiceTypeDefault">
|
|
<summary>
|
|
Return the Default value of ServiceTypeDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.StudioDefault">
|
|
<summary>
|
|
Return the Default value of StudioDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.FriendlyNameDefault">
|
|
<summary>
|
|
Return the Default value of FriendlyNameDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.ServerHostDefault">
|
|
<summary>
|
|
Return the Default value of ServerHostDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.AutomationClientConfigDefault">
|
|
<summary>
|
|
Return the Default value of AutomationClientConfigDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.VisibleDefault">
|
|
<summary>
|
|
Return the Default value of VisibleDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.DBPollingDisabledDefault">
|
|
<summary>
|
|
Return the Default value of DBPollingDisabledDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.ConsoleDefault">
|
|
<summary>
|
|
Return the Default value of ConsoleDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.ViewsDefault">
|
|
<summary>
|
|
Return the Default value of ViewsDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.TasksDefault">
|
|
<summary>
|
|
Return the Default value of TasksDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.DownloadOptionsDefault">
|
|
<summary>
|
|
Return the Default value of DownloadOptionsDefault
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Reset">
|
|
<summary>
|
|
Reset the structure to it's Default Values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Set(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Boolean,RSG.Configuration.Metadata.Automation.AutomationConsoleConfig,System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationViewConfig},System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationTaskId},System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationDownloadOption})">
|
|
<summary>
|
|
Sets the value of the class
|
|
</summary>
|
|
<param name="serviceTypeParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.ServiceType"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="studioParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Studio"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="friendlyNameParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.FriendlyName"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="serverHostParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.ServerHost"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="automationClientConfigParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.AutomationClientConfig"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="visibleParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Visible"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="dBPollingDisabledParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.DBPollingDisabled"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="consoleParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Console"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="viewsParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Views"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="tasksParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Tasks"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
<param name="downloadOptionsParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.DownloadOptions"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfig"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.GetName">
|
|
<summary>
|
|
Get the name of the class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.GetInstanceName">
|
|
<summary>
|
|
Get the parcodegen name of the instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Clone">
|
|
<summary>
|
|
Creates a new instance that is a copy of this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.CloneMembers(System.Object)">
|
|
<summary>
|
|
Copies member values from other instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Copy(System.Object)">
|
|
<summary>
|
|
Copies member values from other instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.CopyFromObject(System.Object)">
|
|
<summary>
|
|
Copies member values from an object inheriting from RSG.Configuration.Metadata.Automation.AutomationServiceConfig
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Reset(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Reset the structure to it's Default Values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Load(System.String,RSG.Configuration.Metadata.Automation.AutomationServiceConfig@)">
|
|
<summary>
|
|
Creates a new AutomationServiceConfig instance from a file.
|
|
</summary>
|
|
<param name="filename">
|
|
A URI string that references the file to load.
|
|
</param>
|
|
<param name="objectLoaded">
|
|
the object loaded.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Load(System.IO.Stream,RSG.Configuration.Metadata.Automation.AutomationServiceConfig@)">
|
|
<summary>
|
|
Creates a new AutomationServiceConfig instance from a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream that contains the parCodeGen data.
|
|
</param>
|
|
<param name="objectLoaded">
|
|
the object loaded.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Load(System.String)">
|
|
<summary>
|
|
Creates a new AutomationServiceConfig instance from a file.
|
|
</summary>
|
|
<param name="filename">
|
|
A URI string that references the file to load.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Load(System.IO.Stream)">
|
|
<summary>
|
|
Creates a new AutomationServiceConfig instance from a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream that contains the parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Save(System.String)">
|
|
<summary>
|
|
Serialise this instance to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Save(System.IO.Stream)">
|
|
<summary>
|
|
Serialise this instance to a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
Stream that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Deserialise the XElement into this object.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
XElement to deserialise.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Serialise(System.String)">
|
|
<summary>
|
|
Serialise this instance to an XElement.
|
|
</summary>
|
|
<param name="name">
|
|
Top-level XElement name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.SerialiseWithoutDefault(System.String)">
|
|
<summary>
|
|
Serialise this instance to an XElement.
|
|
</summary>
|
|
<param name="name">
|
|
Top-level XElement name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.SaveWithoutDefault(System.String)">
|
|
<summary>
|
|
Serialise this instance to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.SaveWithoutDefault(System.IO.Stream)">
|
|
<summary>
|
|
Serialise this instance to a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
Stream that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.XmlifyTypeFromCSharp(System.String)">
|
|
<summary>
|
|
Convert C# type name to C++ Initialization name
|
|
</summary>
|
|
<param name="type">
|
|
C# type to convert.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.CSharpifyTypeFromXml(System.String)">
|
|
<summary>
|
|
Convert C# type name to C++ Initialization name
|
|
</summary>
|
|
<param name="type">
|
|
C# type to convert.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.SystemStringDeepComparer(System.String,System.String)">
|
|
<summary>
|
|
Check if two ServiceType are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.SystemBooleanDeepComparer(System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Check if two Visible are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.RSGConfigurationMetadataAutomationAutomationConsoleConfigDeepComparer(RSG.Configuration.Metadata.Automation.AutomationConsoleConfig,RSG.Configuration.Metadata.Automation.AutomationConsoleConfig)">
|
|
<summary>
|
|
Check if two Console are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.SystemCollectionsGenericListRSGConfigurationMetadataAutomationAutomationViewConfigDeepComparer(System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationViewConfig},System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationViewConfig})">
|
|
<summary>
|
|
Check if two Views are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.RSGConfigurationMetadataAutomationAutomationViewConfigDeepComparer(RSG.Configuration.Metadata.Automation.AutomationViewConfig,RSG.Configuration.Metadata.Automation.AutomationViewConfig)">
|
|
<summary>
|
|
Check if two Item are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.SystemCollectionsGenericListRSGConfigurationMetadataAutomationAutomationTaskIdDeepComparer(System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationTaskId},System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationTaskId})">
|
|
<summary>
|
|
Check if two Tasks are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.RSGConfigurationMetadataAutomationAutomationTaskIdDeepComparer(RSG.Configuration.Metadata.Automation.AutomationTaskId,RSG.Configuration.Metadata.Automation.AutomationTaskId)">
|
|
<summary>
|
|
Check if two Item are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.SystemCollectionsGenericListRSGConfigurationMetadataAutomationAutomationDownloadOptionDeepComparer(System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationDownloadOption},System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationDownloadOption})">
|
|
<summary>
|
|
Check if two DownloadOptions are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.RSGConfigurationMetadataAutomationAutomationDownloadOptionDeepComparer(RSG.Configuration.Metadata.Automation.AutomationDownloadOption,RSG.Configuration.Metadata.Automation.AutomationDownloadOption)">
|
|
<summary>
|
|
Check if two Item are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.MemberEquals(System.Object)">
|
|
<summary>
|
|
Check if all members are equals to the members of the object provided
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.GetHashCode">
|
|
<summary>
|
|
Return the hashcode of the instance
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfig.Equals(System.Object)">
|
|
<summary>
|
|
Return the hashcode of the instance
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs._dashboardUrl">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.DashboardUrl"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs._services">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Services"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.#ctor(System.String,System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationServiceConfig})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs" /> by setting the fields in the constructor
|
|
</summary>
|
|
<summary>
|
|
Sets the value of the class
|
|
</summary>
|
|
<param name="dashboardUrlParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.DashboardUrl"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs"/>.
|
|
</param>
|
|
<param name="servicesParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Services"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.#ctor(RSG.Configuration.Metadata.Automation.AutomationServiceConfigs)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.#ctor(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Constructor from XElement.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
XElement that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.#ctor(System.Xml.Linq.XElement,System.Boolean)">
|
|
<summary>
|
|
constructor which load from xmlElement and take in account the inheritance.Do not use yourself it's reserved for deserialization purpose
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.DashboardUrlDefault">
|
|
<summary>
|
|
Return the Default value of DashboardUrlDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.ServicesDefault">
|
|
<summary>
|
|
Return the Default value of ServicesDefault
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Reset">
|
|
<summary>
|
|
Reset the structure to it's Default Values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Set(System.String,System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationServiceConfig})">
|
|
<summary>
|
|
Sets the value of the class
|
|
</summary>
|
|
<param name="dashboardUrlParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.DashboardUrl"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs"/>.
|
|
</param>
|
|
<param name="servicesParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Services"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.GetName">
|
|
<summary>
|
|
Get the name of the class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.GetInstanceName">
|
|
<summary>
|
|
Get the parcodegen name of the instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Clone">
|
|
<summary>
|
|
Creates a new instance that is a copy of this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.CloneMembers(System.Object)">
|
|
<summary>
|
|
Copies member values from other instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Copy(System.Object)">
|
|
<summary>
|
|
Copies member values from other instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.CopyFromObject(System.Object)">
|
|
<summary>
|
|
Copies member values from an object inheriting from RSG.Configuration.Metadata.Automation.AutomationServiceConfigs
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Reset(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Reset the structure to it's Default Values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Load(System.String,RSG.Configuration.Metadata.Automation.AutomationServiceConfigs@)">
|
|
<summary>
|
|
Creates a new AutomationServiceConfigs instance from a file.
|
|
</summary>
|
|
<param name="filename">
|
|
A URI string that references the file to load.
|
|
</param>
|
|
<param name="objectLoaded">
|
|
the object loaded.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Load(System.IO.Stream,RSG.Configuration.Metadata.Automation.AutomationServiceConfigs@)">
|
|
<summary>
|
|
Creates a new AutomationServiceConfigs instance from a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream that contains the parCodeGen data.
|
|
</param>
|
|
<param name="objectLoaded">
|
|
the object loaded.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Load(System.String)">
|
|
<summary>
|
|
Creates a new AutomationServiceConfigs instance from a file.
|
|
</summary>
|
|
<param name="filename">
|
|
A URI string that references the file to load.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Load(System.IO.Stream)">
|
|
<summary>
|
|
Creates a new AutomationServiceConfigs instance from a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream that contains the parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Save(System.String)">
|
|
<summary>
|
|
Serialise this instance to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Save(System.IO.Stream)">
|
|
<summary>
|
|
Serialise this instance to a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
Stream that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Deserialise the XElement into this object.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
XElement to deserialise.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Serialise(System.String)">
|
|
<summary>
|
|
Serialise this instance to an XElement.
|
|
</summary>
|
|
<param name="name">
|
|
Top-level XElement name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.SerialiseWithoutDefault(System.String)">
|
|
<summary>
|
|
Serialise this instance to an XElement.
|
|
</summary>
|
|
<param name="name">
|
|
Top-level XElement name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.SaveWithoutDefault(System.String)">
|
|
<summary>
|
|
Serialise this instance to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.SaveWithoutDefault(System.IO.Stream)">
|
|
<summary>
|
|
Serialise this instance to a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
Stream that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.XmlifyTypeFromCSharp(System.String)">
|
|
<summary>
|
|
Convert C# type name to C++ Initialization name
|
|
</summary>
|
|
<param name="type">
|
|
C# type to convert.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.CSharpifyTypeFromXml(System.String)">
|
|
<summary>
|
|
Convert C# type name to C++ Initialization name
|
|
</summary>
|
|
<param name="type">
|
|
C# type to convert.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.SystemStringDeepComparer(System.String,System.String)">
|
|
<summary>
|
|
Check if two DashboardUrl are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.SystemCollectionsGenericListRSGConfigurationMetadataAutomationAutomationServiceConfigDeepComparer(System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationServiceConfig},System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationServiceConfig})">
|
|
<summary>
|
|
Check if two Services are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.RSGConfigurationMetadataAutomationAutomationServiceConfigDeepComparer(RSG.Configuration.Metadata.Automation.AutomationServiceConfig,RSG.Configuration.Metadata.Automation.AutomationServiceConfig)">
|
|
<summary>
|
|
Check if two Item are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.MemberEquals(System.Object)">
|
|
<summary>
|
|
Check if all members are equals to the members of the object provided
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.GetHashCode">
|
|
<summary>
|
|
Return the hashcode of the instance
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationServiceConfigs.Equals(System.Object)">
|
|
<summary>
|
|
Return the hashcode of the instance
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationTaskId._task">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationTaskId.Task"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationTaskId._guid">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationTaskId.Guid"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationTaskId" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationTaskId" /> by setting the fields in the constructor
|
|
</summary>
|
|
<summary>
|
|
Sets the value of the class
|
|
</summary>
|
|
<param name="taskParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationTaskId.Task"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationTaskId"/>.
|
|
</param>
|
|
<param name="guidParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationTaskId.Guid"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationTaskId"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.#ctor(RSG.Configuration.Metadata.Automation.AutomationTaskId)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationTaskId" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.#ctor(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Constructor from XElement.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
XElement that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.#ctor(System.Xml.Linq.XElement,System.Boolean)">
|
|
<summary>
|
|
constructor which load from xmlElement and take in account the inheritance.Do not use yourself it's reserved for deserialization purpose
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationTaskId.TaskDefault">
|
|
<summary>
|
|
Return the Default value of TaskDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationTaskId.GuidDefault">
|
|
<summary>
|
|
Return the Default value of GuidDefault
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.Reset">
|
|
<summary>
|
|
Reset the structure to it's Default Values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.Set(System.String,System.String)">
|
|
<summary>
|
|
Sets the value of the class
|
|
</summary>
|
|
<param name="taskParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationTaskId.Task"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationTaskId"/>.
|
|
</param>
|
|
<param name="guidParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationTaskId.Guid"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationTaskId"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.GetName">
|
|
<summary>
|
|
Get the name of the class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.GetInstanceName">
|
|
<summary>
|
|
Get the parcodegen name of the instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.Clone">
|
|
<summary>
|
|
Creates a new instance that is a copy of this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.CloneMembers(System.Object)">
|
|
<summary>
|
|
Copies member values from other instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.Copy(System.Object)">
|
|
<summary>
|
|
Copies member values from other instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.CopyFromObject(System.Object)">
|
|
<summary>
|
|
Copies member values from an object inheriting from RSG.Configuration.Metadata.Automation.AutomationTaskId
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.Reset(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Reset the structure to it's Default Values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.Load(System.String,RSG.Configuration.Metadata.Automation.AutomationTaskId@)">
|
|
<summary>
|
|
Creates a new AutomationTaskId instance from a file.
|
|
</summary>
|
|
<param name="filename">
|
|
A URI string that references the file to load.
|
|
</param>
|
|
<param name="objectLoaded">
|
|
the object loaded.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.Load(System.IO.Stream,RSG.Configuration.Metadata.Automation.AutomationTaskId@)">
|
|
<summary>
|
|
Creates a new AutomationTaskId instance from a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream that contains the parCodeGen data.
|
|
</param>
|
|
<param name="objectLoaded">
|
|
the object loaded.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.Load(System.String)">
|
|
<summary>
|
|
Creates a new AutomationTaskId instance from a file.
|
|
</summary>
|
|
<param name="filename">
|
|
A URI string that references the file to load.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.Load(System.IO.Stream)">
|
|
<summary>
|
|
Creates a new AutomationTaskId instance from a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream that contains the parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.Save(System.String)">
|
|
<summary>
|
|
Serialise this instance to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.Save(System.IO.Stream)">
|
|
<summary>
|
|
Serialise this instance to a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
Stream that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Deserialise the XElement into this object.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
XElement to deserialise.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.Serialise(System.String)">
|
|
<summary>
|
|
Serialise this instance to an XElement.
|
|
</summary>
|
|
<param name="name">
|
|
Top-level XElement name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.SerialiseWithoutDefault(System.String)">
|
|
<summary>
|
|
Serialise this instance to an XElement.
|
|
</summary>
|
|
<param name="name">
|
|
Top-level XElement name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.SaveWithoutDefault(System.String)">
|
|
<summary>
|
|
Serialise this instance to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.SaveWithoutDefault(System.IO.Stream)">
|
|
<summary>
|
|
Serialise this instance to a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
Stream that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.SystemStringDeepComparer(System.String,System.String)">
|
|
<summary>
|
|
Check if two Task are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.MemberEquals(System.Object)">
|
|
<summary>
|
|
Check if all members are equals to the members of the object provided
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.GetHashCode">
|
|
<summary>
|
|
Return the hashcode of the instance
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationTaskId.Equals(System.Object)">
|
|
<summary>
|
|
Return the hashcode of the instance
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationViewConfig._name">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Name"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationViewConfig._webAlias">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.WebAlias"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationViewConfig._branchName">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.BranchName"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationViewConfig._filterKey">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.FilterKey"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationViewConfig._filterValue">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.FilterValue"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationViewConfig._viewMode">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.ViewMode"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationViewConfig._allowAnonymous">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.AllowAnonymous"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationViewConfig._cacheViewData">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.CacheViewData"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationViewConfig._disabledViewModes">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.DisabledViewModes"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationViewConfig._defaultHiddenColumns">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.DefaultHiddenColumns"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationViewConfig._prioritisedGroupKeys">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.PrioritisedGroupKeys"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationViewConfig._successfulBuildDependencies">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.SuccessfulBuildDependencies"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Metadata.Automation.AutomationViewConfig._eventsToDisplay">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.EventsToDisplay"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.#ctor(System.String,System.String,System.String,System.String,System.String,RSG.Configuration.Automation.ViewMode,System.Boolean,System.Boolean,System.Collections.Generic.List{RSG.Configuration.Automation.ViewMode},System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String},System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationDependencyBuild},System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationDisplayEvent})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig" /> by setting the fields in the constructor
|
|
</summary>
|
|
<summary>
|
|
Sets the value of the class
|
|
</summary>
|
|
<param name="nameParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Name"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="webAliasParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.WebAlias"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="branchNameParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.BranchName"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="filterKeyParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.FilterKey"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="filterValueParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.FilterValue"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="viewModeParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.ViewMode"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="allowAnonymousParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.AllowAnonymous"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="cacheViewDataParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.CacheViewData"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="disabledViewModesParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.DisabledViewModes"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="defaultHiddenColumnsParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.DefaultHiddenColumns"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="prioritisedGroupKeysParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.PrioritisedGroupKeys"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="successfulBuildDependenciesParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.SuccessfulBuildDependencies"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="eventsToDisplayParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.EventsToDisplay"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.#ctor(RSG.Configuration.Metadata.Automation.AutomationViewConfig)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.#ctor(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Constructor from XElement.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
XElement that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.#ctor(System.Xml.Linq.XElement,System.Boolean)">
|
|
<summary>
|
|
constructor which load from xmlElement and take in account the inheritance.Do not use yourself it's reserved for deserialization purpose
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.NameDefault">
|
|
<summary>
|
|
Return the Default value of NameDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.WebAliasDefault">
|
|
<summary>
|
|
Return the Default value of WebAliasDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.BranchNameDefault">
|
|
<summary>
|
|
Return the Default value of BranchNameDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.FilterKeyDefault">
|
|
<summary>
|
|
Return the Default value of FilterKeyDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.FilterValueDefault">
|
|
<summary>
|
|
Return the Default value of FilterValueDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.ViewModeDefault">
|
|
<summary>
|
|
Return the Default value of ViewModeDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.AllowAnonymousDefault">
|
|
<summary>
|
|
Return the Default value of AllowAnonymousDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.CacheViewDataDefault">
|
|
<summary>
|
|
Return the Default value of CacheViewDataDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.DisabledViewModesDefault">
|
|
<summary>
|
|
Return the Default value of DisabledViewModesDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.DefaultHiddenColumnsDefault">
|
|
<summary>
|
|
Return the Default value of DefaultHiddenColumnsDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.PrioritisedGroupKeysDefault">
|
|
<summary>
|
|
Return the Default value of PrioritisedGroupKeysDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.SuccessfulBuildDependenciesDefault">
|
|
<summary>
|
|
Return the Default value of SuccessfulBuildDependenciesDefault
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.EventsToDisplayDefault">
|
|
<summary>
|
|
Return the Default value of EventsToDisplayDefault
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Reset">
|
|
<summary>
|
|
Reset the structure to it's Default Values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Set(System.String,System.String,System.String,System.String,System.String,RSG.Configuration.Automation.ViewMode,System.Boolean,System.Boolean,System.Collections.Generic.List{RSG.Configuration.Automation.ViewMode},System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String},System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationDependencyBuild},System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationDisplayEvent})">
|
|
<summary>
|
|
Sets the value of the class
|
|
</summary>
|
|
<param name="nameParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Name"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="webAliasParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.WebAlias"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="branchNameParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.BranchName"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="filterKeyParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.FilterKey"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="filterValueParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.FilterValue"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="viewModeParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.ViewMode"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="allowAnonymousParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.AllowAnonymous"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="cacheViewDataParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.CacheViewData"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="disabledViewModesParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.DisabledViewModes"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="defaultHiddenColumnsParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.DefaultHiddenColumns"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="prioritisedGroupKeysParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.PrioritisedGroupKeys"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="successfulBuildDependenciesParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.SuccessfulBuildDependencies"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
<param name="eventsToDisplayParam">
|
|
The parameter setting the value <see cref="P:RSG.Configuration.Metadata.Automation.AutomationViewConfig.EventsToDisplay"/> of <see cref="T:RSG.Configuration.Metadata.Automation.AutomationViewConfig"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.GetName">
|
|
<summary>
|
|
Get the name of the class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.GetInstanceName">
|
|
<summary>
|
|
Get the parcodegen name of the instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Clone">
|
|
<summary>
|
|
Creates a new instance that is a copy of this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.CloneMembers(System.Object)">
|
|
<summary>
|
|
Copies member values from other instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Copy(System.Object)">
|
|
<summary>
|
|
Copies member values from other instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.CopyFromObject(System.Object)">
|
|
<summary>
|
|
Copies member values from an object inheriting from RSG.Configuration.Metadata.Automation.AutomationViewConfig
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Reset(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Reset the structure to it's Default Values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Load(System.String,RSG.Configuration.Metadata.Automation.AutomationViewConfig@)">
|
|
<summary>
|
|
Creates a new AutomationViewConfig instance from a file.
|
|
</summary>
|
|
<param name="filename">
|
|
A URI string that references the file to load.
|
|
</param>
|
|
<param name="objectLoaded">
|
|
the object loaded.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Load(System.IO.Stream,RSG.Configuration.Metadata.Automation.AutomationViewConfig@)">
|
|
<summary>
|
|
Creates a new AutomationViewConfig instance from a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream that contains the parCodeGen data.
|
|
</param>
|
|
<param name="objectLoaded">
|
|
the object loaded.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Load(System.String)">
|
|
<summary>
|
|
Creates a new AutomationViewConfig instance from a file.
|
|
</summary>
|
|
<param name="filename">
|
|
A URI string that references the file to load.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Load(System.IO.Stream)">
|
|
<summary>
|
|
Creates a new AutomationViewConfig instance from a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream that contains the parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Save(System.String)">
|
|
<summary>
|
|
Serialise this instance to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Save(System.IO.Stream)">
|
|
<summary>
|
|
Serialise this instance to a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
Stream that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Deserialise the XElement into this object.
|
|
</summary>
|
|
<param name="xmlElem">
|
|
XElement to deserialise.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Serialise(System.String)">
|
|
<summary>
|
|
Serialise this instance to an XElement.
|
|
</summary>
|
|
<param name="name">
|
|
Top-level XElement name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.SerialiseWithoutDefault(System.String)">
|
|
<summary>
|
|
Serialise this instance to an XElement.
|
|
</summary>
|
|
<param name="name">
|
|
Top-level XElement name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.SaveWithoutDefault(System.String)">
|
|
<summary>
|
|
Serialise this instance to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.SaveWithoutDefault(System.IO.Stream)">
|
|
<summary>
|
|
Serialise this instance to a stream.
|
|
</summary>
|
|
<param name="stream">
|
|
Stream that contains parCodeGen data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.XmlifyTypeFromCSharp(System.String)">
|
|
<summary>
|
|
Convert C# type name to C++ Initialization name
|
|
</summary>
|
|
<param name="type">
|
|
C# type to convert.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.CSharpifyTypeFromXml(System.String)">
|
|
<summary>
|
|
Convert C# type name to C++ Initialization name
|
|
</summary>
|
|
<param name="type">
|
|
C# type to convert.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.SystemStringDeepComparer(System.String,System.String)">
|
|
<summary>
|
|
Check if two Name are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.RSGConfigurationAutomationViewModeDeepComparer(RSG.Configuration.Automation.ViewMode,RSG.Configuration.Automation.ViewMode)">
|
|
<summary>
|
|
Check if two ViewMode are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.SystemBooleanDeepComparer(System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Check if two AllowAnonymous are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.SystemCollectionsGenericListRSGConfigurationAutomationViewModeDeepComparer(System.Collections.Generic.List{RSG.Configuration.Automation.ViewMode},System.Collections.Generic.List{RSG.Configuration.Automation.ViewMode})">
|
|
<summary>
|
|
Check if two DisabledViewModes are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.SystemCollectionsGenericListSystemStringDeepComparer(System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String})">
|
|
<summary>
|
|
Check if two DefaultHiddenColumns are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.SystemCollectionsGenericListRSGConfigurationMetadataAutomationAutomationDependencyBuildDeepComparer(System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationDependencyBuild},System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationDependencyBuild})">
|
|
<summary>
|
|
Check if two SuccessfulBuildDependencies are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.RSGConfigurationMetadataAutomationAutomationDependencyBuildDeepComparer(RSG.Configuration.Metadata.Automation.AutomationDependencyBuild,RSG.Configuration.Metadata.Automation.AutomationDependencyBuild)">
|
|
<summary>
|
|
Check if two Item are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.SystemCollectionsGenericListRSGConfigurationMetadataAutomationAutomationDisplayEventDeepComparer(System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationDisplayEvent},System.Collections.Generic.List{RSG.Configuration.Metadata.Automation.AutomationDisplayEvent})">
|
|
<summary>
|
|
Check if two EventsToDisplay are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.RSGConfigurationMetadataAutomationAutomationDisplayEventDeepComparer(RSG.Configuration.Metadata.Automation.AutomationDisplayEvent,RSG.Configuration.Metadata.Automation.AutomationDisplayEvent)">
|
|
<summary>
|
|
Check if two Item are equals
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.MemberEquals(System.Object)">
|
|
<summary>
|
|
Check if all members are equals to the members of the object provided
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.GetHashCode">
|
|
<summary>
|
|
Return the hashcode of the instance
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Metadata.Automation.AutomationViewConfig.Equals(System.Object)">
|
|
<summary>
|
|
Return the hashcode of the instance
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.RunlineMode">
|
|
<summary>
|
|
Runline installer mode.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RunlineMode.Install">
|
|
<summary>
|
|
Install.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RunlineMode.Uninstall">
|
|
<summary>
|
|
Uninstall.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Util.Application">
|
|
<summary>
|
|
Helper class for <see cref="T:RSG.Configuration.IApplication"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Util.Application.TimeInMilliSecondsToWaitForAppsToClose">
|
|
<summary>
|
|
Time to wait for applications to shut down gracefully in milliseconds.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Util.Application.LaunchApplications(System.Collections.Generic.IEnumerable{RSG.Configuration.IApplication},RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Attempts to start applications if the executable file exists with their default arguments.
|
|
</summary>
|
|
<param name="appsToStart">
|
|
Set of <see cref="T:RSG.Configuration.IApplication"/> objects to start.
|
|
</param>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Util.Application.ShutdownRunningApplications(System.Collections.Generic.IEnumerable{RSG.Configuration.IApplication},RSG.Base.Logging.ILog,System.TimeSpan)">
|
|
<summary>
|
|
Attempts to shutdown any applications with instances running.
|
|
</summary>
|
|
<param name="appsToShutdown">Collection of apps to shut down.</param>
|
|
<param name="log">Logger instance.</param>
|
|
<param name="waitBeforeForceClose">Tine to wait before force closing the applications</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Util.Application.ShutdownRunningApplicationsAsync(System.Collections.Generic.IEnumerable{RSG.Configuration.IApplication},RSG.Base.Logging.Universal.IUniversalLog,System.TimeSpan)">
|
|
<summary>
|
|
Attempts to shutdown any applications with instances running.
|
|
</summary>
|
|
<param name="appsToShutdown">Collection of apps to shut down.</param>
|
|
<param name="log">Logger instance.</param>
|
|
<param name="waitBeforeForceClose">Tine to wait before force closing the applications</param>
|
|
<returns>A task representing the action.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Util.Application.GetBootstrappedApplications(RSG.Configuration.IApplicationCollection)">
|
|
<summary>
|
|
Filters the app collection for apps that should be automatically shutdown and bootstrapped.
|
|
</summary>
|
|
<param name="appCollection">
|
|
<see cref="T:RSG.Configuration.IApplicationCollection"/> object.
|
|
</param>
|
|
<returns>
|
|
Set of <see cref="T:RSG.Configuration.IApplication"/> objects that are bootstrapped.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Util.Application.GetApplicationsToShutdown(RSG.Configuration.IApplicationCollection,System.Collections.Generic.IEnumerable{RSG.Configuration.IApplication}@,System.Collections.Generic.IEnumerable{RSG.Configuration.IApplication}@)">
|
|
<summary>
|
|
Filters the app collection for apps that should be prompted for shutdown and apps to bootstrap.
|
|
Apps to bootstrap should be restarted after shutting down.
|
|
</summary>
|
|
<param name="appCollection">
|
|
<see cref="T:RSG.Configuration.IApplicationCollection"/> object.
|
|
</param>
|
|
<param name="appsToPromptShutdown">
|
|
Set of <see cref="T:RSG.Configuration.IApplication"/> that should be shutdown.
|
|
</param>
|
|
<param name="appsToBootstrap">
|
|
Set of <see cref="T:RSG.Configuration.IApplication"/> that are bootstrapped.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Util.RestartBootrappedAppsUtil">
|
|
<summary>
|
|
Disposable that automatically shutsdown apps that need to shutdown and are bootstrapped.
|
|
Exposes apps that need to be shutdown separately but aren't bootstrapped.
|
|
On disposal, bootstrapped apps will be relaunched.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Util.RestartBootrappedAppsUtil._log">
|
|
<summary>
|
|
Log instance.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Util.RestartBootrappedAppsUtil._bootstrappedApps">
|
|
<summary>
|
|
Collection of apps that are shutdown.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Util.RestartBootrappedAppsUtil._toolsBranch">
|
|
<summary>
|
|
Tools branch info.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Util.RestartBootrappedAppsUtil.#ctor(RSG.Configuration.IApplicationCollection,RSG.Configuration.IToolsBranch,RSG.Base.Logging.ILog,System.TimeSpan)">
|
|
<summary>
|
|
Shutdown bootstrapped apps immediately.
|
|
</summary>
|
|
<param name="apps">Apps to consider.</param>
|
|
<param name="toolsBranch">Current tools branch.</param>
|
|
<param name="log">Log instance.</param>
|
|
<param name="forceExitTimeout">Timeout to force exit bootstrapped apps after requesting close.</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Util.RestartBootrappedAppsUtil.NonBootstrappedApps">
|
|
<summary>
|
|
Gets applications that aren't automatically bootstrapped.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Util.RestartBootrappedAppsUtil.Dispose">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Util.ConfigExtensions">
|
|
<summary>
|
|
<see cref="T:RSG.Configuration.IConfig"/> extension method class.
|
|
</summary>
|
|
<remarks>
|
|
DHM FIX ME. Please do not extend this class.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Util.ConfigExtensions.GetCorrespondingBranchForProject(RSG.Configuration.IConfig,System.String,System.String,RSG.Configuration.IProject@,RSG.Configuration.IBranch@)">
|
|
<summary>
|
|
Helper function to help retrieve the anticipated IBranch object back from an IConfig based on the desired project name and branch name.
|
|
</summary>
|
|
<param name="config">
|
|
Config object.
|
|
</param>
|
|
<param name="projectName">
|
|
Project name.
|
|
</param>
|
|
<param name="branchName">
|
|
Branch name.
|
|
</param>
|
|
<param name="matchingProject">
|
|
<see cref="T:RSG.Configuration.IProject"/> output that matches the name.
|
|
</param>
|
|
<param name="matchingBranch">
|
|
<see cref="T:RSG.Configuration.IBranch"/> output that matches the name.
|
|
</param>
|
|
<returns>
|
|
true if successful; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Util.ShellExtensionUtil">
|
|
<summary>
|
|
Registering and unregistering the Tools Shell Extension.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Util.ShellExtensionUtil.ShellExtDll">
|
|
<summary>
|
|
Dll to register.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Util.ShellExtensionUtil.LogCtx">
|
|
<summary>
|
|
Log context name.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Util.ShellExtensionUtil.RegisterExe">
|
|
<summary>
|
|
Register executable to run.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Util.ShellExtensionUtil.TimeoutMs">
|
|
<summary>
|
|
Timeout of the process.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Util.ShellExtensionUtil.GetShellExtensionPath(RSG.Configuration.IToolsBranch)">
|
|
<summary>
|
|
Obtains the shell extension dll path in the tools branch.
|
|
</summary>
|
|
<param name="branch">Branch</param>
|
|
<returns>Filepath to dll.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Util.ShellExtensionUtil.UnRegister(RSG.Configuration.IToolsBranch,RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Unregisters the <see cref="F:RSG.Configuration.Util.ShellExtensionUtil.ShellExtDll"/>.
|
|
</summary>
|
|
<param name="branch">Branch.</param>
|
|
<param name="log">Log.</param>
|
|
<returns>True if successful.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Util.ShellExtensionUtil.Register(RSG.Configuration.IToolsBranch,RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Registers the <see cref="F:RSG.Configuration.Util.ShellExtensionUtil.ShellExtDll"/>.
|
|
</summary>
|
|
<param name="branch">Branch.</param>
|
|
<param name="log">Log.</param>
|
|
<returns>True if successful.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Util.ShellExtensionUtil.RunRegistration(RSG.Configuration.IToolsBranch,RSG.Base.Logging.ILog,System.Boolean)">
|
|
<summary>
|
|
Attempts to launch a process to register the <see cref="F:RSG.Configuration.Util.ShellExtensionUtil.ShellExtDll"/> using <see cref="F:RSG.Configuration.Util.ShellExtensionUtil.RegisterExe"/>.
|
|
</summary>
|
|
<param name="branch">Branch.</param>
|
|
<param name="log">Log.</param>
|
|
<param name="unregister">Flag indicating if the dll will be unregistered.</param>
|
|
<returns>True if successful.</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.XmlConfigReader">
|
|
<summary>
|
|
Configuration reader that reads the data from it's Xml representation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.XmlConfigReader._settings">
|
|
<summary>
|
|
The reader settings to use when reading data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.XmlConfigReader.#ctor(RSG.Configuration.ConfigReaderSettings)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.XmlConfigReader"/> class using the
|
|
specified stream and settings.
|
|
</summary>
|
|
<param name="settings">
|
|
Settings to use while reading data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.XmlConfigReader.ReadBugstarConfig(System.IO.Stream)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.XmlConfigReader.ReadHubConfig(System.IO.Stream)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.XmlConfigReader.ReadIgnoredConnectionsSourcesConfig(System.IO.Stream)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.XmlConfigReader.ReadLevel(System.IO.Stream)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.XmlConfigReader.ReadMap(System.IO.Stream)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.XmlConfigReader.ReadMapCollection(System.IO.Stream)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.XmlConfigReader.ReadLevelCollection(System.IO.Stream)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.XmlConfigReader.ParseLevel(System.Xml.Linq.XElement,RSG.Configuration.ConfigReaderSettings)">
|
|
<summary>
|
|
Parses a single level object.
|
|
</summary>
|
|
<param name="element">
|
|
The Xml element containing the level data.
|
|
</param>
|
|
<param name="settings">
|
|
Settings to use while reading the level data.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.ILevel"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.XmlConfigReader.ParseMap(System.Xml.Linq.XElement,RSG.Configuration.ConfigReaderSettings)">
|
|
<summary>
|
|
Parses a single background map object.
|
|
</summary>
|
|
<param name="element">
|
|
The Xml element containing the map data.
|
|
</param>
|
|
<param name="settings">
|
|
Settings to use while reading the map data.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.IMap"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.XmlConfigReader.ParseMapBounds(System.Xml.Linq.XElement,System.Windows.Point@,System.Windows.Point@)">
|
|
<summary>
|
|
Parses the bounds out of an Xml element.
|
|
</summary>
|
|
<param name="boundsElement">
|
|
The Xml element containing the bounds data.
|
|
</param>
|
|
<param name="minBounds">
|
|
The minimum bounds of the map.
|
|
</param>
|
|
<param name="maxBounds">
|
|
The maximum bounds of the map.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IAutomationConfig">
|
|
<summary>
|
|
Automation config interface
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IAutomationConfig.Environment">
|
|
<summary>
|
|
Gets the associated environment.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IAutomationConfig.Name">
|
|
<summary>
|
|
Gets the branch name of the automation config
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IAutomationConfig.BinDirectory">
|
|
<summary>
|
|
Gets the binary directory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IAutomationConfig.ConfigDirectory">
|
|
<summary>
|
|
Gets the config directory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IAutomationConfig.ScriptDirectory">
|
|
<summary>
|
|
Gets the script directory.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IAutomationConfig.ExpandedPaths">
|
|
<summary>
|
|
Get the paths involved in the automation branch
|
|
</summary>
|
|
<returns>
|
|
Set of paths.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IAutomationConfig.CommonExpandedPath">
|
|
<summary>
|
|
Gets the common path of all automation paths
|
|
- this *may* form a base path which can be useful for some filesystem ops.
|
|
</summary>
|
|
<returns>
|
|
Common path.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IAutomationConfig.FullPathConfigDirectory">
|
|
<summary>
|
|
Env substs the config dir.
|
|
</summary>
|
|
<returns>
|
|
Configuration directory.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IAutomationConfig.FullPathBinDirectory">
|
|
<summary>
|
|
Env substs the bin dir.
|
|
</summary>
|
|
<returns>
|
|
Binary directory.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IAutomationConfig.FullPathScriptDirectory">
|
|
<summary>
|
|
Env substs the bin dir.
|
|
</summary>
|
|
<returns>
|
|
Script directory.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IAutomationConfig.FullServicesConfigPath">
|
|
<summary>
|
|
Env substs the automation services cfg file.
|
|
</summary>
|
|
<returns>
|
|
Services configuration directory.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IConfigReader">
|
|
<summary>
|
|
Defines methods that need to be implemented to allow configuration data to be read.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IConfigReader.ReadBugstarConfig(System.IO.Stream)">
|
|
<summary>
|
|
Reads the bugstar configuration data.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream to read the bugstar configuration data from.
|
|
</param>
|
|
<returns>
|
|
A new instance of the bugstar configuration data.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IConfigReader.ReadHubConfig(System.IO.Stream)">
|
|
<summary>
|
|
Reads the hub configuration data.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream to read the hub configuration data from.
|
|
</param>
|
|
<returns>
|
|
A new instance of the hub configuration data.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IConfigReader.ReadIgnoredConnectionsSourcesConfig(System.IO.Stream)">
|
|
<summary>
|
|
Reads the ignored connection sources configuration data.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream to read the ignored connection sources configuration data from.
|
|
</param>
|
|
<returns>
|
|
A new instance of the ignored connection sources configuration data.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IConfigReader.ReadLevel(System.IO.Stream)">
|
|
<summary>
|
|
Creates a new level configuration object from the specified stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream to read the level configuration data from.
|
|
</param>
|
|
<returns>
|
|
A new level configuration object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IConfigReader.ReadMap(System.IO.Stream)">
|
|
<summary>
|
|
Creates a new level background map configuration object from the specified stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream to read the background map configuration data from.
|
|
</param>
|
|
<returns>
|
|
A new level background map configuration object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IConfigReader.ReadMapCollection(System.IO.Stream)">
|
|
<summary>
|
|
Creates a new map collection configuration object from the specified stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream to read the map collection configuration data from.
|
|
</param>
|
|
<returns>
|
|
A new map collection configuration object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IConfigReader.ReadLevelCollection(System.IO.Stream)">
|
|
<summary>
|
|
Creates a new level collection configuration object from the specified stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream to read the level collection configuration data from.
|
|
</param>
|
|
<returns>
|
|
A new level collection configuration object.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IMap">
|
|
<summary>
|
|
Defines a map that is associated with a level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IMap.Description">
|
|
<summary>
|
|
Gets a description of the map.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IMap.ImageSource">
|
|
<summary>
|
|
Gets the file path to the maps image data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IMap.MaxBounds">
|
|
<summary>
|
|
Gets the maximum bounds of the map.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IMap.MinBounds">
|
|
<summary>
|
|
Gets the minimum bounds of the map.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IMap.Name">
|
|
<summary>
|
|
Gets a friendly name for the map.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IMap.ThumbnailSource">
|
|
<summary>
|
|
Gets the file path to the maps thumbnail data.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IToolsBranch">
|
|
<summary>
|
|
Interface to define a distribution of tools (i.e. a tools-branch). In our new
|
|
branching strategy this is considered for example "development" or "release".
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsBranch.Config">
|
|
<summary>
|
|
Gets the parent configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsBranch.Name">
|
|
<summary>
|
|
Gets the tools branch key name (unique oper project).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsBranch.FriendlyName">
|
|
<summary>
|
|
Gets the tools branch friendly name (for UI display).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsBranch.Description">
|
|
<summary>
|
|
Gets the tools branch description.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsBranch.ToolsRootDirectory">
|
|
<summary>
|
|
Gets the tools root directory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsBranch.ToolsBinDirectory">
|
|
<summary>
|
|
Gets the tools binary directory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsBranch.ToolsConfigDirectory">
|
|
<summary>
|
|
Gets the tools configuration data absolute path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsBranch.ToolsLogsDirectory">
|
|
<summary>
|
|
Gets the tools log file directory absolute path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsBranch.ToolsInstaller">
|
|
<summary>
|
|
Gets the absolute path to Tools Installer.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IToolsBranch.ToolsQuickInstaller">
|
|
<summary>
|
|
Gets the absolute path to Tools Quick Installer.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Portal.IPortalBugstarConfig">
|
|
<summary>
|
|
Portal Bugstar configuration interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalBugstarConfig.BugstarID">
|
|
<summary>
|
|
Gets the Project's Bugstar ID
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Portal.IPortalConfig">
|
|
<summary>
|
|
Portal Configuration interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalConfig.Name">
|
|
<summary>
|
|
Gets the project's Full Name for the Portal.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalConfig.ShortName">
|
|
<summary>
|
|
Gets the project's Short Name for the Portal
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalConfig.RouteName">
|
|
<summary>
|
|
Gets the project's Route Name for the URI
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalConfig.LogoPath">
|
|
<summary>
|
|
Gets the project's Logo Path (Relative to the Web Server)
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalConfig.IconPath">
|
|
<summary>
|
|
Gets the project's Icon Path (Relative to the Web Server)
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalConfig.UpdateInterval">
|
|
<summary>
|
|
Gets the portal Periodical Update Time Interval in Milliseconds
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalConfig.BugstarConfigs">
|
|
<summary>
|
|
Gets the project's Bugstar Configuration Details
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalConfig.StatisticServers">
|
|
<summary>
|
|
Gets the portal Statistic Servers configuration details.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalConfig.ShortcutMenuItems">
|
|
<summary>
|
|
Gets the portal Shortcut Menu Items configuration details.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalConfig.ExternalLinks">
|
|
<summary>
|
|
Gets the portal External Links configuration details.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.IPortalConfig.GetPortalUri">
|
|
<summary>
|
|
Get the Portal URI (Current Project)
|
|
</summary>
|
|
<returns>
|
|
Automation portal base <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.IPortalConfig.GetPortalProjectUri">
|
|
<summary>
|
|
Get The Portal's Project URI (Current Project)
|
|
</summary>
|
|
<returns>
|
|
Automation portal project <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.IPortalConfig.GetPortalAutomationUri">
|
|
<summary>
|
|
Get the Portal's Automation URI (Current Project)
|
|
</summary>
|
|
<returns>
|
|
Automation portal <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.IPortalConfig.GetPortalAutomationUri(System.String)">
|
|
<summary>
|
|
Get the Portal's Automation URI For a Specific Server
|
|
</summary>
|
|
<param name="webAlias">
|
|
Web alias for the server.
|
|
</param>
|
|
<returns>
|
|
Automation portal <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.IPortalConfig.GetPortalAutomationUri(System.String,System.Guid)">
|
|
<summary>
|
|
Get the Portal's Automation URI For a Specific Server
|
|
If the JobId is passed then the View's filter is pre-populated
|
|
</summary>
|
|
<param name="webAlias">
|
|
Web alias for the server.
|
|
</param>
|
|
<param name="jobId">
|
|
Job identifier.
|
|
</param>
|
|
<returns>
|
|
Automation portal <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.IPortalConfig.GetPortalAutomationStatusUri(System.String)">
|
|
<summary>
|
|
Get The Portal's Automation Status URI (Current Project)
|
|
</summary>
|
|
<param name="webAlias">
|
|
Web alias for the server.
|
|
</param>
|
|
<returns>
|
|
Automation status <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.IPortalConfig.GetPortalAutomationMonitorUri(System.String)">
|
|
<summary>
|
|
Get The Portal's Automation Monitor URI For a Specific Server
|
|
</summary>
|
|
<param name="webAlias">
|
|
Web alias for the server.
|
|
</param>
|
|
<returns>
|
|
Automation monitor server <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.IPortalConfig.GetPortalAutomationMonitorStatusServerUri">
|
|
<summary>
|
|
Get the Portal's Automation Status Server Action
|
|
</summary>
|
|
<returns>
|
|
Automation status server <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.IPortalConfig.GetPortalAutomationMatrixUri(System.String)">
|
|
<summary>
|
|
Get the Portal's Automation Job Matrix URI For a Specific Server
|
|
</summary>
|
|
<param name="webAlias">
|
|
Web alias for the server.
|
|
</param>
|
|
<returns>
|
|
Automation matrix <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.IPortalConfig.GetPortalAutomationAdminActionServerUri(System.String)">
|
|
<summary>
|
|
Get the Portal's Automation Admin Action Server Action
|
|
</summary>
|
|
<param name="webAlias">
|
|
Web alias for the server.
|
|
</param>
|
|
<returns>
|
|
Automation admin action server <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.IPortalConfig.GetPortalGameBuildVersionsUri">
|
|
<summary>
|
|
Get the Portal's GameBuild Versions URI (Current Project)
|
|
</summary>
|
|
<returns>
|
|
Game build version <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.IPortalConfig.GetPortalToolsVersionsUri">
|
|
<summary>
|
|
Get the Portal's Tools Versions URI (Current Project)
|
|
</summary>
|
|
<returns>
|
|
Tools version <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.IPortalConfig.GetPortalUlogUri">
|
|
<summary>
|
|
Get the Portal's Ulog URI (Project Independent)
|
|
</summary>
|
|
<returns>
|
|
Portal Universal Log <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.IPortalConfig.GetPortalUlogUri(System.String,System.Guid,System.Boolean)">
|
|
<summary>
|
|
Get the Portal's Ulog URI for a specific job (Project Independent)
|
|
</summary>
|
|
<param name="serverHost">
|
|
Server host.
|
|
</param>
|
|
<param name="jobId">
|
|
Job identifier.
|
|
</param>
|
|
<param name="errorsOnly">
|
|
Value indicating whether to only return errors or all messages.
|
|
</param>
|
|
<returns>
|
|
Portal Universal Log <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.IPortalConfig.GetPortalUlogDownloadUri">
|
|
<summary>
|
|
Get The Portal's Ulog Download URI (Project Independent)
|
|
</summary>
|
|
<returns>
|
|
Portal Universal Log download <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.IPortalConfig.GetPortalUlogDownloadUri(System.String,System.Guid)">
|
|
<summary>
|
|
Get The Portal's Ulog Download URI for a specific job (Project Independent)
|
|
</summary>
|
|
<param name="serverHost">
|
|
Server host.
|
|
</param>
|
|
<param name="jobId">
|
|
Job identifier.
|
|
</param>
|
|
<returns>
|
|
Portal Universal Log download <see cref="T:System.Uri"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Portal.IPortalExternalLinkConfig">
|
|
<summary>
|
|
Portal External Links configuration interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalExternalLinkConfig.Name">
|
|
<summary>
|
|
Gets the External Link Name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalExternalLinkConfig.URI">
|
|
<summary>
|
|
Gets the External Link URI.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Portal.IPortalShortcutMenuItemConfig">
|
|
<summary>
|
|
Portal Shortcut Menu Item configuration interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalShortcutMenuItemConfig.Name">
|
|
<summary>
|
|
Gets the Shortcut Menu Item Name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalShortcutMenuItemConfig.Guid">
|
|
<summary>
|
|
Gets the Shortcut Menu Item Guid.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Portal.IPortalStatisticServerConfig">
|
|
<summary>
|
|
Portal Statistic Server configuration interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalStatisticServerConfig.Name">
|
|
<summary>
|
|
Gets the Statistic Server Name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.IPortalStatisticServerConfig.WebHost">
|
|
<summary>
|
|
Gets the Statistic Server WebHost.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Portal.PortalBugstarConfig">
|
|
<summary>
|
|
Portal Bugstar configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalBugstarConfig.BugstarID">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalBugstarConfig.Load(RSG.Configuration.IProject,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Load Portal Bugstar ID configuration from an XML element.
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<returns>
|
|
A new instance of the <see cref="T:RSG.Configuration.Portal.PortalBugstarConfig"/> class.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Portal.PortalConfig">
|
|
<summary>
|
|
Portal Configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Portal.PortalConfig._host">
|
|
<summary>
|
|
Portal Host
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Portal.PortalConfig._projectController">
|
|
<summary>
|
|
Portal Project Controller
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Portal.PortalConfig._projectRouteName">
|
|
<summary>
|
|
Portal Project Route Name
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Portal.PortalConfig._automationAction">
|
|
<summary>
|
|
Portal Project Automation Action
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Portal.PortalConfig._automationStatusAction">
|
|
<summary>
|
|
Portal Project Automation Action
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Portal.PortalConfig._automationMonitorAction">
|
|
<summary>
|
|
Portal Project Automation Monitor Action
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Portal.PortalConfig._automationMonitorStatusServerAction">
|
|
<summary>
|
|
Portal Project Automation Monitor Server Status Action
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Portal.PortalConfig._automationMatrixAction">
|
|
<summary>
|
|
Portal Project Automation Job Matrix Action
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Portal.PortalConfig._automationAdminAction">
|
|
<summary>
|
|
Portal Project Automation Job Action
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Portal.PortalConfig._gameBuildVersionsAction">
|
|
<summary>
|
|
Portal Game Build Versions Automation Action
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Portal.PortalConfig._toolsVersionsAction">
|
|
<summary>
|
|
Portal Tools Versions Action
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Portal.PortalConfig._ulogAction">
|
|
<summary>
|
|
Portal Ulog Action
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Portal.PortalConfig._ulogGetAction">
|
|
<summary>
|
|
Portal Ulog Download Get Action
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.#ctor(System.Uri,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Int32,System.Collections.Generic.IEnumerable{RSG.Configuration.Portal.IPortalBugstarConfig},System.Collections.Generic.IEnumerable{RSG.Configuration.Portal.IPortalStatisticServerConfig},System.Collections.Generic.IEnumerable{RSG.Configuration.Portal.IPortalShortcutMenuItemConfig},System.Collections.Generic.IEnumerable{RSG.Configuration.Portal.IPortalExternalLinkConfig})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Portal.PortalConfig"/> class.
|
|
</summary>
|
|
<param name="host"></param>
|
|
<param name="projectController"></param>
|
|
<param name="projectRouteName"></param>
|
|
<param name="automationAction"></param>
|
|
<param name="automationStatusAction"></param>
|
|
<param name="automationMonitorAction"></param>
|
|
<param name="automationMonitorStatusServerAction"></param>
|
|
<param name="automationMatrixAction"></param>
|
|
<param name="automationAdminAction"></param>
|
|
<param name="gameBuildVersionsAction"></param>
|
|
<param name="toolsVersionAction"></param>
|
|
<param name="ulogAction"></param>
|
|
<param name="ulogGetAction"></param>
|
|
<param name="name"></param>
|
|
<param name="shortName"></param>
|
|
<param name="logoPath"></param>
|
|
<param name="iconPath"></param>
|
|
<param name="updateInterval"></param>
|
|
<param name="bugstarConfigs"></param>
|
|
<param name="statisticServers"></param>
|
|
<param name="shortcutMenuItems"></param>
|
|
<param name="externalLinks"></param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalConfig.Name">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalConfig.ShortName">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalConfig.RouteName">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalConfig.LogoPath">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalConfig.IconPath">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalConfig.UpdateInterval">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalConfig.BugstarConfigs">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalConfig.StatisticServers">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalConfig.ShortcutMenuItems">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalConfig.ExternalLinks">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.Load(RSG.Configuration.IProject,System.String)">
|
|
<summary>
|
|
Load Portal configuration for a project.
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="projectPath">
|
|
Override the default Project's Path.
|
|
</param>
|
|
<returns>
|
|
A new object implementing the <see cref="T:RSG.Configuration.Portal.IPortalConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.LoadXML(RSG.Configuration.IProject,System.String)">
|
|
<summary>
|
|
Load Portal configuration from a file.
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="filename">
|
|
Filename.
|
|
</param>
|
|
<returns>
|
|
A new object implementing the <see cref="T:RSG.Configuration.Portal.IPortalConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.GetPortalUri">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.GetPortalProjectUri">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.GetPortalAutomationUri">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.GetPortalAutomationUri(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.GetPortalAutomationUri(System.String,System.Guid)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.GetPortalAutomationStatusUri(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.GetPortalAutomationMonitorUri(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.GetPortalAutomationMonitorStatusServerUri">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.GetPortalAutomationMatrixUri(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.GetPortalAutomationAdminActionServerUri(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.GetPortalGameBuildVersionsUri">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.GetPortalToolsVersionsUri">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.GetPortalUlogUri">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.GetPortalUlogUri(System.String,System.Guid,System.Boolean)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.GetPortalUlogDownloadUri">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalConfig.GetPortalUlogDownloadUri(System.String,System.Guid)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Portal.PortalExternalLinkConfig">
|
|
<summary>
|
|
Portal External Links configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalExternalLinkConfig.Name">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalExternalLinkConfig.URI">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalExternalLinkConfig.Load(RSG.Configuration.IProject,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Load Portal Shortcut Menu Item configuration from an XML element.
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<returns>
|
|
A new instance of the <see cref="T:RSG.Configuration.Portal.PortalExternalLinkConfig"/> class.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Portal.PortalShortcutMenuItemConfig">
|
|
<summary>
|
|
Automation Service configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalShortcutMenuItemConfig.Name">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalShortcutMenuItemConfig.Guid">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalShortcutMenuItemConfig.Load(RSG.Configuration.IProject,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Load Portal Shortcut Menu Item configuration from an XML element.
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<returns>
|
|
A new instance of the <see cref="T:RSG.Configuration.Portal.PortalShortcutMenuItemConfig"/> class.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Portal.PortalStatisticServerConfig">
|
|
<summary>
|
|
Portal Statistic Server configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalStatisticServerConfig.Name">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Portal.PortalStatisticServerConfig.WebHost">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Portal.PortalStatisticServerConfig.Load(RSG.Configuration.IProject,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Load Portal Statistic Server configuration from an XML element.
|
|
</summary>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
<returns>
|
|
A new instance of the <see cref="T:RSG.Configuration.Portal.PortalStatisticServerConfig"/> class.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.ConfigReaderSettings">
|
|
<summary>
|
|
Class containing settings to use when reading config data.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigReaderSettings._environment">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.ConfigReaderSettings.Environment"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigReaderSettings.#ctor(RSG.Base.IEnvironment)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.ConfigReaderSettings"/> class using
|
|
the specified environment.
|
|
</summary>
|
|
<param name="environment">
|
|
<see cref="T:RSG.Base.IEnvironment"/> object.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ConfigReaderSettings.Environment">
|
|
<summary>
|
|
Gets the environment to use when loading data.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.StudioIconCollection">
|
|
<summary>
|
|
Collection of display icons for a studio.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.StudioIconCollection._studioIconCollection">
|
|
<summary>
|
|
Dictionary of icons
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.StudioIconCollection._log">
|
|
<summary>
|
|
Reference to log object
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.StudioIconCollection._studioName">
|
|
<summary>
|
|
This studio's name
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.StudioIconCollection.#ctor(RSG.Base.Logging.ILog,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.StudioIconCollection"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="studioName">
|
|
Studio name.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.StudioIconCollection.Item(RSG.Configuration.StudioImageSize)">
|
|
<summary>
|
|
Index an icon by requested image size.
|
|
</summary>
|
|
<param name="size">
|
|
<see cref="T:RSG.Configuration.StudioImageSize"/> if the icon to return.
|
|
</param>
|
|
<returns>
|
|
<see cref="T:System.Windows.Media.Imaging.BitmapSource"/> icon.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.StudioIconCollection.EnsureLoaded(RSG.Base.Logging.ILog,System.String,RSG.Configuration.StudioImageSize)">
|
|
<summary>
|
|
Ensures that the specified image source is loaded with the specified resource name.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="studioName">
|
|
Name of the studio.
|
|
</param>
|
|
<param name="imgSize">
|
|
Enumeration to get associated icon.
|
|
</param>
|
|
<returns>
|
|
<see cref="T:System.Windows.Media.Imaging.BitmapSource"/> icon.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.RockstarApplication">
|
|
<summary>
|
|
Describes a rockstar tools application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.AnimationToolkit">
|
|
<summary>
|
|
Animation Toolkit application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.AnimSceneEditor">
|
|
<summary>
|
|
Animation Scene Editor application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.ApplicationLauncher">
|
|
<summary>
|
|
Application Launcher application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.AssetBrowser">
|
|
<summary>
|
|
Asset Browser application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.AutomationMonitor">
|
|
<summary>
|
|
Automation Monitor application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.BuildManager">
|
|
<summary>
|
|
Build Manager application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.CharacterRollover">
|
|
<summary>
|
|
Character Rollover Tool application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.ClipEditor">
|
|
<summary>
|
|
Animation Clip Editor application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.ContentTreeWizard">
|
|
<summary>
|
|
Content-Tree Wizard application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.DialogueStar">
|
|
<summary>
|
|
DialogueStar application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.GameLauncher">
|
|
<summary>
|
|
Game Launcher application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.HashComputer">
|
|
<summary>
|
|
Hash Computer application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.Installer">
|
|
<summary>
|
|
Tools Installer application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.LogHistory">
|
|
<summary>
|
|
Log History application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.MapEditor">
|
|
<summary>
|
|
Map Editor application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.MapViewer">
|
|
<summary>
|
|
Map Viewer application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.MeshViewer">
|
|
<summary>
|
|
Mesh Viewer application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.MaterialToolkit">
|
|
<summary>
|
|
Material Toolkit application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.MetadataEditor">
|
|
<summary>
|
|
Metadata Editor application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.ParentTXDEditor">
|
|
<summary>
|
|
Parent Texture Dictionary Editor application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.PBRTool">
|
|
<summary>
|
|
PBR Texture Editor application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.PlayMission">
|
|
<summary>
|
|
Application that invokes mission URLs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.PlayAnimation">
|
|
<summary>
|
|
Application that invokes animation URLs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.PlayCutscene">
|
|
<summary>
|
|
Application that invokes cutscene URLs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.Rag">
|
|
<summary>
|
|
RAG application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.ResourceViewer">
|
|
<summary>
|
|
Resource Viewer application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.RpfComparer">
|
|
<summary>
|
|
RPF Compare application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.RpfViewer">
|
|
<summary>
|
|
RPF Viewer application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.ShortcutMenu">
|
|
<summary>
|
|
Windows System Tray Shortcut Menu application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.SysTray">
|
|
<summary>
|
|
Windows System Tray Game File server application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.TargetManager">
|
|
<summary>
|
|
Console and PC Target Manager application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.Teleport">
|
|
<summary>
|
|
Application that invokes teleport URLs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.ToolsService">
|
|
<summary>
|
|
Tools Service application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.UniversalLogViewer">
|
|
<summary>
|
|
Universal Log Viewer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.UserPermissionsEditor">
|
|
<summary>
|
|
User Permissions Editor.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.VaultVisualClient">
|
|
<summary>
|
|
Vault Visual Client application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.MaxDLCWizard">
|
|
<summary>
|
|
MaxDLCWizard
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.RagebuilderUnitTests">
|
|
<summary>
|
|
Ragebuilder Unit Tests
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.DLCContentPackWizard">
|
|
<summary>
|
|
DLC Content Pack Wizard application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.RockstarApplication.MaterialPresetEditor">
|
|
<summary>
|
|
Material Preset Editor application.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Attributes.ConfigurationConstantAttribute">
|
|
<summary>
|
|
Attribute that provides a way of tagging enums with String constants
|
|
that appear in the configuration data XML.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Attributes.ConfigurationConstantAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Attributes.ConfigurationConstantAttribute"/> class.
|
|
</summary>
|
|
<param name="constant">
|
|
Constant value.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Attributes.ConfigurationConstantAttribute.Constant">
|
|
<summary>
|
|
Gets the value constant.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Attributes.ConfigurationConstantAttribute.GetEnumValueFromString``1(System.String,``0)">
|
|
<summary>
|
|
Return an enum value for the specified String; assuming the enum
|
|
values are decorated with the <see cref="T:RSG.Configuration.Attributes.ConfigurationConstantAttribute"/> attribute.
|
|
</summary>
|
|
<typeparam name="T">
|
|
Enum type.
|
|
</typeparam>
|
|
<param name="input">
|
|
String constant.
|
|
</param>
|
|
<param name="defaultValue">
|
|
Fallback default.
|
|
</param>
|
|
<returns>
|
|
Enum value.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Bugstar.BugstarConfig">
|
|
<summary>
|
|
Bugstar configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Bugstar.BugstarConfig._attachmentService">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Bugstar.BugstarConfig.AttachmentService"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Bugstar.BugstarConfig._authenticationService">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Bugstar.BugstarConfig.AuthenticationService"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Bugstar.BugstarConfig._externalUserDomain">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Bugstar.BugstarConfig.ExternalDomain"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Bugstar.BugstarConfig._logDirectories">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Bugstar.BugstarConfig.LogDirectories"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Bugstar.BugstarConfig._projectId">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Bugstar.BugstarConfig.ProjectId"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Bugstar.BugstarConfig._projectName">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Bugstar.BugstarConfig.ProjectName"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Bugstar.BugstarConfig._readOnlyUsername">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Bugstar.BugstarConfig.ReadOnlyUsername"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Bugstar.BugstarConfig._readOnlyPassword">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Bugstar.BugstarConfig.ReadOnlyPassword"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Bugstar.BugstarConfig._restService">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Bugstar.BugstarConfig.RESTService"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Bugstar.BugstarConfig._userDomain">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Configuration.Bugstar.BugstarConfig.UserDomain"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.BugstarConfig.AttachmentService">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.BugstarConfig.AuthenticationService">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.BugstarConfig.CookieTimeout">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.BugstarConfig.ExternalDomain">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.BugstarConfig.LogDirectories">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.BugstarConfig.ProjectId">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.BugstarConfig.ProjectName">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.BugstarConfig.ReadOnlyUsername">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.BugstarConfig.ReadOnlyPassword">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.BugstarConfig.RESTService">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.BugstarConfig.UserDomain">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Bugstar.IBugstarConfig">
|
|
<summary>
|
|
Bugstar configuration interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.IBugstarConfig.AttachmentService">
|
|
<summary>
|
|
Gets the Uri to use when querying Bugstar for attachment information.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.IBugstarConfig.AuthenticationService">
|
|
<summary>
|
|
Gets the Uri to use when authenticating user credentials against Bugstar.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.IBugstarConfig.CookieTimeout">
|
|
<summary>
|
|
Gets the timeout duration of the authentication cookie in milliseconds.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.IBugstarConfig.ExternalDomain">
|
|
<summary>
|
|
Gets the user domain to use when authenticating against Bugstar for non-Rockstar users (e.g. service
|
|
accounts, Technicolor, etc...).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.IBugstarConfig.LogDirectories">
|
|
<summary>
|
|
Gets the path to the directories in which Bugstar keeps it's logs.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.IBugstarConfig.ProjectId">
|
|
<summary>
|
|
Gets the Bugstar Project identifier.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.IBugstarConfig.ProjectName">
|
|
<summary>
|
|
Gets the Bugstar project name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.IBugstarConfig.ReadOnlyUsername">
|
|
<summary>
|
|
Gets the username of a read-only account.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.IBugstarConfig.ReadOnlyPassword">
|
|
<summary>
|
|
Gets the password of a read-only account.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.IBugstarConfig.RESTService">
|
|
<summary>
|
|
Gets the Uri to use when querying the Bugstar REST services.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Bugstar.IBugstarConfig.UserDomain">
|
|
<summary>
|
|
Gets the user domain to use when authenticating against Bugstar.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.CommandOptions">
|
|
<summary>
|
|
Command-line options service; handles parsing common command line
|
|
options that are supported throughout the pipeline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.CommandOptions.OptionAutomationBranch">
|
|
<summary>
|
|
Enables external knowledge of the option for setting automation branch.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.CommandOptions.defaultArgumentConstants">
|
|
<summary>
|
|
Default option arguments; merged with your own array if your
|
|
handling options.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.CommandOptions.#ctor(System.String[],RSG.Base.OS.LongOption[],System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.CommandOptions"/> class.
|
|
</summary>
|
|
<param name="arguments">
|
|
String array arguments from command-line.
|
|
</param>
|
|
<param name="options">
|
|
Options array.
|
|
</param>
|
|
<param name="throwIfArgNotSupported">
|
|
Flag indicating whether we should throw if any of the supplied args aren't
|
|
valid.
|
|
</param>
|
|
<param name="addDefaultArgs">
|
|
Value indicating whether we should add the default args to the list of options.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.CommandOptions.#ctor(RSG.Configuration.IConfig,System.String[],RSG.Base.OS.LongOption[],System.Boolean)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.CommandOptions"/> class. This is
|
|
primarily used by the Installer application.
|
|
</summary>
|
|
<param name="config">
|
|
Parent <see cref="T:RSG.Configuration.IConfig"/> object.
|
|
</param>
|
|
<param name="arguments">
|
|
String array arguments from command-line.
|
|
</param>
|
|
<param name="options">
|
|
Options array.
|
|
</param>
|
|
<param name="throwIfArgNotSupported">
|
|
Flag indicating whether we should throw if any of the supplied args aren't
|
|
valid.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.CommandOptions.DefaultArguments">
|
|
<summary>
|
|
Gets the default option arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.CommandOptions.Config">
|
|
<summary>
|
|
Gets the core configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.CommandOptions.CoreProject">
|
|
<summary>
|
|
Gets the active core project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.CommandOptions.Project">
|
|
<summary>
|
|
Gets the active project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.CommandOptions.Branch">
|
|
<summary>
|
|
Gets the active branch.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.CommandOptions.ShowHelp">
|
|
<summary>
|
|
Gets a value indicating whether the user specified the help option.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.CommandOptions.NoPopups">
|
|
<summary>
|
|
Gets or sets a value indicating whether the user specified the nopopups options.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.CommandOptions.Verbose">
|
|
<summary>
|
|
Gets a value indicating whether the user specified verbose log output
|
|
(enables debug log messages in release builds).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.CommandOptions.TrailingArguments">
|
|
<summary>
|
|
Gets the trailing string arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.CommandOptions.Item(System.String)">
|
|
<summary>
|
|
Return option value.
|
|
</summary>
|
|
<param name="opt">
|
|
Option string.
|
|
</param>
|
|
<returns>
|
|
Option value.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.CommandOptions.ContainsOption(System.String)">
|
|
<summary>
|
|
Return whether we contain a specified option.
|
|
</summary>
|
|
<param name="opt">
|
|
Option string.
|
|
</param>
|
|
<returns>
|
|
Option value.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.CommandOptions.GetCurrentOptions">
|
|
<summary>
|
|
Return all the options set
|
|
</summary>
|
|
<returns>
|
|
Dictionary of all the options provided
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.CommandOptions.ShowCurrentlyInUseOptions">
|
|
<summary>
|
|
Return all the options set
|
|
</summary>
|
|
<returns>
|
|
Enumerable of all the options
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.CommandOptions.GetUsage">
|
|
<summary>
|
|
Return usage string from our command options parser.
|
|
</summary>
|
|
<returns>
|
|
Usage string.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.CommandOptions.GetUsage(System.String,System.String)">
|
|
<summary>
|
|
Return usage string from our command options parser (with trailing
|
|
argument description).
|
|
</summary>
|
|
<param name="trailingArgName">
|
|
Trailing argument name (e.g. "files").
|
|
</param>
|
|
<param name="trailingArgDescription">
|
|
Trailing argument description.
|
|
</param>
|
|
<returns>
|
|
Usage string for help display.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.CommandOptions.RegisterTrailingArguments(RSG.Base.OS.TrailingArgument[])">
|
|
<summary>
|
|
Register trailing arguments usage information.
|
|
</summary>
|
|
<param name="trailingArgument">
|
|
Trailing arguments definition.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.CommandOptions.Init(System.String[],RSG.Base.OS.LongOption[],System.Boolean,System.Boolean)">
|
|
<summary>
|
|
One off initialisation.
|
|
</summary>
|
|
<param name="arguments">
|
|
String array arguments from command-line.
|
|
</param>
|
|
<param name="options">
|
|
Options array.
|
|
</param>
|
|
<param name="throwIfArgNotSupported">
|
|
Flag indicating whether we should throw if any of the supplied args aren't
|
|
valid.
|
|
</param>
|
|
<param name="addDefaultArgs">
|
|
Value indicating whether we should add the default args to the list of options.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.CommandOptions.Setup(RSG.Configuration.IConfig)">
|
|
<summary>
|
|
Setup; creating configuration object and setting core project etc.
|
|
with overridden config object.
|
|
</summary>
|
|
<param name="config">
|
|
Parent <see cref="T:RSG.Configuration.IConfig"/> object.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.ConfigFactory">
|
|
<summary>
|
|
Factory class to create our various configuration objects.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigFactory.LogContext">
|
|
<summary>
|
|
Log context string.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.#cctor">
|
|
<summary>
|
|
Static constructor; used to register Exception class formatters.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreateConfig(RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Create core tools configuration data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<returns>
|
|
A new <see cref="T:RSG.Configuration.IConfig"/> object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreateConfig(RSG.Base.Logging.ILog,RSG.Configuration.IToolsConfig)">
|
|
<summary>
|
|
Create core tools configuration data using the specified <see cref="T:RSG.Configuration.IToolsConfig"/> information.
|
|
</summary>
|
|
<param name="log">
|
|
Logging object.
|
|
</param>
|
|
<param name="toolsConfig">
|
|
The basic tools configuration data.
|
|
</param>
|
|
<returns>
|
|
A new instance of an object which implements <see cref="T:RSG.Configuration.IConfig"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreateWritableConfig(RSG.Base.Logging.ILog,System.String)">
|
|
<summary>
|
|
Create writable core tools/project configuration data. ONLY TO BE
|
|
USED BY THE INSTALLER.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="toolsRoot">
|
|
Override the tools root directory.
|
|
</param>
|
|
<returns>
|
|
A new instance of an object that implements the <see cref="T:RSG.Configuration.Installer.IWritableConfig"/>
|
|
interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreateLevelConfig(RSG.Base.Logging.ILog,RSG.Configuration.IBranch)">
|
|
<summary>
|
|
Create level configuration data (and specify default).
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="branch">
|
|
The branch to create the level configuration for.
|
|
</param>
|
|
<returns>
|
|
The level configuration data.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreateIgnoredConnectionSourcesConfig(RSG.Base.Logging.ILog,RSG.Configuration.IConfig)">
|
|
<summary>
|
|
Create ignored connection srouces configuration data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="config">
|
|
The root level config data to use.
|
|
</param>
|
|
<returns>
|
|
The level configuration data.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreateApplicationConfig(RSG.Base.Logging.ILog,RSG.Configuration.IProject)">
|
|
<summary>
|
|
Create application configuration data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="project">
|
|
Associated <see cref="T:RSG.Configuration.IProject"/>.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.IApplicationCollection"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreateExportConfig(RSG.Base.Logging.ILog,RSG.Configuration.IProject,RSG.Configuration.Export.ExportConfigType)">
|
|
<summary>
|
|
Create export configuration data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="project">
|
|
Associated <see cref="T:RSG.Configuration.IProject"/>.
|
|
</param>
|
|
<param name="types">
|
|
<see cref="T:RSG.Configuration.Export.ExportConfigType"/> flags to load.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Export.IExportConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreatePortalConfig(RSG.Base.Logging.ILog,RSG.Configuration.IProject,System.String)">
|
|
<summary>
|
|
Create portal configuration data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="project">
|
|
Associated <see cref="T:RSG.Configuration.IProject"/>.
|
|
</param>
|
|
<param name="projectPath">
|
|
Path to the project (optional).
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Portal.IPortalConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreateAutomationServicesConfig(RSG.Base.ITypedServiceProvider,RSG.Base.Logging.ILog,RSG.Configuration.IProject)">
|
|
<summary>
|
|
Create Automation Service configuration data for project.
|
|
</summary>
|
|
<param name="serviceProvider">
|
|
Application <see cref="T:RSG.Base.ITypedServiceProvider"/>.
|
|
</param>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="project">
|
|
Associated <see cref="T:RSG.Configuration.IProject"/>.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Bugstar.IBugstarConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreateAutomationServicesConfig(RSG.Base.Logging.ILog,RSG.Configuration.IProject,System.String)">
|
|
<summary>
|
|
Create Automation Service configuration data for project.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="project">
|
|
Associated <see cref="T:RSG.Configuration.IProject"/>.
|
|
</param>
|
|
<param name="automationServicesFilename">
|
|
Automation services filename to load.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Bugstar.IBugstarConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreateAutomationServicesConfigs(RSG.Base.Logging.ILog,RSG.Configuration.IProject)">
|
|
<summary>
|
|
Create Automation configs
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="project">
|
|
Associated <see cref="T:RSG.Configuration.IProject"/>.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Automation.IAutomationServiceConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreateAutomationConfigs(RSG.Base.Logging.ILog,RSG.Configuration.IProject)">
|
|
<summary>
|
|
Create Automation configs
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="project">
|
|
Associated <see cref="T:RSG.Configuration.IProject"/>.
|
|
</param>
|
|
<returns>
|
|
A set of objects that implements the <see cref="T:RSG.Configuration.IAutomationConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreateBugstarConfig(RSG.Base.Logging.ILog,RSG.Configuration.IProject)">
|
|
<summary>
|
|
Create Bugstar configuration data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="project">
|
|
Associated <see cref="T:RSG.Configuration.IProject"/>.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Bugstar.IBugstarConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreateInstallerConfig(RSG.Base.Logging.ILog,RSG.Configuration.IProject)">
|
|
<summary>
|
|
Create installer configuration data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="project">
|
|
Associated <see cref="T:RSG.Configuration.IProject"/>.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Installer.IInstallerConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreatePortConfig(RSG.Base.Logging.ILog,RSG.Configuration.IProject)">
|
|
<summary>
|
|
Creates port configuration data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="project">
|
|
Associated <see cref="T:RSG.Configuration.IProject"/>.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Ports.IPortConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.LoadCoreProjectSummaries(RSG.Base.Logging.ILog,RSG.Base.IEnvironment)">
|
|
<summary>
|
|
Load Core Project summaries; defines summary data for all available
|
|
main projects within the tool set.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="environment">
|
|
<see cref="T:RSG.Base.IEnvironment"/> object for context.
|
|
</param>
|
|
<returns>
|
|
A set of new objects that implements the <see cref="T:RSG.Configuration.IProjectSummaryCore"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.LoadCoreProjectContentPackSummaries(RSG.Base.Logging.ILog,RSG.Base.IEnvironment,System.String)">
|
|
<summary>
|
|
Load Content-Pack project summaries; defines summary data for all
|
|
available content-pack projects within a core project.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="environment">
|
|
<see cref="T:RSG.Base.IEnvironment"/> object for context.
|
|
</param>
|
|
<param name="contentPacksFilename">
|
|
Content-Packs Configuration filename to load.
|
|
</param>
|
|
<returns>
|
|
A set of new objects that implements the <see cref="T:RSG.Configuration.IProjectSummaryCore"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreateHubConfig(RSG.Base.Logging.ILog,RSG.Configuration.IConfig)">
|
|
<summary>
|
|
Creates the hub configuration data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="config">
|
|
The main config object.
|
|
</param>
|
|
<returns>
|
|
The hub configuration data.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.CreateEnvironment(RSG.Configuration.ICanImportEnvironment)">
|
|
<summary>
|
|
Create environment object.
|
|
</summary>
|
|
<param name="config">
|
|
<see cref="T:RSG.Configuration.IConfig"/> object object to initialise environment with.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Base.IEnvironment"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.ConfigurationExceptionFormatter(System.Exception)">
|
|
<summary>
|
|
Custom formatter for configuration exceptions.
|
|
</summary>
|
|
<param name="ex">Exception to format.</param>
|
|
<returns>
|
|
Exception formatted set of string.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigFactory.ConfigurationVersionExceptionFormatter(System.Exception)">
|
|
<summary>
|
|
Custom formatter for configuration exceptions.
|
|
</summary>
|
|
<param name="ex">Exception to format.</param>
|
|
<returns>
|
|
Exception formatted set of string.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.ConfigurationException">
|
|
<summary>
|
|
Tools Configuration Exception class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigurationException.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.ConfigurationException"/> class.
|
|
</summary>
|
|
<param name="message">
|
|
Exception message.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigurationException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.ConfigurationException"/> class.
|
|
</summary>
|
|
<param name="message">
|
|
Exception message.
|
|
</param>
|
|
<param name="inner">
|
|
Inner exception object.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigurationException.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.ConfigurationException"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ConfigurationException.Filename">
|
|
<summary>
|
|
Gets or sets the file that generated the exception.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ConfigurationException.ConfigurationMessageCode">
|
|
<summary>
|
|
Gets or sets the configuration message code, if applicable for this exception.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.ConfigurationFormatException">
|
|
<summary>
|
|
Tools Configuration Format Exception class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigurationFormatException.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.ConfigurationFormatException"/> class.
|
|
</summary>
|
|
<param name="message">
|
|
Exception message.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigurationFormatException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.ConfigurationFormatException"/> class.
|
|
</summary>
|
|
<param name="message">
|
|
Exception message.
|
|
</param>
|
|
<param name="inner">
|
|
Inner exception object.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.ConfigurationVersionException">
|
|
<summary>
|
|
Tools Configuration Version Exception class.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationVersionException._actualVersion">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.ConfigurationVersionException.ActualVersion"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ConfigurationVersionException._expectedVersion">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.ConfigurationVersionException.ExpectedVersion"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ConfigurationVersionException.#ctor(System.Int32,System.Int32)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.ConfigurationVersionException"/> class.
|
|
</summary>
|
|
<param name="actual">
|
|
Actual version.
|
|
</param>
|
|
<param name="expected">
|
|
Expected version.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ConfigurationVersionException.ExpectedVersion">
|
|
<summary>
|
|
Gets the expected version identifier.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ConfigurationVersionException.ActualVersion">
|
|
<summary>
|
|
Gets the actual version identifier.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.EnvironmentException">
|
|
<summary>
|
|
Tools Environment Exception class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.EnvironmentException.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.EnvironmentException"/> class.
|
|
</summary>
|
|
<param name="message">
|
|
Exception message.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.EnvironmentException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.EnvironmentException"/> class.
|
|
</summary>
|
|
<param name="message">
|
|
Exception message.
|
|
</param>
|
|
<param name="inner">
|
|
Inner exception.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.EnvironmentException.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.EnvironmentException"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IApplication">
|
|
<summary>
|
|
Represents a single Rockstar tools application.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplication.Bootstrapped">
|
|
<summary>
|
|
Gets a value indicating whether this application is bootstrapped
|
|
and handles modifications to its binaries when running.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplication.BugstarComponentId">
|
|
<summary>
|
|
Gets the Bugstar component id to use for this application when logging bugs.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplication.FeedLink">
|
|
<summary>
|
|
Gets the links to Hub feed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplication.DaysToShowNewNews">
|
|
<summary>
|
|
Gets the number of days since publication data to show the added News as 'NEW'
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplication.HelpLink">
|
|
<summary>
|
|
Gets the link to help page for application. Value can be null.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplication.CreateShortcut">
|
|
<summary>
|
|
Gets a value indicating whether this application should appear in the start menu and
|
|
the tools shortcut menu.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplication.DefaultArguments">
|
|
<summary>
|
|
Gets the default arguments to use when launching the executable.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplication.DefaultBugOwner">
|
|
<summary>
|
|
Gets the default bug owner for this application.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplication.ExecutablePath">
|
|
<summary>
|
|
Gets the path to the executable.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplication.Name">
|
|
<summary>
|
|
Gets the name of the application.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplication.PackageName">
|
|
<summary>
|
|
Gets the name of the packaged version of this app, if it exists.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplication.ShutdownRequired">
|
|
<summary>
|
|
Gets a value indicating whether this application needs to be shutdown when
|
|
performing operations such as syncing or installing a new project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplication.StartMenuFolderPath">
|
|
<summary>
|
|
Gets the start menu folder path (excluding the start menu path)
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplication.UrlProtocols">
|
|
<summary>
|
|
Gets the URL protocols that this application handles.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplication.FileExtensions">
|
|
<summary>
|
|
Gets the extensions that this application handles.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplication.IsInstanceRunning">
|
|
<summary>
|
|
Determines whether an instance of the application is already running.
|
|
</summary>
|
|
<returns>
|
|
True if an instance of the application is running, otherwise false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplication.IsInstanceRunningInProject">
|
|
<summary>
|
|
Determines whether an instance of the application is already running on the installed project.
|
|
</summary>
|
|
<returns>
|
|
True if an instance of the application is running, otherwise false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplication.LaunchApplication">
|
|
<summary>
|
|
Launches the application.
|
|
</summary>
|
|
<returns>
|
|
The process object corresponding to the launched application.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplication.LaunchApplication(System.String)">
|
|
<summary>
|
|
Launches the application using the specified arguments.
|
|
</summary>
|
|
<param name="arguments">
|
|
The arguments to use when launching the application.
|
|
</param>
|
|
<returns>
|
|
The process object corresponding to the launched application.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplication.LaunchApplication(System.Diagnostics.ProcessStartInfo)">
|
|
<summary>
|
|
Launches the application using the specified process start info.
|
|
</summary>
|
|
<param name="startInfo">
|
|
The process start information to use when launching the application.
|
|
</param>
|
|
<returns>
|
|
The process object corresponding to the launched application.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplication.KillRunningInstances(RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Attempts to force stop any running application instances.
|
|
</summary>
|
|
<param name="log">
|
|
The log object to use when killing the running instances.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplication.KillRunningInstancesInProject(RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Attempts to force stop any running application instances from the installed project.
|
|
</summary>
|
|
<param name="log">
|
|
The log object to use when killing the running instances.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplication.CloseRunningInstances(RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Attempts to close any running application instances.
|
|
</summary>
|
|
<param name="log">
|
|
The log object to use when closing the running instances.
|
|
</param>
|
|
<returns>
|
|
True if no instances are running or all received the close message successfully.
|
|
False if failed.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplication.CloseRunningInstancesInProject(RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Attempts to close any running application instances from the installed project.
|
|
</summary>
|
|
<param name="log">
|
|
The log object to use when closing the running instances.
|
|
</param>
|
|
<returns>
|
|
True if no instances are running or all received the close message successfully.
|
|
False if failed.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplication.LaunchApplicationWithCommand(System.String,System.String)">
|
|
<summary>
|
|
Launch application for the given filepath, and given shell command.
|
|
</summary>
|
|
<param name="filePath">Filepath with valid extension that can be opened with application.</param>
|
|
<param name="command">Shell command to use to open file</param>
|
|
<returns>
|
|
<see cref="T:System.Diagnostics.Process"/> object representing the application instance.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplication.CanOpenExtensionWithCommand(System.String,System.String)">
|
|
<summary>
|
|
Reports if the application can open the specified extension, with the specified shell command.
|
|
</summary>
|
|
<param name="extension">Extension (including '.') to open.</param>
|
|
<param name="command">Shell command to use ('Open' for example)</param>
|
|
<returns>True if this instance can open a file with the given extension.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplication.CanOpenExtension(System.String)">
|
|
<summary>
|
|
Reports if the application can open the specified extension, with the specified shell command.
|
|
</summary>
|
|
<param name="extension">Extension (including '.') to open.</param>
|
|
<returns>True if this instance can open a file with the given extension.</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IApplicationCollection">
|
|
<summary>
|
|
Represents a collection of tools applications.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplicationCollection.Item(System.String)">
|
|
<summary>
|
|
Gets an application based on it's name.
|
|
</summary>
|
|
<param name="name">
|
|
Application name.
|
|
</param>
|
|
<returns>
|
|
Application object.
|
|
</returns>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IApplicationCollection.Item(RSG.Configuration.RockstarApplication)">
|
|
<summary>
|
|
Gets an application based on it's id.
|
|
</summary>
|
|
<param name="id">
|
|
Application identifier.
|
|
</param>
|
|
<returns>
|
|
Application object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplicationCollection.ContainsApplication(System.String)">
|
|
<summary>
|
|
Determines whether the collection contains the specific application by name.
|
|
</summary>
|
|
<param name="name">
|
|
Application name.
|
|
</param>
|
|
<returns>
|
|
true if the application is found; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplicationCollection.ContainsApplication(RSG.Configuration.RockstarApplication)">
|
|
<summary>
|
|
Determines whether the collection contains the specific application id.
|
|
</summary>
|
|
<param name="id">
|
|
Application identifier.
|
|
</param>
|
|
<returns>
|
|
true if the application is found; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplicationCollection.TryGetApplication(System.String,RSG.Configuration.IApplication@)">
|
|
<summary>
|
|
Attempts to get the value associated with the specified application id returning
|
|
the success of the operation.
|
|
</summary>
|
|
<param name="name">
|
|
Application name.
|
|
</param>
|
|
<param name="application">
|
|
Application data.
|
|
</param>
|
|
<returns>
|
|
true if application data found; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplicationCollection.TryGetApplication(RSG.Configuration.RockstarApplication,RSG.Configuration.IApplication@)">
|
|
<summary>
|
|
Attempts to get the value associated with the specified application id returning
|
|
the success of the operation.
|
|
</summary>
|
|
<param name="id">
|
|
Application identifier.
|
|
</param>
|
|
<param name="application">
|
|
Application data.
|
|
</param>
|
|
<returns>
|
|
true if application data found; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplicationCollection.GetApplicationToExcuteCommand(System.String,System.String)">
|
|
<summary>
|
|
Get application to execute extension with the given shell command
|
|
</summary>
|
|
<param name="extension">Extension to open.</param>
|
|
<param name="command">Shell command to use.</param>
|
|
<returns>Returns <see cref="T:RSG.Configuration.IApplication"/> if an application is found. Null if no application is found to open the extension.</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IApplicationCollection.GetApplicationToOpenExtension(System.String)">
|
|
<summary>
|
|
Get an application to execute the given extension.
|
|
</summary>
|
|
<param name="extension">Extension of file to open.</param>
|
|
<returns>Returns <see cref="T:RSG.Configuration.IApplication"/> if an application is found. Null if no application is found to open the extension.</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IAssetPrefix">
|
|
<summary>
|
|
Asset prefixes for the pipeline and all tools.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IAssetPrefix.MapPrefix">
|
|
<summary>
|
|
Gets the prefix for map assets (used to ensure DLC map changes have unique names).
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IBranch">
|
|
<summary>
|
|
Branch encapsulation; representing a project branch defining a set of
|
|
paths and targets.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Project">
|
|
<summary>
|
|
Gets the project container for this Branch object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Name">
|
|
<summary>
|
|
Gets the branch name ("dev", "release" etc).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Locked">
|
|
<summary>
|
|
Gets a value indicating whether the branch is locked (e.g. flagged after branch is released or locked for future edits).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Art">
|
|
<summary>
|
|
Gets the art root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Anim">
|
|
<summary>
|
|
Gets the anim root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Assets">
|
|
<summary>
|
|
Gets the assets root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.AutomationArtefacts">
|
|
<summary>
|
|
Gets the automation Artefacts root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Content">
|
|
<summary>
|
|
Gets the root content-tree filename for this branch.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Export">
|
|
<summary>
|
|
Gets the export root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Source">
|
|
<summary>
|
|
Gets the source root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Processed">
|
|
<summary>
|
|
Gets the processed root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Metadata">
|
|
<summary>
|
|
Gets the metadata root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Definitions">
|
|
<summary>
|
|
Gets the definitions root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Audio">
|
|
<summary>
|
|
Gets the audio root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Build">
|
|
<summary>
|
|
Gets the build root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Common">
|
|
<summary>
|
|
Gets the common build root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Shaders">
|
|
<summary>
|
|
Gets the shaders build root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Code">
|
|
<summary>
|
|
Gets the code root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.RageCode">
|
|
<summary>
|
|
Gets the RAGE Code root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Resource">
|
|
<summary>
|
|
Gets the resource root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.IndependentResource">
|
|
<summary>
|
|
Gets the resource independent root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.PlatformResource">
|
|
<summary>
|
|
Gets the resource platform root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Preview">
|
|
<summary>
|
|
Gets the preview root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Script">
|
|
<summary>
|
|
Gets the script root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.FragmentTune">
|
|
<summary>
|
|
Gets the fragment tuning root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Text">
|
|
<summary>
|
|
Gets the text export directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.UI">
|
|
<summary>
|
|
Gets the UI root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.VaultAssetsPath">
|
|
<summary>
|
|
Gets the Vault Assets path; this is not a local directory path but a path within
|
|
our virtual filesystem within the Vault Database.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.Targets">
|
|
<summary>
|
|
Gets the <see cref="T:RSG.Configuration.ITarget"/> objects for this Branch.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.PlatformConversionTools">
|
|
<summary>
|
|
Gets the platform conversion tools per-platform (e.g. Ragebuilder).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.BuildLabel">
|
|
<summary>
|
|
Gets the branch build label (optional).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IBranch.RageBuilderCommonArgs">
|
|
<summary>
|
|
Gets the common arguments for Ragebuilder, specified in project.xml
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IBranch.IsRootedPath(System.String,System.String@)">
|
|
<summary>
|
|
Return whether the passed in path is from any of this branch's
|
|
directories.
|
|
</summary>
|
|
<param name="path">
|
|
Input path to determine if this is under any of this branch's
|
|
directories.
|
|
</param>
|
|
<param name="prefix">
|
|
Branch directory that is mnatched is returned.
|
|
</param>
|
|
<returns>
|
|
true if there is a match; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IBranch.IsRootedPath(System.String,System.String)">
|
|
<summary>
|
|
Return whether the passed in filename is from a particular branch's
|
|
prefix directory.
|
|
</summary>
|
|
<param name="prefix">
|
|
Branch directory that is mnatched is returned.
|
|
</param>
|
|
<param name="filename">
|
|
Filename to test.
|
|
</param>
|
|
<returns>
|
|
true if there is a match; false otherwise.</returns>
|
|
<example>
|
|
branch.IsRootedPath(branch.Export, @"x:\file\asset1.txt")
|
|
</example>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IBranch.ParseLocal(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Parse local configuration filename the installer creates. This has
|
|
<see cref="T:RSG.Configuration.ITarget"/> enabled flags for example.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.ICanImportEnvironment">
|
|
<summary>
|
|
Interface to define an object that can import environment data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ICanImportEnvironment.Import(RSG.Base.IEnvironment)">
|
|
<summary>
|
|
Import settings into an IEnvironment object.
|
|
</summary>
|
|
<param name="env">
|
|
Environment object.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IConfig">
|
|
<summary>
|
|
Entry Configuration class for system-wide globals for current tools
|
|
branch. This differs from IConfig to be a completely project-independent
|
|
configuration object.
|
|
</summary>
|
|
<remarks>
|
|
The globals just come from the user-environment. Rather than
|
|
recalculate them here like we used to do.
|
|
|
|
Do not add anything here that is project-specific or that relies on
|
|
other dependencies (e.g. Perforce).
|
|
</remarks>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.ConfigVersion">
|
|
<summary>
|
|
Gets the configuration system version.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.ToolsRootDirectory">
|
|
<summary>
|
|
Gets the tools root directory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.ToolsAutomationDirectory">
|
|
<summary>
|
|
Gets the tools root automation directory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.ToolsBinDirectory">
|
|
<summary>
|
|
Gets the tools binary directory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.ToolsLibDirectory">
|
|
<summary>
|
|
Gets the tools lib directory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.ToolsConfigDirectory">
|
|
<summary>
|
|
Gets the tools configuration data absolute path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.ToolsLogsDirectory">
|
|
<summary>
|
|
Gets the tools log file directory absolute path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.ToolsTempDirectory">
|
|
<summary>
|
|
Gets the tools temporary files absolute path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.ToolsInstaller">
|
|
<summary>
|
|
Gets the absolute path to Tools Installer.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.ToolsQuickInstaller">
|
|
<summary>
|
|
Gets the absolute path to Tools Quick Installer.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.Project">
|
|
<summary>
|
|
Gets the current core project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.Projects">
|
|
<summary>
|
|
Gets the available core projects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.CurrentStudio">
|
|
<summary>
|
|
Gets the current studio.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.Studios">
|
|
<summary>
|
|
Gets the available studio collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.CurrentToolsBranch">
|
|
<summary>
|
|
Gets the current tools branch.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.DefaultEndUserToolsBranch">
|
|
<summary>
|
|
Gets the Project default end-user orientated tools branch. Other tools
|
|
branches are for very special purposes (e.g. dev, or for working
|
|
with a particular branch of the game for some dev work (like SGA)).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.ToolsBranches">
|
|
<summary>
|
|
Gets the available tools branches.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.InstallTime">
|
|
<summary>
|
|
Gets the last install time.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.Username">
|
|
<summary>
|
|
Gets the user's username.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.HostName">
|
|
<summary>
|
|
Gets the host name for running PC.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.EmailAddress">
|
|
<summary>
|
|
Gets the user's email address.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.IsAutomationMachine">
|
|
<summary>
|
|
Gets a value indicating whether the local machine is an automation machine.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.VersionControlEnabled">
|
|
<summary>
|
|
Gets a value indicating whether version control is enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.VersionControlSettings">
|
|
<summary>
|
|
Gets the version control settings for the local user.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfig.Version">
|
|
<summary>
|
|
Gets the tools version information.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IConfig.DetermineBranchForFilenames(System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
For a set of paths determine the project and branch that they
|
|
belong.
|
|
</summary>
|
|
<param name="filenames">
|
|
Input filenames.
|
|
</param>
|
|
<returns>
|
|
Dictionary of filename to <see cref="T:RSG.Configuration.IBranch"/>. The value is
|
|
null if a branch was not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IConfig.Reload(RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Reload all of the configuration data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IConfigFile">
|
|
<summary>
|
|
Interface representing a configuration file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IConfigFile.Filename">
|
|
<summary>
|
|
Gets the absolute filename.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IForceFlags">
|
|
<summary>
|
|
Force flags configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IForceFlags.AllNewContent">
|
|
<summary>
|
|
Gets a value indicating whether all data content is new (e.g. "New DLC" for maps).
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.ILevel">
|
|
<summary>
|
|
A level interface representing a level within a game project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ILevel.Id">
|
|
<summary>
|
|
Gets the unique identifier for this level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ILevel.Name">
|
|
<summary>
|
|
Gets the level key name; added into environment as $(LevelName).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ILevel.FriendlyName">
|
|
<summary>
|
|
Gets the levels friendly name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ILevel.CommonDirectory">
|
|
<summary>
|
|
Gets the levels common directory; added into environment as $(LevelCommonDirectory).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ILevel.ExportDirectory">
|
|
<summary>
|
|
Gets the levels independent export data directory; added into environment as $(LevelExportDirectory).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ILevel.ProcessedDirectory">
|
|
<summary>
|
|
Gets the levels processed data directory; added into environment as $(LevelProcessedDirectory).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ILevel.MetadataFilename">
|
|
<summary>
|
|
Gets the levels game metadata filename describing what assets are loaded.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ILevel.VaultAssetsPath">
|
|
<summary>
|
|
Gets the levels Vault asset path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ILevel.BugstarId">
|
|
<summary>
|
|
Gets the id of the level in bugstar if it hexits; null if it doesn't.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ILevel.BackgroundMaps">
|
|
<summary>
|
|
Gets the list of background maps that can be used for this level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ILevel.MapsSource">
|
|
<summary>
|
|
Gets the source for the map information.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ILevel.VectorMapFile">
|
|
<summary>
|
|
Gets the path to the vector map file for this level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ILevel.IsLevelFile(System.String)">
|
|
<summary>
|
|
Return whether the passed in filename is part of the level.
|
|
</summary>
|
|
<param name="filepath">
|
|
The full path to the file to check.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the file is part of the level; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ILevel.IsLevelFile(System.Collections.Generic.IEnumerable{RSG.Configuration.ITarget},System.String)">
|
|
<summary>
|
|
Return whether the passed in filename is part of the level.
|
|
</summary>
|
|
<param name="target">
|
|
the list of targets to check
|
|
</param>
|
|
<param name="filepath">
|
|
The full path to the file to check.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the file is part of the level; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ILevel.IsLevelVaultAsset(System.String)">
|
|
<summary>
|
|
Return whether the passed in Vault Asset Path is part of the level.
|
|
</summary>
|
|
<param name="vaultAssetPath">
|
|
Absolute path to the Vault Asset.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the file is part of the level; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ILevel.IsLevelVaultAsset(System.Uri)">
|
|
<summary>
|
|
Return whether the passed in Vault Asset Path is part of the level.
|
|
</summary>
|
|
<param name="vaultAssetPath">
|
|
Absolute Uri to the Vault Asset.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the file is part of the level; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.ILevelCollection">
|
|
<summary>
|
|
Represents the levels within a game project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ILevelCollection.Default">
|
|
<summary>
|
|
Gets the default level (set in configuration data).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ILevelCollection.Item(System.Guid)">
|
|
<summary>
|
|
Gets the level by Guid.
|
|
</summary>
|
|
<param name="id">
|
|
Level identifier.
|
|
</param>
|
|
<returns>
|
|
Associated <see cref="T:RSG.Configuration.ILevel"/> object.
|
|
</returns>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ILevelCollection.Item(System.String)">
|
|
<summary>
|
|
Index a level by name.
|
|
</summary>
|
|
<param name="name">
|
|
Level name.
|
|
</param>
|
|
<returns>
|
|
Associated <see cref="T:RSG.Configuration.ILevel"/> object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ILevelCollection.GetLevelForFilename(System.String)">
|
|
<summary>
|
|
Return level for specified filename.
|
|
</summary>
|
|
<param name="filename">
|
|
Filename.
|
|
</param>
|
|
<returns>
|
|
Level for specified filename.
|
|
</returns>
|
|
<exception cref="T:RSG.Configuration.LevelNotFoundException">
|
|
Exception thrown when no associated level is found.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ILevelCollection.GetLevelForFilename(System.Collections.Generic.IEnumerable{RSG.Configuration.ITarget},System.String)">
|
|
<summary>
|
|
Return level for specified filename.
|
|
</summary>
|
|
<param name="targets">
|
|
Set of targets.
|
|
</param>
|
|
<param name="filename">
|
|
Filename
|
|
</param>
|
|
<returns>
|
|
Level for specified filename.
|
|
</returns>
|
|
<exception cref="T:RSG.Configuration.LevelNotFoundException">
|
|
Exception thrown when no associated level is found.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ILevelCollection.GetUniqueLevelForFilenames(System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Return unique level for all files.
|
|
</summary>
|
|
<param name="filenames">
|
|
Filenames.
|
|
</param>
|
|
<returns>
|
|
Unique level for all the filenames.
|
|
</returns>
|
|
<exception cref="T:RSG.Configuration.LevelNotUniqueException">
|
|
Exception raised when all the filenames do not correspond to the same level.
|
|
</exception>
|
|
<exception cref="T:RSG.Configuration.LevelNotFoundException">
|
|
Exception raised when no level is found for the filenames.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ILevelCollection.GetLevelsForFilenames(System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Return distinct set of levels used by specified files.
|
|
</summary>
|
|
<param name="filenames">
|
|
Filenames.
|
|
</param>
|
|
<returns>
|
|
Set of <see cref="T:RSG.Configuration.ILevel"/> objects for the filenames.
|
|
</returns>
|
|
<exception cref="T:RSG.Configuration.LevelNotFoundException">
|
|
Exception raised when no level is found for the filenames.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ILevelCollection.GetLevelForVaultAssetPath(System.String)">
|
|
<summary>
|
|
Return level for a specified Vault Asset Path.
|
|
</summary>
|
|
<param name="vaultAssetPath">
|
|
Vault Asset Path.
|
|
</param>
|
|
<returns>
|
|
Return level for specified Vault Asset Path.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ILevelCollection.GetLevelForVaultAssetPath(RSG.Base.IO.VaultPath)">
|
|
<summary>
|
|
Return level for a specified Vault Asset Path.
|
|
</summary>
|
|
<param name="vaultAssetPath">
|
|
Vault Asset Path.
|
|
</param>
|
|
<returns>
|
|
Return level for specified Vault Asset Path.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ILevelCollection.GetUniqueLevelForVaultAssetPaths(System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Return unqiue level for all specified Vault Asset Path.
|
|
</summary>
|
|
<param name="vaultAssetPaths">
|
|
Vault Asset Paths.
|
|
</param>
|
|
<returns>
|
|
Unqiue level for all specified Vault Asset Path.
|
|
</returns>
|
|
<exception cref="T:RSG.Configuration.LevelNotUniqueException">
|
|
Exception raised when all the Vault Assets do not correspond to the same level.
|
|
</exception>
|
|
<exception cref="T:RSG.Configuration.LevelNotFoundException">
|
|
Exception raised when no level is found for the Vault Assets.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ILevelCollection.GetUniqueLevelForVaultAssetPaths(System.Collections.Generic.IEnumerable{RSG.Base.IO.VaultPath})">
|
|
<summary>
|
|
Return unqiue level for all specified Vault Asset Path.
|
|
</summary>
|
|
<param name="vaultAssetPaths">
|
|
Vault Asset Paths.
|
|
</param>
|
|
<returns>
|
|
Unqiue level for all specified Vault Asset Path.
|
|
</returns>
|
|
<exception cref="T:RSG.Configuration.LevelNotUniqueException">
|
|
Exception raised when all the Vault Assets do not correspond to the same level.
|
|
</exception>
|
|
<exception cref="T:RSG.Configuration.LevelNotFoundException">
|
|
Exception raised when no level is found for the Vault Assets.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ILevelCollection.GetLevelsForVaultAssetPaths(System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Return set of levels for all specified Vault Asset Path.
|
|
</summary>
|
|
<param name="vaultAssetPaths">
|
|
Vault Asset Paths.
|
|
</param>
|
|
<returns>
|
|
Set of levels for all specified Vault Asset Path.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ILevelCollection.GetLevelsForVaultAssetPaths(System.Collections.Generic.IEnumerable{RSG.Base.IO.VaultPath})">
|
|
<summary>
|
|
Return set of levels for all specified Vault Asset Path.
|
|
</summary>
|
|
<param name="vaultAssetPaths">
|
|
Vault Asset Paths.
|
|
</param>
|
|
<returns>
|
|
Set of levels for all specified Vault Asset Path.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ILevelCollection.TryGetLevel(System.Guid,RSG.Configuration.ILevel@)">
|
|
<summary>
|
|
Attempts to get the level associated with the specified guid.
|
|
</summary>
|
|
<param name="id">
|
|
Level identifier.
|
|
</param>
|
|
<param name="level">
|
|
<see cref="T:RSG.Configuration.ILevel"/> object if returns true.
|
|
</param>
|
|
<returns>
|
|
true if successful; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ILevelCollection.TryGetLevel(System.String,RSG.Configuration.ILevel@)">
|
|
<summary>
|
|
Attempts to get the level associated with the specified name.
|
|
</summary>
|
|
<param name="name">
|
|
Level name.
|
|
</param>
|
|
<param name="level">
|
|
<see cref="T:RSG.Configuration.ILevel"/> object if returns true.
|
|
</param>
|
|
<returns>
|
|
true if successful; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IProjectSummaryCore">
|
|
<summary>
|
|
Project summary interface; for reading summary information about
|
|
available projects when the configuration data may not be available.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProjectSummaryCore.ContentPacksConfigurationFilename">
|
|
<summary>
|
|
Gets the Content-Packs configuration filename for this core project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProjectSummaryCore.LocalConfigurationFilename">
|
|
<summary>
|
|
Gets the local configuration filename written by the installer.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IRunline">
|
|
<summary>
|
|
Installer configuration runline interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IRunline.Mode">
|
|
<summary>
|
|
Gets the runline installer mode.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IRunline.Command">
|
|
<summary>
|
|
Gets the command line to execute.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IRunline.CanFail">
|
|
<summary>
|
|
Gets a value indicating whether to continue if the runline fails.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IRunline.RunOnce">
|
|
<summary>
|
|
Gets a value indicating whether this is only a single run.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IRunline.Always">
|
|
<summary>
|
|
Gets a value indicating whether to always run in the installer (irrespective of version).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IRunline.Users">
|
|
<summary>
|
|
Gets the user's mask for this runline.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IRunline.Version">
|
|
<summary>
|
|
Gets the version of config this runline was introduced.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.LevelNotFoundException">
|
|
<summary>
|
|
Exception raised under circumstances when a level is not found for
|
|
a particular query.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.LevelNotFoundException.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.LevelNotFoundException"/> class.
|
|
</summary>
|
|
<param name="levelName">
|
|
Level name.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.LevelNotFoundException.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.LevelNotFoundException"/> class.
|
|
</summary>
|
|
<param name="levelName">
|
|
Level name.
|
|
</param>
|
|
<param name="filename">
|
|
Filename.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.LevelNotFoundException.#ctor(System.String,System.String,System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.LevelNotFoundException"/> class.
|
|
</summary>
|
|
<param name="levelName">
|
|
Level name.
|
|
</param>
|
|
<param name="filename">
|
|
Filename.
|
|
</param>
|
|
<param name="inner">
|
|
Inner exception.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.LevelNotFoundException.LevelName">
|
|
<summary>
|
|
Gets the level name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.LevelNotFoundException.Filename">
|
|
<summary>
|
|
Gets the filename.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.StudioImageSize">
|
|
<summary>
|
|
Studio icon sizes.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.StudioImageSize.Smallest">
|
|
<summary>
|
|
Smallest icon size.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.StudioImageSize.Small">
|
|
<summary>
|
|
Small icon size.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.StudioImageSize.Medium">
|
|
<summary>
|
|
Medium icon size.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.StudioImageSize.Large">
|
|
<summary>
|
|
Large icon size.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.ToolsConfig">
|
|
<summary>
|
|
Class for interacting with the .tools configuration files that specify project
|
|
settings that were previously in environment variables.
|
|
</summary>
|
|
<remarks>
|
|
The .tools configuration files are very similar to P4CONFIG files (in Perforce)
|
|
but that specify our critical tools settings (previously as Environment variables).
|
|
</remarks>
|
|
</member>
|
|
<member name="F:RSG.Configuration.ToolsConfig.ToolsConfigFilename">
|
|
<summary>
|
|
Tools configuration filename.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ToolsConfig.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.ToolsConfig"/> class using the current working directory.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ToolsConfig.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.ToolsConfig"/> class using the specified working directory.
|
|
</summary>
|
|
<param name="workingDirectory">
|
|
The working directory to start looking for the .tools config file from.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ToolsConfig.ToolsRootDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.ToolsConfig.ToolsAutomationDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.ToolsConfig.ToolsBinDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.ToolsConfig.ToolsConfigDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.ToolsConfig.ToolsLogsDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.ToolsConfig.ToolsTempDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.ToolsConfig.ToolsLibDirectory">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.ToolsConfig.FindNearestToolsConfig(System.String)">
|
|
<summary>
|
|
Find the nearest tools configuration file from current directory.
|
|
</summary>
|
|
<param name="workingDirectory">
|
|
Working directory to initialise.
|
|
</param>
|
|
<returns>
|
|
Filename for the nearest .tools file.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ToolsConfig.GetToolsRootFromFilename(System.String)">
|
|
<summary>
|
|
Attempts to extract the tools root from a .tools configuration file.
|
|
</summary>
|
|
<param name="configurationFilename">
|
|
The full path to the .tools file.
|
|
</param>
|
|
<returns>
|
|
The path to tools root if it was found in the config file; otherwise, <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ToolsConfig.GetToolsRootFromEnvironment">
|
|
<summary>
|
|
Initialise our object from System Environment variables (backwards-compatibility).
|
|
</summary>
|
|
<returns>
|
|
Tools root environment variable value.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IProject">
|
|
<summary>
|
|
Project encapsulation; representing a project defining a set of
|
|
branches and targets.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProject.Name">
|
|
<summary>
|
|
Gets the Project name (unique key).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProject.FriendlyName">
|
|
<summary>
|
|
Gets the Project friendly UI name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProject.RootDirectory">
|
|
<summary>
|
|
Gets the Project root directory $(root).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProject.Filename">
|
|
<summary>
|
|
Gets the Project configuration filename.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProject.AutomationDataDirectory">
|
|
<summary>
|
|
Gets the Automation data root directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProject.CacheDirectory">
|
|
<summary>
|
|
Gets the Project cache directory $(cache).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProject.VaultDirectory">
|
|
<summary>
|
|
Gets the Project Vault directory $(vault).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProject.HasLevels">
|
|
<summary>
|
|
Gets a value indicating whether this project has levels.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProject.Config">
|
|
<summary>
|
|
Gets the config parent.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProject.ForceFlags">
|
|
<summary>
|
|
Gets the force flags collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProject.AssetPrefix">
|
|
<summary>
|
|
Gets the asset prefixes collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProject.ToolsEmailAddresses">
|
|
<summary>
|
|
Gets a set of Tools-associated mail addresses (for sending logs and bug reports).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProject.Branches">
|
|
<summary>
|
|
Gets the dictionary of branches for this project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProject.Labels">
|
|
<summary>
|
|
Gets the dictionary of available labels for this project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProject.DefaultPlatforms">
|
|
<summary>
|
|
Gets the set of default platforms, these can be used when the current default branch
|
|
has no active targets in it.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IProject.IsRootedPath(System.String,System.String@)">
|
|
<summary>
|
|
Return whether the passed in path is from any of this branch's
|
|
directories.
|
|
</summary>
|
|
<param name="path">
|
|
Input path to determine if this is under any of this branch's
|
|
directories.
|
|
</param>
|
|
<param name="prefix">
|
|
Branch directory that is mnatched is returned.
|
|
</param>
|
|
<returns>
|
|
true if there is a match; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IProject.Reload(RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Reload all of the configuration data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IProjectSummary">
|
|
<summary>
|
|
Project summary interface; for reading summary information about
|
|
available projects when the configuration data may not be available.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProjectSummary.Key">
|
|
<summary>
|
|
Gets the project key.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProjectSummary.FriendlyName">
|
|
<summary>
|
|
Gets the project friendly UI name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProjectSummary.RootDirectory">
|
|
<summary>
|
|
Gets the project root-directory (absolute path).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProjectSummary.ConfigurationFilename">
|
|
<summary>
|
|
Gets the project configuration filename.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.ITarget">
|
|
<summary>
|
|
Target abstraction; representing a target platform defining the
|
|
architecture and build directory path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ITarget.Branch">
|
|
<summary>
|
|
Gets the associated <see cref="T:RSG.Configuration.IBranch"/> object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ITarget.Enabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether the target is enabled for local builds etc.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ITarget.NonFinalResourcePath">
|
|
<summary>
|
|
Gets the non-final resource directory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ITarget.Platform">
|
|
<summary>
|
|
Gets the associated platform key.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ITarget.ResourcePath">
|
|
<summary>
|
|
Gets the platform build resource files directory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ITarget.ShaderPath">
|
|
<summary>
|
|
Gets the platform shaders directory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.ITarget.ShaderExtension">
|
|
<summary>
|
|
Gets the platform shader file extension.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ITarget.IsRootedPath(System.String,System.String@)">
|
|
<summary>
|
|
Return whether the passed in path is from any of this branch's
|
|
directories.
|
|
</summary>
|
|
<param name="path">
|
|
Input path to determine if this is under any of this branch's
|
|
directories.
|
|
</param>
|
|
<param name="prefix">
|
|
Branch directory that is mnatched is returned.
|
|
</param>
|
|
<returns>
|
|
true if there is a match; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ITarget.GetRagebuilderExecutable">
|
|
<summary>
|
|
Return Ragebuilder absolute executable path for a particular target.
|
|
</summary>
|
|
<returns>
|
|
Ragebuilder executable filename.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ITarget.GetRagebuilderConvertXGEArguments">
|
|
<summary>
|
|
Return Ragebuilder XGE conversion arguments for a particular target.
|
|
</summary>
|
|
<returns>
|
|
Ragebuilder XGE conversion script arguments.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ITarget.GetRagebuilderConvertXGEScript">
|
|
<summary>
|
|
Return Ragebuilder XGE conversion script argument.
|
|
</summary>
|
|
<returns>
|
|
Ragebuilder XGE conversion script filename.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ITarget.GetRagebuilderScriptDirectory">
|
|
<summary>
|
|
Return Ragebuilder script directory.
|
|
</summary>
|
|
<returns>
|
|
Ragebuilder Lua scripts directory.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.ITarget.GetRagebuilderConvertLocalArguments">
|
|
<summary>
|
|
Return Ragebuilder local conversion arguments for a particular target.
|
|
</summary>
|
|
<returns>
|
|
Ragebuilder local conversion script arguments.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Ports.IPortConfig">
|
|
<summary>
|
|
Port configuration interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Ports.IPortConfig.Filename">
|
|
<summary>
|
|
Gets the port configuration XML file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Ports.IPortConfig.Ports">
|
|
<summary>
|
|
Gets the mapping of identifiers to ports.
|
|
</summary>
|
|
<todo>Change this to an IReadOnlyDictionary when we upgrade to 4.5.</todo>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Ports.PortConfig">
|
|
<summary>
|
|
Implementation of the <see cref="T:RSG.Configuration.Ports.IPortConfig"/> interface.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Ports.PortConfig._filename">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Ports.PortConfig.Filename"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Ports.PortConfig._ports">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Ports.PortConfig.Ports"/> property;
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Ports.PortConfig.#ctor(RSG.Base.Logging.ILog,RSG.Configuration.IProject)">
|
|
<summary>
|
|
Creates a new instance of the <see cref="T:RSG.Configuration.Ports.PortConfig"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="project">
|
|
Associated project.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Ports.PortConfig.Filename">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Ports.PortConfig.Ports">
|
|
<inheritdoc />
|
|
<todo>Change this to an IReadOnlyDictionary when we upgrade to 4.5.</todo>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Ports.PortConfig.Parse(RSG.Base.Logging.ILog,System.String)">
|
|
<summary>
|
|
Parses the passed in filename populating the list of available ports.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="filename">
|
|
File to parse.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.IExporterConfig">
|
|
<summary>
|
|
Exporter configuration data interface (for generic parameters).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.IExporterConfig.CacheDirectory">
|
|
<summary>
|
|
Gets the Exporter's Cache Directory
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.IExporterConfig.GetParameter(System.String,System.Object)">
|
|
<summary>
|
|
Gets the value of a named parameter.
|
|
</summary>
|
|
<param name="name">
|
|
Parameter name.
|
|
</param>
|
|
<param name="defaultValue">
|
|
Default value if parameter is not found.
|
|
</param>
|
|
<returns>
|
|
Parameter value if found; otherwise default value is returned.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.Implementation.AnimationExportConfig">
|
|
<summary>
|
|
Export configuration data for animation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.AnimationExportConfig.#ctor(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Export.Implementation.AnimationExportConfig"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlParamsElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.AnimationExportConfig.Load(RSG.Base.Logging.ILog,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
Load configuration data from XML document.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlDoc">
|
|
<see cref="T:System.Xml.Linq.XDocument"/> to parse.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Export.IAnimationExportConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.Implementation.BaseExporterConfig">
|
|
<summary>
|
|
Abstract base class for exporter configuration data classes.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Export.Implementation.BaseExporterConfig._parameters">
|
|
<summary>
|
|
User-defined options for processor; processor-specific key, value
|
|
pairs. Allow injection of processor options from content-tree.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.BaseExporterConfig.#ctor(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Export.Implementation.BaseExporterConfig"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlParamsElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.Implementation.BaseExporterConfig.CacheDirectory">
|
|
<summary>
|
|
Gets the Exporter's Cache Directory.
|
|
Returns an empty string if the parameter isn't present,
|
|
as the parameter should *always* be present in export.xml
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.BaseExporterConfig.GetParameter(System.String,System.Object)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.Implementation.VehicleExportConfig">
|
|
<summary>
|
|
Export configuration data for vehicles.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.VehicleExportConfig.#ctor(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Export.Implementation.VehicleExportConfig"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlParamsElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.VehicleExportConfig.Load(RSG.Base.Logging.ILog,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
Load configuration data from XML document.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlDoc">
|
|
<see cref="T:System.Xml.Linq.XDocument"/> to parse.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Export.IWeaponExportConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.Implementation.CharacterExportConfig">
|
|
<summary>
|
|
Export configuration data for characters.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.CharacterExportConfig.#ctor(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Export.Implementation.CharacterExportConfig"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlParamsElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.CharacterExportConfig.Load(RSG.Base.Logging.ILog,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
Load configuration data from XML document.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlDoc">
|
|
<see cref="T:System.Xml.Linq.XDocument"/> to parse.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Export.ICharacterExportConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.Implementation.WeaponExportConfig">
|
|
<summary>
|
|
Export configuration data for weapons.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.WeaponExportConfig.#ctor(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Export.Implementation.WeaponExportConfig"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlParamsElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.WeaponExportConfig.Load(RSG.Base.Logging.ILog,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
Load configuration data from XML document.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlDoc">
|
|
<see cref="T:System.Xml.Linq.XDocument"/> to parse.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Export.IWeaponExportConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.Implementation.CutsceneExportConfig">
|
|
<summary>
|
|
Export configuration data for cutscenes.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.CutsceneExportConfig.#ctor(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Export.Implementation.CutsceneExportConfig"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlParamsElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.CutsceneExportConfig.Load(RSG.Base.Logging.ILog,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
Load configuration data from XML document.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlDoc">
|
|
<see cref="T:System.Xml.Linq.XDocument"/> to parse.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Export.ICutsceneExportConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.Implementation.ExportConfig">
|
|
<summary>
|
|
Export configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Export.Implementation.ExportConfig._filename">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Configuration.Export.Implementation.ExportConfig.Filename"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.ExportConfig.#ctor(RSG.Base.Logging.ILog,RSG.Configuration.IProject,RSG.Configuration.Export.ExportConfigType)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Export.Implementation.ExportConfig"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="project">
|
|
Project.
|
|
</param>
|
|
<param name="types">
|
|
Export configuration data types to load.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.Implementation.ExportConfig.Project">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.Implementation.ExportConfig.Types">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.Implementation.ExportConfig.Animation">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.Implementation.ExportConfig.Character">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.Implementation.ExportConfig.Cutscene">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.Implementation.ExportConfig.Map">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.Implementation.ExportConfig.Vehicle">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.Implementation.ExportConfig.Weapon">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.Implementation.ExportConfig.Filename">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.ExportConfig.Load(RSG.Base.Logging.ILog,RSG.Configuration.IProject,RSG.Configuration.Export.ExportConfigType)">
|
|
<summary>
|
|
Load configuration data from XML document.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="project">
|
|
Project object.
|
|
</param>
|
|
<param name="types">
|
|
Exporter types to load.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Export.IExportConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.ExportConfig.GetCachePath(RSG.Configuration.IBranch,RSG.Configuration.Export.ExportConfigType)">
|
|
<summary>
|
|
Utility Method to return the correct path from the correct export config
|
|
</summary>
|
|
<param name="branch"><see cref="T:RSG.Configuration.IBranch"/></param>
|
|
<param name="type"><see cref="T:RSG.Configuration.Export.ExportConfigType"/></param>
|
|
<returns>String with the condensed cache path for that config e.g. "$(cache)/$(branch)/export/maps"</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.ExportConfig.Reload(RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Reload the export configuration data.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.Implementation.MapExportConfig">
|
|
<summary>
|
|
Export configuration data for maps.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.MapExportConfig.#ctor(RSG.Base.Logging.ILog,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Configuration.Export.Implementation.MapExportConfig"/> class.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlMapElem">
|
|
<see cref="T:System.Xml.Linq.XElement"/> to parse.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.Implementation.MapExportConfig.AutoSubmit">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.Implementation.MapExportConfig.ReportDrawableLimit">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.Implementation.MapExportConfig.ReportTXDLimit">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.Implementation.MapExportConfig.ReportBoundDrawableDistanceRatio">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.Implementation.MapExportConfig.Load(RSG.Base.Logging.ILog,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
Load configuration data from XML document.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="xmlDoc">
|
|
<see cref="T:System.Xml.Linq.XDocument"/> to parse.
|
|
</param>
|
|
<returns>
|
|
A new object that implements the <see cref="T:RSG.Configuration.Export.IMapExportConfig"/> interface.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.ExportConfigType">
|
|
<summary>
|
|
Enumeration of the different exporter configuration datasets we have.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Export.ExportConfigType.Animation">
|
|
<summary>
|
|
Animation export configuration.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Export.ExportConfigType.Character">
|
|
<summary>
|
|
Character export configuration.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Export.ExportConfigType.Cutscene">
|
|
<summary>
|
|
Cutscene export configuration.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Export.ExportConfigType.Map">
|
|
<summary>
|
|
Map export configuration.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Export.ExportConfigType.Vehicle">
|
|
<summary>
|
|
Vehicle export configuration.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Export.ExportConfigType.Weapon">
|
|
<summary>
|
|
Weapon export configuration.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Export.ExportConfigType.All">
|
|
<summary>
|
|
Alias for all export configurations.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Export.ExportConfigType.Default">
|
|
<summary>
|
|
Alias for default export configurations.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.IAnimationExportConfig">
|
|
<summary>
|
|
Animation Export configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.ICharacterExportConfig">
|
|
<summary>
|
|
Character Export configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.ICutsceneExportConfig">
|
|
<summary>
|
|
Cutscene Export configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.IExportConfig">
|
|
<summary>
|
|
Interface that defines export configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.IExportConfig.Project">
|
|
<summary>
|
|
Gets the associated project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.IExportConfig.Types">
|
|
<summary>
|
|
Gets the loaded configuration types.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.IExportConfig.Animation">
|
|
<summary>
|
|
Gets the In-Game Animation configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.IExportConfig.Character">
|
|
<summary>
|
|
Gets the Character export configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.IExportConfig.Cutscene">
|
|
<summary>
|
|
Gets the Cutscene export configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.IExportConfig.Map">
|
|
<summary>
|
|
Gets the Map export configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.IExportConfig.Vehicle">
|
|
<summary>
|
|
Gets the Vehicle export configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.IExportConfig.Weapon">
|
|
<summary>
|
|
Gets the Weapon export configuration object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.Export.IExportConfig.GetCachePath(RSG.Configuration.IBranch,RSG.Configuration.Export.ExportConfigType)">
|
|
<summary>
|
|
Return cache path.
|
|
</summary>
|
|
<param name="branch">
|
|
Branch object.
|
|
</param>
|
|
<param name="type">
|
|
Export type.
|
|
</param>
|
|
<returns>
|
|
Cache path.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.IMapExportConfig">
|
|
<summary>
|
|
Interface that defines export configuration data for maps.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.IMapExportConfig.AutoSubmit">
|
|
<summary>
|
|
Gets a value indicating whether Perforce auto-submission is enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.IMapExportConfig.ReportDrawableLimit">
|
|
<summary>
|
|
Gets the Map Export Report Drawable Limit (count).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.IMapExportConfig.ReportTXDLimit">
|
|
<summary>
|
|
Gets the Map Export Report TXD Limit (count).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.Export.IMapExportConfig.ReportBoundDrawableDistanceRatio">
|
|
<summary>
|
|
Gets the Map Export Report Bound Drawable Distance Ratio.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.IVehicleExportConfig">
|
|
<summary>
|
|
Vehicle export configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Export.IWeaponExportConfig">
|
|
<summary>
|
|
Weapon Export configuration data.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IHasEnvironment">
|
|
<summary>
|
|
IHasEnvironment specifies that the object has an associated Environment
|
|
object.
|
|
</summary>
|
|
<see cref="T:RSG.Configuration.ICanImportEnvironment"/>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IHasEnvironment.Environment">
|
|
<summary>
|
|
Gets the encapsulated Environment object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IPlatformConversionTool">
|
|
<summary>
|
|
Platform conversion tool interface abstraction.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IPlatformConversionTool.Platform">
|
|
<summary>
|
|
Gets the associated platform for this conversion tool.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IPlatformConversionTool.Branch">
|
|
<summary>
|
|
Gets the associated branch for this conversion tool.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IPlatformConversionTool.ExecutablePath">
|
|
<summary>
|
|
Gets the absolute path to conversion tool executable (or script).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IPlatformConversionTool.Arguments">
|
|
<summary>
|
|
Gets the platform and tool global options (independent of what is being converted).
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IProjectCore">
|
|
<summary>
|
|
Core project interface; shared between all projects (including DLC).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProjectCore.ProjectSummary">
|
|
<summary>
|
|
Gets summary information about this project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProjectCore.DLCProjects">
|
|
<summary>
|
|
Gets the available DLC-projects.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IProjectCore.SaveLocal">
|
|
<summary>
|
|
Save all of the configuration data.
|
|
</summary>
|
|
<returns>
|
|
true if successful; false otherwise.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IProjectDLC">
|
|
<summary>
|
|
DLC Project encapsulation; representing a DLC project that is owned by
|
|
a "core" project. These also define a set of branches and targets.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProjectDLC.ProjectSummary">
|
|
<summary>
|
|
Gets summary information about this project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IProjectDLC.CoreProject">
|
|
<summary>
|
|
Gets the associated core-project.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IProjectDLC.WalkContentPackChain(System.Boolean)">
|
|
<summary>
|
|
Iterator method to walk the <see cref="T:RSG.Configuration.IProjectDLC"/> pack chain setup
|
|
in our configuration data.
|
|
</summary>
|
|
<param name="includeSelf">
|
|
Value indicating whether to start by yielding this <see cref="T:RSG.Configuration.IProjectDLC"/>.
|
|
</param>
|
|
<see cref="M:RSG.Configuration.IProjectDLC.WalkProjectChain(System.Boolean)"/>
|
|
<returns>
|
|
Enumerable of <see cref="T:RSG.Configuration.IProjectDLC"/> only.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IProjectDLC.WalkProjectChain(System.Boolean)">
|
|
<summary>
|
|
Iterator method to walk the <see cref="T:RSG.Configuration.IProject"/> pack chain, including
|
|
the <see cref="T:RSG.Configuration.IProjectCore"/> setup in our configuration data.
|
|
</summary>
|
|
<param name="includeSelf">
|
|
Value indicating whether to start by yielding this <see cref="T:RSG.Configuration.IProjectDLC"/>.
|
|
</param>
|
|
<see cref="M:RSG.Configuration.IProjectDLC.WalkContentPackChain(System.Boolean)"/>
|
|
<returns>
|
|
Enumerable of <see cref="T:RSG.Configuration.IProject"/>; starts with <see cref="T:RSG.Configuration.IProjectDLC"/>
|
|
and the last one is <see cref="T:RSG.Configuration.IProjectCore"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IProjectDLC.IsTitleUpdateContentPackEnabled">
|
|
<summary>
|
|
Iterates throw the content pack chain
|
|
Checks if it contains the Title Update Content Pack
|
|
Checks if the TU is enabled
|
|
</summary>
|
|
<returns>True if the content pack is in the chain with the TU content pack and it is enabled</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IVersion">
|
|
<summary>
|
|
Version interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IVersion.Major">
|
|
<summary>
|
|
Gets the major version.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IVersion.Minor">
|
|
<summary>
|
|
Gets the minor version.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IVersion.Label">
|
|
<summary>
|
|
Gets a friendly string label for the version.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IVersionControlSettings">
|
|
<summary>
|
|
Version control settings interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IVersionControlSettings.Server">
|
|
<summary>
|
|
Gets the version control provider server connection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IVersionControlSettings.Username">
|
|
<summary>
|
|
Gets the version control provider username.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IVersionControlSettings.Workspace">
|
|
<summary>
|
|
Gets the version control provider workspace/client (if applicable).
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Configuration.IStudio">
|
|
<summary>
|
|
Studio encapsulation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.Name">
|
|
<summary>
|
|
Gets the studio key name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.FriendlyName">
|
|
<summary>
|
|
Gets the studio friendly name (for UI display).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.AbbreviatedName">
|
|
<summary>
|
|
Gets the studio abbreviation name (e.g. RSGSAN).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.IPNetworks">
|
|
<summary>
|
|
Gets the list of networks that the studio is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.PerforceServers">
|
|
<summary>
|
|
Gets the perforce servers this studio has.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.DefaultPerforceServer">
|
|
<summary>
|
|
Gets the default Perforce server and port for the studio.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.PerforceAutomationDataServer">
|
|
<summary>
|
|
Gets the Perforce Automation Data server and port.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.PerforceMocapServer">
|
|
<summary>
|
|
Gets the Perforce Mocap server and port.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.PerforceSwarmServer">
|
|
<summary>
|
|
Gets the default Perforce swarm web address.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.PerforceSwarmAutomationDataServer">
|
|
<summary>
|
|
Gets the Perforce Automation swarm web address.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.NetworkDrive">
|
|
<summary>
|
|
Gets the shared network drive resource.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.DistributedNetworkPath">
|
|
<summary>
|
|
Gets the root network path for the distributed file system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.ExchangeServer">
|
|
<summary>
|
|
Gets the exchange server URI.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.Domain">
|
|
<summary>
|
|
Gets the studio domain URI.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.ActiveDirectoryDomain">
|
|
<summary>
|
|
Gets the studio Active Directory domain (for login authentication).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.BuilderUser">
|
|
<summary>
|
|
Gets the user name of automated builder user.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.BuilderName">
|
|
<summary>
|
|
Gets the friendly name of automated builder user.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.TimeZoneId">
|
|
<summary>
|
|
Gets the Time Zone identifier (based on studio location).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.Icons">
|
|
<summary>
|
|
Gets the studio icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Configuration.IStudio.BugstarId">
|
|
<summary>
|
|
Gets the unique identifier for this studio in Bugstar.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Configuration.IStudio.GetTimeZoneInfo">
|
|
<summary>
|
|
Return TimeZoneInfo object for this studio.
|
|
</summary>
|
|
<returns>
|
|
<see cref="T:System.TimeZoneInfo"/> for the studio/
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Configuration.Label">
|
|
<summary>
|
|
Enumeration of common project labels.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Label.None">
|
|
<summary>
|
|
No label.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Label.BuildVersion">
|
|
<summary>
|
|
Build version convention.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Label.ToolsVersion">
|
|
<summary>
|
|
Tools version convention.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Configuration.Label.AutomationVersion">
|
|
<summary>
|
|
Automation version convention.
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|