Class ComponentRunRequest

Namespace: Phoenix.ComponentAPI
Assembly: Phoenix.ComponentAPI.dll

An immutable class that contains the information necessary to run a component.

public class ComponentRunRequest : AbstractDisposable, IDisposable

Inheritance

object ← AbstractDisposable ← ComponentRunRequest

Implements

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

This class may contain FileValue instances that own temp files on disk. All uses of this class should be used in a using block, or otherwise reliably disposed.

Constructors

ComponentRunRequest()

Creates an empty run request with no input variables specified.

Properties

InputValues

The input values to use for this set of runs.

Methods

CreateCloneFrom(IEnumerable<KeyValuePair<string, VariableState>>)

Creates a new ComponentRunRequest by making a clone of the given data.

CreateCloneFrom(IEnumerable<IRuntimeVariable>, IEnumerable<KeyValuePair<string, VariableState>>)

Creates a new ComponentRunRequest by making a clone of the given data, filtered by a set of inputs.

CreateCloneFrom(IEnumerable, IEnumerable<KeyValuePair<string, VariableState>>)

Creates a new ComponentRunRequest by making a clone of the given data, filtered by a set of inputs.

CreateFromConfigDefaults(IReadOnlyComponentConfig)

Creates a new ComponentRunRequest by taking all the input default values from a component config

Dispose(bool)

Standard disposal.

MoveStateFrom(IEnumerable<KeyValuePair<string, VariableState>>)

Creates a new ComponentRunRequest by taking ownership of all the variable values passed in.

MoveStateFrom(VariableValueScope)

Creates a new ComponentRunRequest by taking all variables from the given scope.