SolverRegistrationCollection Class

  • Article

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

Represents the plug-in solver registration information.

Inheritance Hierarchy

System.Object
  Microsoft.SolverFoundation.Services.SolverRegistrationCollection

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

Syntax

'Declaration
Public Class SolverRegistrationCollection _
    Implements ICollection(Of SolverRegistration), IEnumerable(Of SolverRegistration),  _
    IEnumerable

public class SolverRegistrationCollection : ICollection<SolverRegistration>, 
    IEnumerable<SolverRegistration>, IEnumerable

public ref class SolverRegistrationCollection : ICollection<SolverRegistration^>, 
    IEnumerable<SolverRegistration^>, IEnumerable

type SolverRegistrationCollection =  
    class
        interface ICollection<SolverRegistration>
        interface IEnumerable<SolverRegistration>
        interface IEnumerable
    end

public class SolverRegistrationCollection implements ICollection<SolverRegistration>, IEnumerable<SolverRegistration>, IEnumerable

The SolverRegistrationCollection type exposes the following members.

Properties

  Name Description
Public property Count The number of registration entries in the collection.
Public property IsReadOnly Returns a value that indicates whether the collection is read only.

Top

Methods

  Name Description
Public method Add Adds a new solver registration entry to the collection.
Public method Contains Determines if a registration entry exists.
Public method CopyTo Copies registration entries to an Array.
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 GetDirectiveType Return the Type of the directive associated with a registration entry.
Public method GetEnumerator Gets an enumerator for the collection.
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 ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICollection<SolverRegistration>.Clear Clears the collection.
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator Gets an enumerator for the collection.
Explicit interface implemetationPrivate method ICollection<SolverRegistration>.Remove Removes the specified item from the collection.

Top

Remarks

SolverRegistrationCollection stores information about registered third-party solvers. This information is accessed using the SolverContext.RegisteredSolvers property. A registration entry contains information such as the name of the plug-in assembly and the solver capability and interface it supports. This information is stored in the SolverRegistration class. A single plug-in solver may have multiple SolverRegistration entries, one for each capability supported by the solver. Entries are added to the collection automatically when a configuration file is associated with the application, or by calling the Add method.

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