Share via


Parameter Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Represents a group of terms that binds to data.

Inheritance Hierarchy

System.Object
  Microsoft.SolverFoundation.Services.Term
    Microsoft.SolverFoundation.Services.Parameter

Namespace:  Microsoft.SolverFoundation.Services
Assembly:  Microsoft.Solver.Foundation (in Microsoft.Solver.Foundation.dll)

Syntax

'Declaration
Public NotInheritable Class Parameter _
    Inherits Term
public sealed class Parameter : Term
public ref class Parameter sealed : public Term
[<Sealed>]
type Parameter =  
    class
        inherit Term
    end
public final class Parameter extends Term

The Parameter type exposes the following members.

Constructors

  Name Description
Public method Parameter(Domain, String) Initializes a new instance of the Parameter class.
Public method Parameter(Domain, String, array<Set[]) Initializes a new instance of the Parameter class.

Top

Properties

  Name Description
Public property Description Gets or sets a description for a parameter object.
Public property IndexSets Gets the index sets for a parameter object.
Public property Item Returns the parameter specified by the indexes.
Public property Name Gets the name of a parameter.

Top

Methods

  Name Description
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SetBinding<T>(IEnumerable<T>, Func<T, TResult>)
Public method SetBinding<T>(IEnumerable<T>, String) Binds parameters to data.
Public method SetBinding<T>(IEnumerable<T>, Func<T, TResult>, Boolean)
Public method SetBinding<T>(IEnumerable<T>, String, array<String[]) Binds parameters to data using the specified properties.
Public method SetBinding<T>(IEnumerable<T>, Func<T, TResult>, Boolean, T)
Public method SetBinding<T>(IEnumerable<T>, String, Rational, array<String[]) Binds the parameter to data.
Public method SetIndexSet Resets the specified index set.
Public method ToString() Converts a parameter to its equivalent string representation. (Overrides Object.ToString().)
Public method ToString(String, IFormatProvider) Converts a term to its equivalent string representation. (Inherited from Term.)

Top

Extension Methods

  Name Description
Public Extension Method SetBinding(IEnumerable<array<Object[]>) Overloaded. Binds an indexed parameter to a sequence of values. (Defined by BindingUtilities.)
Public Extension Method SetBinding<T>(T) Overloaded. Binds a parameter object to a scalar value. (Defined by BindingUtilities.)
Public Extension Method SetBinding<T>(IEnumerable<T>) Overloaded. Binds an indexed parameter to a sequence of values. (Defined by BindingUtilities.)
Public Extension Method SetBinding<T>(IEnumerable<IEnumerable<T>>) Overloaded. Binds an indexed parameter object to a table. (Defined by BindingUtilities.)

Top

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.

See Also

Reference

Microsoft.SolverFoundation.Services Namespace