Report Class

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

Contains information about the current solution.

Inheritance Hierarchy

System.Object
  Microsoft.SolverFoundation.Services.Report
    Microsoft.SolverFoundation.Services.ConstraintProgrammingReport
    Microsoft.SolverFoundation.Services.LinearReport
    Microsoft.SolverFoundation.Services.RowVariableReport

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

Syntax

'Declaration
Public MustInherit Class Report
public abstract class Report
public ref class Report abstract
[<AbstractClass>]
type Report =  class end
public abstract class Report

The Report type exposes the following members.

Constructors

  Name Description
Protected method Report Initializes a new instance of the Report class.

Top

Properties

  Name Description
Protected property Context Gets the services that are provided to a solver.
Protected property DefaultFormatProvider Gets an object that provides information for formatting and parsing operations.
Protected property DefaultVerbosity Gets a value that specifies the amount of information to be included in a report.
Public property Directives Gets a collection of all directives that are used in the model.
Protected property IsStochastic Gets a value that indicates whether a model is a stochastic model.
Public property ModelName Gets the name of a model.
Protected property Solution Gets the solution associated with the report.
Public property SolutionDirective Gets a solution directive.
Protected property SolutionMapping Gets an object that maps between model and solver level terms.
Public property SolutionQuality Gets a value that specifies the quality of a solution.
Protected property Solver Gets the solver that solved a model.
Public property SolverCapability Gets the capability of the solver that found a solution.
Public property SolverType Gets the Type value of the solver that found a solution.
Public property SolveTime Gets the amount of time spent solving a model, in milliseconds.
Public property TotalTime Gets the total time spent solving the model, in milliseconds.

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.)
Protected method GenerateReportDecisions Adds the decision results to a report.
Protected method GenerateReportDirectives Adds information about all directives to a report.
Protected method GenerateReportGoals Adds information about all goals to a report.
Protected method GenerateReportOverview Adds overview information to a report.
Protected method GenerateReportPartialSolutionDetails Adds results about goal to a report.
Protected method GenerateReportSolverDetails Adds the details of a solver to a report.
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.)
Protected method SupportsSolutionDetails Returns a value that indicates whether solution details can be returned.
Public method ToString() Converts a report to its equivalent string representation. (Overrides Object.ToString().)
Public method ToString(IFormatProvider) Converts a report to its equivalent string representation.
Public method ToString(ReportVerbosity) Converts a report to its equivalent string representation.
Public method ToString(ReportVerbosity, IFormatProvider) Converts a report to its equivalent string representation.
Protected method ValidateSolution Ensures that a solution is valid.
Public method WriteTo Writes a report.

Top

Remarks

A report instance is obtained from a solution using the GetReport method. Depending on the solver that was used to solve the model, GetReport may return a subclass of Report with solver-specific information.

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