Class ComponentConfig

Namespace: Phoenix.Pacz
Assembly: Phoenix.Pacz.dll

A concrete implementation of IComponentConfig.

This class implements IComponentConfig and adds the ability to change it after it has been created.

This class is not thread safe.

public class ComponentConfig : AbstractDisposable, IComponentConfig, IReadOnlyComponentConfig, IDisposable

Inheritance

object ← AbstractDisposable ← ComponentConfig

Implements

IComponentConfig, IReadOnlyComponentConfig, IDisposable

Inherited Members

AbstractDisposable.disposed, AbstractDisposable.Dispose(), AbstractDisposable.IsDisposed, AbstractDisposable.Dispose(bool), object.Equals(object), object.Equals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object, object), object.ToString()

Remarks

Configurations may contain default file values, which may use temporary files on disk. You should always reliably ensure Dispose is called on config objects.

Constructors

ComponentConfig(Guid, RunFolderPreference, IReadOnlyList<RuntimeVariable>, IReadOnlyList<RuntimeVariable>, string, string, IReadOnlyList, IEnumerable<InstanceFile>, IEnumerable<ExternalFile>, IReadOnlyList<Compatibility>, IDictionary<string, object>, Uri, Uri, string, string)

Constructor

ComponentConfig(IReadOnlyComponentConfig)

Copy constructor. Creates a ComponentConfig that is a clone of the source.

Properties

ASComponent

The Analysis Server component name.

Author

The author of the component.

Compatibilities

Get the list of compatibilities associated with this component.

Description

Get a description of the component.

ExternalFiles

Get the list of external files associated with this component. Internally a sorted set will always be used. Null will never be returned.

HelpUrl

The URL of the help, if any, or null for none. May be a relative URL.

Icon

The URL of the icon, if any, or null for none. May be a relative URL.

Inputs

Get the default inputs.

InstanceFiles

Get the list of instance files associated with this component. Internally a sorted set will always be used. Null will never be returned.

Outputs

Get the default outputs.

PlugInId

The PlugInId of the component.

Properties

An arbitrary dictionary of values that allows a plug-in writer to store data about the instance without needing to create additional files in the Pacz. Some values have special meaning as defined in Phoenix.PaczAPI.CommonProperties. The system will ensure this is never null.

RequiredFeatures

Get the package features required by the component.

RunFolderPreference

Can multiple runs share the same run directory? This means that they do not write or modify any files and can share access to all files they read.

Version

Get the version of the component.

Methods

AsReadOnly()

Returns a protected Phoenix.PaczAPI.IReadOnlyComponentConfig view of this object that cannot be typecasted back.

CloneInputsFrom(IEnumerable<IRuntimeVariable>)

Set the Phoenix.PaczAPI.IReadOnlyComponentConfig.Inputs by cloning the passed in objects.

CloneOutputsFrom(IEnumerable<IRuntimeVariable>)

Set the Phoenix.PaczAPI.IReadOnlyComponentConfig.Outputs by cloning the passed in objects.

Dispose(bool)

Standard disposal.

FromJson(string)

Reads in a JSON string and creates a ComponentConfig.

FromJson(string, Func<string, Handle<FileDeleter>>)

Reads in a JSON string and creates a ComponentConfig.

MoveInputsFrom(IEnumerable<IRuntimeVariable>)

Set the Phoenix.PaczAPI.IReadOnlyComponentConfig.Inputs by taking ownership of the passed in objects.

MoveOutputsFrom(IEnumerable<IRuntimeVariable>)

Set the Phoenix.PaczAPI.IReadOnlyComponentConfig.Outputs by taking ownership of the passed in objects.

ToJson(bool)

Write out this object as a JSON string.

ToJson(Func<FileValue, string>, bool)

Write out this object as a JSON string.