My Project
OtherMatrixVariableResult Class Reference

The in-memory representation of the <matrixVariables> <other> element. More...

#include <OSResult.h>

Public Member Functions

 OtherMatrixVariableResult ()
 The standard MatrixVariableValues class constructor.
 
 OtherMatrixVariableResult (std::string name_)
 Altername MatrixVariableValues class constructor.
 
 ~OtherMatrixVariableResult ()
 The MatrixVariableValues class destructor.
 
bool IsEqual (OtherMatrixVariableResult *that)
 A function to check for the equality of two objects.
 

Public Attributes

std::string name
 Gives a name to this result.
 
std::string description
 other data elements are optional
 
std::string value
 
std::string type
 
std::string solver
 
std::string category
 
int numberOfMatrixVar
 number of matrix variables affected by or associated with this result
 
std::string matrixType
 the type of matrixVar
 
OSMatrixWithMatrixVarIdx ** matrixVar
 the list of matrices and their values
 
int numberOfEnumerations
 number of levels in an enumeration associated with this result
 
std::string enumType
 the type of the enumeration
 
OtherOptionOrResultEnumeration ** enumeration
 the enumeration.
 

Detailed Description

The in-memory representation of the <matrixVariables> <other> element.

Definition at line 1939 of file OSResult.h.

Constructor & Destructor Documentation

◆ OtherMatrixVariableResult() [1/2]

OtherMatrixVariableResult::OtherMatrixVariableResult ( )

The standard MatrixVariableValues class constructor.

Definition at line 992 of file OSResult.cpp.

◆ OtherMatrixVariableResult() [2/2]

OtherMatrixVariableResult::OtherMatrixVariableResult ( std::string name_)

Altername MatrixVariableValues class constructor.

Definition at line 1012 of file OSResult.cpp.

◆ ~OtherMatrixVariableResult()

OtherMatrixVariableResult::~OtherMatrixVariableResult ( )

The MatrixVariableValues class destructor.

Definition at line 1029 of file OSResult.cpp.

Member Function Documentation

◆ IsEqual()

bool OtherMatrixVariableResult::IsEqual ( OtherMatrixVariableResult * that)

A function to check for the equality of two objects.

Member Data Documentation

◆ name

std::string OtherMatrixVariableResult::name

Gives a name to this result.

This is s mandatory data element

Definition at line 1943 of file OSResult.h.

◆ description

std::string OtherMatrixVariableResult::description

other data elements are optional

Definition at line 1946 of file OSResult.h.

◆ value

std::string OtherMatrixVariableResult::value

Definition at line 1947 of file OSResult.h.

◆ type

std::string OtherMatrixVariableResult::type

Definition at line 1948 of file OSResult.h.

◆ solver

std::string OtherMatrixVariableResult::solver

Definition at line 1949 of file OSResult.h.

◆ category

std::string OtherMatrixVariableResult::category

Definition at line 1950 of file OSResult.h.

◆ numberOfMatrixVar

int OtherMatrixVariableResult::numberOfMatrixVar

number of matrix variables affected by or associated with this result

Definition at line 1953 of file OSResult.h.

◆ matrixType

std::string OtherMatrixVariableResult::matrixType

the type of matrixVar

Definition at line 1956 of file OSResult.h.

◆ matrixVar

OSMatrixWithMatrixVarIdx** OtherMatrixVariableResult::matrixVar

the list of matrices and their values

Definition at line 1959 of file OSResult.h.

◆ numberOfEnumerations

int OtherMatrixVariableResult::numberOfEnumerations

number of levels in an enumeration associated with this result

Definition at line 1962 of file OSResult.h.

◆ enumType

std::string OtherMatrixVariableResult::enumType

the type of the enumeration

Definition at line 1965 of file OSResult.h.

◆ enumeration

OtherOptionOrResultEnumeration** OtherMatrixVariableResult::enumeration

the enumeration.

Each enumeration level has a list of matrixVar indices associated with that level

Definition at line 1970 of file OSResult.h.


The documentation for this class was generated from the following files: