Class VariableStatisticRow

Wrapper class that contains statistics for a single Variable.

Inheritance
System.Object
VariableStatisticRow
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: OPTANO.Modeling.Optimization.Exporter
Assembly: Optimization.dll
Syntax
public class VariableStatisticRow

Constructors

VariableStatisticRow()

Initializes a new instance of the VariableStatisticRow class.

Declaration
public VariableStatisticRow()

VariableStatisticRow(Variable)

Initializes a new instance of the VariableStatisticRow class.

Declaration
public VariableStatisticRow(Variable variable)
Parameters
Type Name Description
Variable variable

The variable that is represented by this row.

Properties

Indices

Gets or sets the indices.

Declaration
public List<object> Indices { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.Object>

LongName

Gets or sets the long name.

Declaration
public string LongName { get; set; }
Property Value
Type Description
System.String

LowerBound

Gets or sets the lower bound.

Declaration
public double LowerBound { get; set; }
Property Value
Type Description
System.Double

NumberOfTermsInRestrictions

Gets or sets the number of terms in restrictions.

Declaration
public int NumberOfTermsInRestrictions { get; set; }
Property Value
Type Description
System.Int32

ObjectivePrice

Gets or sets the objective price for each prio level.

Declaration
public Dictionary<int, double> ObjectivePrice { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.Int32, System.Double>

RemovedInPreprocess

Gets or sets a value indicating whether removed in preprocess. Null indicates that the solver does not support the computation of the removed variable set.

Declaration
public bool? RemovedInPreprocess { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

ShortName

Gets or sets the short name.

Declaration
public string ShortName { get; set; }
Property Value
Type Description
System.String

SolutionValue

Gets or sets the solution value.

Declaration
public double SolutionValue { get; set; }
Property Value
Type Description
System.Double

UpperBound

Gets or sets the upper bound.

Declaration
public double UpperBound { get; set; }
Property Value
Type Description
System.Double

Variable

Gets or sets the variable.

Declaration
public Variable Variable { get; set; }
Property Value
Type Description
Variable

VariableCollectionName

Gets or sets the referenced variable collection

Declaration
public string VariableCollectionName { get; set; }
Property Value
Type Description
System.String

Methods

CopyValuesFromVariable(Variable)

The copy values from variable. NOTE: Not all values can be copied directly from the variable. E.g. the indices are not stored within the variable, but in the containing VariableCollection!

Declaration
public void CopyValuesFromVariable(Variable variable)
Parameters
Type Name Description
Variable variable

The variable.

SetRemainingValues(String, String, Dictionary<Int32, Double>, Nullable<Boolean>, Int32, Object[])

Sets the values that cannot be copied from the Variable itself.

Declaration
public void SetRemainingValues(string variableCollectionName, string otherName, Dictionary<int, double> objectivePrices, bool? removedInProcess, int numberOfTermsInRestrictions, object[] indices)
Parameters
Type Name Description
System.String variableCollectionName

The name of the VariableCollection that contains the Variable for this VariableStatisticRow.
System.String otherName

The other (Short-/LongName), that has not been set yet.
System.Collections.Generic.Dictionary<System.Int32, System.Double> objectivePrices

The objective function factor for the variable
System.Nullable<System.Boolean> removedInProcess

True, if variable was removed in preprocessing. False, else.
System.Int32 numberOfTermsInRestrictions

Number of model rows that the variable appears in
System.Object[] indices

The variable collection index for this variable

ToString()

Returns the CSV representation of the Variable. Uses a semicolon as default separator. Double values are use a '.' as decimal point.

Declaration
public override string ToString()
Returns
Type Description
System.String

The System.String. The string.
Overrides
System.Object.ToString()

ToString(String, Boolean)

Returns the CSV representation of the Variable. Uses a semicolon as default separator. Double values are use a '.' as decimal point.

Declaration
public string ToString(string seperator, bool unhandledVariable = false)
Parameters
Type Name Description
System.String seperator

The separator. Fallback value for 'null' or '.' will be '';'
System.Boolean unhandledVariable

true to print statistics for an unhandled variable. I.e. the ShortName only will be printed for variables that are handled by a VariableCollection.
Returns
Type Description
System.String

The System.String. The string.

Extension Methods