ScenariosParameter Class
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
Represents a parameter for a fixed, finite number of discrete scenarios.
Inheritance Hierarchy
System.Object
Microsoft.SolverFoundation.Services.Term
Microsoft.SolverFoundation.Services.RandomParameter
Microsoft.SolverFoundation.Services.ScenariosParameter
Namespace: Microsoft.SolverFoundation.Services
Assembly: Microsoft.Solver.Foundation (in Microsoft.Solver.Foundation.dll)
Syntax
'Declaration
Public NotInheritable Class ScenariosParameter _
Inherits RandomParameter
public sealed class ScenariosParameter : RandomParameter
public ref class ScenariosParameter sealed : public RandomParameter
[<Sealed>]
type ScenariosParameter =
class
inherit RandomParameter
end
public final class ScenariosParameter extends RandomParameter
The ScenariosParameter type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
ScenariosParameter(String) | Initializes a new instance of the ScenariosParameter class. |
|
ScenariosParameter(String, array<Set[]) | Initializes a new instance of the ScenariosParameter class. |
|
ScenariosParameter(String, IEnumerable<Scenario>) | Initializes a new instance of the ScenariosParameter class that represents that specified scenarios. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Description | Gets or sets a description of a parameter object. (Inherited from RandomParameter.) |
|
IndexSets | Gets the index sets for a parameter object. (Inherited from RandomParameter.) |
|
Item | Returns the random parameter specified by the indexes. (Inherited from RandomParameter.) |
|
Name | Gets the name of a parameter. (Inherited from RandomParameter.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Protected method") |
DataBind | Binds the data to the solver context. (Inherited from RandomParameter.) |
|
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetIndexFieldGetters<T> | Creates get accessors for each index. (Inherited from RandomParameter.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
SetBinding<T>(IEnumerable<T>, String, String) | Binds parameters to data. |
|
SetBinding<T>(IEnumerable<T>, String, String, array<String[]) | Binds parameters to data using the specified properties. |
|
SetIndexSet | Returns the specified index set. (Inherited from RandomParameter.) |
|
ToString() | Converts a parameter to its equivalent string representation. (Inherited from RandomParameter.) |
|
ToString(String, IFormatProvider) | Converts a term to its equivalent string representation. (Inherited from Term.) |
|
VerifyModelNotFrozen | Verifies that the associated model is not frozen. (Inherited from RandomParameter.) |
Top
Remarks
A ScenariosParameter object is associated with an underlying set of Scenario objects. Each Scenario defines a possible value for the random parameter along with the probability of the scenario actually occurring. The sum of probabilities for all scenarios equals 1.0.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.