My Project
OSResult.h
Go to the documentation of this file.
1 
17 #ifndef OSRESULT_H
18 #define OSRESULT_H
19 //#define DEBUG
20 #include <string>
21 #include <vector>
22 
23 
35 class GeneralSubstatus {
36 
37 public:
38 
40  std::string name;
41 
43  std::string description;
44 
55 
56 };//GeneralSubstatus
57 
58 
70 class GeneralStatus {
71 
72 public:
73 
76 
78  std::string type;
79 
81  std::string description;
82 
84  std::vector<GeneralSubstatus*> substatus;
85 
96 
97 };//GeneralStatus
98 
99 
111 class GeneralResult{
112 public:
113 
116 
120  std::string serviceURI;
121 
125  std::string serviceName;
126 
128  std::string instanceName;
129 
133  std::string jobID;
134 
138  std::string time;
139 
141  std::string message;
142 
153 };//class GeneralResult
154 
155 
167 class SystemResult{
168 public:
169 
180 };//class SystemResult
181 
182 
194 class ServiceResult{
195 public:
196 
207 };//class ServiceResult
208 
209 
221 class Time{
222 public:
223 
228  std::string type;
229 
234  std::string category;
235 
240  std::string unit;
241 
246  std::string description;
247 
252  double value;
253 
258  Time();
263  ~Time();
264 };//class Time
265 
266 
278 class TimingInformation{
279 public:
280 
286 
291  int numberOfTimes;
292 
303 };//class TimingInformation
304 
305 
317 class JobResult{
318 public:
319 
331 };//class JobResult
332 
333 
334 
335 
348 public:
349 
351  std::string namee;
352 
354  std::string description;
355 
356 
366 
367 };//OptimizationSolutionSubstatus
368 
369 
382 public:
383 
386 
388  std::string type;
389 
391  std::string description;
392 
394  std::vector<OptimizationSolutionSubstatus*> substatus;
395 
405 
406 };//OptimizationSolutionStatus
407 
408 
420 class VarValue{
421 public:
422 
424  int idx;
425 
426  /* value is the value of the variable indexed by idx
427  * in the solution
428  */
429  double value;
430 
441 
442 };// class VarValue
443 
444 
455 class VariableValues{
456 public:
457 
460  int numberOfVar;
461 
465  std::vector<VarValue*> var;
466 
467 
473 
479 
480 };// class VariableValues
481 
482 
495 public:
496 
498  int idx;
499 
500  /* value is the value of the variable indexed by idx
501  * in the solution
502  */
503  std::string value;
504 
510 
516 
517 };// class VarStringValue
518 
519 
531 public:
532 
536 
540  std::vector<VarStringValue*> var;
541 
542 
548 
554 
555 };// class VariableStringValues
556 
557 
568 class OtherVarResult {
569 public:
570 
572  int idx;
573 
580  std::string value;
581 
592 
593 };//OtherVarResult
594 
595 
596 
608 class OtherVariableResult {
609 public:
610 
614  int numberOfVar;
615 
619  std::string value;
620 
622  std::string name;
623 
625  std::string description;
626 
627  /* a pointer to OtherVarResult objects that will
628  * give for each variable the index and value for
629  * this user defined variable result
630  */
631  std::vector<OtherVarResult*> var;
632 
638 
644 
645 };//OtherVariableResult
646 
647 
659 class VariableSolution{
660 public:
661 
666 
669 
672 
673 
678 
684 
690 
691 };// class VariableSolution
692 
693 
705 class ObjValue {
706 public:
707 
709  int idx;
710 
712  double value;
713 
719 
725 };//ObjValue
726 
737 class ObjectiveValues {
738 public:
739 
742  int numberOfObj;
743 
748  std::vector<ObjValue*> obj;
749 
755 
761 
762 };//ObjectiveValues
763 
764 
776 class OtherObjResult {
777 public:
778 
780  int idx;
781 
782 
786  std::string value;
787 
793 
799 
800 };//OtherObjResult
801 
802 
803 
804 
816 class OtherObjectiveResult {
817 public:
818 
822  int numberOfObj;
823 
827  std::string value;
828 
829 
831  std::string name;
832 
834  std::string description;
835 
836  /* a pointer to OtherObjResult objects that will
837  * give for each objective function the index and
838  * value for this user defined objective function result
839  */
840  std::vector<OtherObjResult*> obj;
841 
847 
853 
854 };//OtherObjectiveResult
855 
856 
857 
869 class ObjectiveSolution {
870 public:
871 
876 
879 
884 
890 
896 
897 };//ObjectiveSolution
898 
899 
900 
911 class DualVarValue {
912 public:
913 
915  int idx;
916 
921  double lbValue;
922 
923 
928  double ubValue;
929 
933  double value;
934 
940 
946 
947 };//DualVarValue
948 
949 
950 
961 class DualVariableValues {
962 public:
963 
966  int numberOfCon;
967 
972  std::vector<DualVarValue*> con;
973 
979 
985 
986 };//DualVariableValues
987 
988 
1000 class OtherConResult {
1001 public:
1002 
1004  int idx;
1005 
1011  std::string value;
1012 
1018 
1024 
1025 };//OtherConResult
1026 
1027 
1028 
1029 
1030 
1042 class OtherConstraintResult {
1043 public:
1044 
1048  int numberOfCon;
1049 
1053  std::string value;
1054 
1056  std::string name;
1057 
1059  std::string description;
1060 
1061 
1062  /* a vector of OtherConResult objects that will
1063  * give for each constraint the index and
1064  * value for this user defined objective function result
1065  */
1066  std::vector<OtherConResult*> con;
1067 
1073 
1079 
1080 };//OtherConstraintResult
1081 
1082 
1083 
1084 
1096 class ConstraintSolution {
1097 
1098 public:
1099 
1104 
1107 
1112 
1118 
1124 
1125 };//ConstraintSolution
1126 
1127 
1128 
1129 
1142 public:
1143 
1145  std::string name;
1146 
1148  std::string description;
1149 
1153  std::string value;
1154 
1160 
1166 
1167 };//OtherOptimizationResult
1168 
1169 
1170 
1171 
1183 class OptimizationSolution{
1184 public:
1185 
1189  int targetObjectiveIdx;
1190 
1193 
1198 
1200  std::string message;
1201 
1206 
1211 
1216 
1220  std::vector<OtherOptimizationResult*> other;
1221 
1227 
1233 
1234 };// class OptimizationSolution
1235 
1236 
1248 class OptimizationResult{
1249 public:
1250 
1254  int numberOfVariables;
1255 
1259  int numberOfObjectives;
1260 
1264  int numberOfConstraints;
1265 
1269  int numberOfSolutions;
1270 
1275 
1281 
1287 
1288 };// class OptimizationResult
1289 
1290 
1291 
1302 class OSResult{
1303 
1304 public:
1305 
1310 
1315 
1320 
1324  JobResult *job;
1325 
1330 
1336 
1342 public:
1343 
1347  int m_iVariableNumber;
1348 
1352  int m_iObjectiveNumber;
1353 
1357  int m_iConstraintNumber;
1358 
1363 
1367  double *m_mdPrimalValues;
1368 
1372  double *m_mdDualValues;
1373 
1374 
1375 
1376 
1377 public:
1378 
1385 
1392  std::string getGeneralStatusType();
1393 
1400 
1406  std::string getServiceName();
1407 
1413  std::string getServiceURI();
1414 
1420  std::string getInstanceName();
1421 
1427  std::string getJobID();
1428 
1434  std::string getGeneralMessage();
1435 
1442 
1449  double getTimeValue();
1450 
1457  double* getOptimalPrimalVariableValues(int objIdx);
1458 
1465  double* getOptimalDualVariableValues(int objIdx);
1466 
1467  //Solution getSolution(int solIdx);
1468 
1478 
1488  std::string getSolutionStatusType(int solIdx);
1489 
1496  std::string getSolutionStatusDescription(int solIdx);
1497 
1504  std::string getSolutionMessage(int solIdx);
1505 
1506 
1507 
1508 
1515 
1522 
1529 
1536 
1543 
1544  // set methods
1545  //
1546 
1547 
1548 
1556 
1564  bool setGeneralStatusType(std::string type);
1565 
1572  bool setGeneralStatusDescription(std::string description);
1573 
1580  bool setGeneralMessage(std::string message);
1581 
1588  bool setServiceName(std::string serviceName);
1589 
1596  bool setServiceURI(std::string serviceURI);
1597 
1604  bool setInstanceName(std::string instanceName);
1605 
1612  bool setJobID(std::string jobID);
1613 
1620  bool setTime(double time);
1621 
1632  bool addTimingInformation(std::string type, std::string category,
1633  std::string unit, std::string description, double value);
1634 
1641  bool setTimeNumber(int timeNumber);
1642 
1649  bool setVariableNumber(int variableNumber);
1650 
1657  bool setObjectiveNumber(int objectiveNumber);
1658 
1665  bool setConstraintNumber(int constraintNumber);
1666 
1679  bool setSolutionNumber(int number);
1680 
1681 
1694  bool setSolutionStatus(int solIdx, std::string type, std::string description);
1695 
1708  bool setSolutionObjectiveIndex(int solIdx, int objectiveIdx);
1709 
1719  bool setNumberOfPrimalVariableValues(int solIdx, int n);
1720 
1721 
1732  bool setPrimalVariableValues(int solIdx, double *x, int n);
1749  bool setNumberOfOtherVariableResults(int solIdx, int numberOfOtherVariableResults);
1750 
1766  bool setAnOtherVariableResult(int solIdx, int otherIdx, std::string name, std::string description, int *indexes, std::string *s, int n);
1767 
1768 
1769 
1785  bool setObjectiveValues(int solIdx, double *objectiveValues, int n);
1786 
1787 
1800  bool setDualVariableValues(int solIdx, double* lbValues, double* ubValues, int n);
1801 
1802 
1813  bool setDualVariableValues(int solIdx, double *y, int n);
1814 
1825  bool setConstraintValues(int solIdx, double *constraintValues, int n);
1826 
1827 
1828 
1829 };
1830 #endif
The ConstraintSolution Class.
Definition: OSResult.h:1861
OtherConstraintResult ** other
a pointer to an array of other pointer objects for constraint functions
Definition: OSResult.h:1879
ConstraintSolution()
Default constructor.
DualVariableValues * dualValues
a pointer to an array of DualVariableValues objects
Definition: OSResult.h:1871
~ConstraintSolution()
Class destructor.
int numberOfOtherConstraintResults
the number of types of constraint function results other than the basic constraint function values
Definition: OSResult.h:1868
The DualVarValue Class.
Definition: OSResult.h:1599
double lbValue
lbValue is the value of dual variable on the constraint indexed by idx if the constraint is at its lo...
Definition: OSResult.h:921
DualVarValue()
Default constructor.
double ubValue
ubValue is the value of dual variable on the constraint indexed by idx if the constraint is at its up...
Definition: OSResult.h:928
~DualVarValue()
Class destructor.
double value
value of dual variable on the constraint indexed by idx
Definition: OSResult.h:1611
int idx
idx is the index on a constraint
Definition: OSResult.h:1603
The DualVariableValues Class.
Definition: OSResult.h:1655
~DualVariableValues()
Class destructor.
std::vector< DualVarValue * > con
con is a vector of DualVarValue objects that give an index and dual variable value for each constrain...
Definition: OSResult.h:972
DualVariableValues()
Default constructor.
int numberOfCon
record the number of constraints for which values are given
Definition: OSResult.h:1660
The GeneralResult Class.
Definition: OSResult.h:267
~GeneralResult()
Class destructor.
std::string time
the time when solution was complete kippster – verify this
Definition: OSResult.h:138
GeneralResult()
Default constructor.
std::string serviceURI
the serviceURI is the URI of the solver service that did the optimization
Definition: OSResult.h:281
std::string serviceName
the serviceName is the name of the solver service that did the optimization
Definition: OSResult.h:286
std::string jobID
the jobID is the ID associated with the solution of this instance
Definition: OSResult.h:295
GeneralStatus * generalStatus
a pointer to the GeneralStatus class
Definition: OSResult.h:272
std::string instanceName
the name of the instance that was solved
Definition: OSResult.h:290
std::string message
any general message associated with the optimization
Definition: OSResult.h:276
The GeneralStatus Class.
Definition: OSResult.h:106
int numberOfSubstatuses
the number of substatuses
Definition: OSResult.h:111
std::string type
the type of status
Definition: OSResult.h:114
~GeneralStatus()
Class destructor.
std::string description
the description of the status
Definition: OSResult.h:117
std::vector< GeneralSubstatus * > substatus
the array of substatuses
Definition: OSResult.h:84
GeneralStatus()
Default constructor.
The GeneralSubstatus Class.
Definition: OSResult.h:55
~GeneralSubstatus()
Class destructor.
std::string description
the description of the substatus
Definition: OSResult.h:63
GeneralSubstatus()
Default constructor.
std::string name
the name of the substatus
Definition: OSResult.h:60
The JobResult Class.
Definition: OSResult.h:660
JobResult()
Default constructor.
TimingInformation * timingInformation
a pointer to the TimingInformation class
Definition: OSResult.h:679
~JobResult()
Class destructor.
The Result Class.
Definition: OSResult.h:2549
std::string getSolutionMessage(int solIdx)
Get the [i]th optimization solution message, where i equals the given solution index.
std::string getGeneralMessage()
Get the general message.
bool setGeneralMessage(std::string message)
Set the general message.
bool setAnOtherVariableResult(int solIdx, int otherIdx, std::string name, std::string description, int *indexes, std::string *s, int n)
Set the [i]th optimization solution's other (non-standard/solver specific)variable-related results,...
Definition: OSResult.cpp:1080
bool setJobID(std::string jobID)
Set job id.
bool setPrimalVariableValues(int solIdx, double *x, int n)
Set the [i]th optimization solution's primal variable values, where i equals the given solution index...
Definition: OSResult.cpp:1028
bool setDualVariableValues(int solIdx, double *lbValues, double *ubValues, int n)
Set the [i]th optimization solution's dual variable values, where i equals the given solution index.
Definition: OSResult.cpp:1184
std::string getServiceURI()
Get service uri.
OSResult()
Default constructor.
int m_iNumberOfOtherVariableResults
m_iNumberOfOtherVariableResults holds the number of OtherVariableResult objects.
Definition: OSResult.h:2629
bool setGeneralStatusDescription(std::string description)
Set the general status description.
bool setSolutionNumber(int number)
set the number of solutions.
OptimizationSolutionStatus * getSolutionStatus(int solIdx)
Get the [i]th optimization solution status, where i equals the given solution index.
GeneralStatus * getGeneralStatus()
Get the general status.
bool setInstanceName(std::string instanceName)
Set instance name.
GeneralResult * general
general holds the first child of the OSResult specified by the OSrL Schema.
Definition: OSResult.h:2561
int m_iObjectiveNumber
m_iObjectiveNumber holds the objective number.
Definition: OSResult.h:2619
std::string getServiceName()
Get service name.
bool setNumberOfOtherVariableResults(int solIdx, int numberOfOtherVariableResults)
Set the [i]th optimization solution's other (non-standard/solver specific)variable-related results,...
double * m_mdPrimalValues
m_mdPrimalValues a vector of primal variables.
Definition: OSResult.h:2634
double * getOptimalDualVariableValues(int objIdx)
Get one solution of optimal dual variable values.
bool setGeneralStatusType(std::string type)
Set the general status type, which can be: success, error, warning.
ServiceResult * service
service holds the third child of the OSResult specified by the OSrL Schema.
Definition: OSResult.h:2571
bool setObjectiveNumber(int objectiveNumber)
Set the objective number.
int m_iVariableNumber
m_iVariableNumber holds the variable number.
Definition: OSResult.h:2614
std::string getGeneralStatusDescription()
Get the general status description.
int getObjectiveNumber()
Get objective number.
bool setConstraintValues(int solIdx, double *constraintValues, int n)
Set the [i]th optimization solution's constraint values, where i equals the given solution index.
Definition: OSResult.cpp:1293
double * getOptimalPrimalVariableValues(int objIdx)
Get one solution of optimal primal variable values.
OptimizationResult * optimization
optimization holds the fifth child of the OSResult specified by the OSrL Schema.
Definition: OSResult.h:2581
bool setGeneralStatus(GeneralStatus *status)
Set the general status.
double * m_mdDualValues
m_mdDualValues a vector of dual variables.
Definition: OSResult.h:2639
bool setObjectiveValues(int solIdx, double *objectiveValues, int n)
Set the [i]th optimization solution's objective values, where i equals the given solution index.
Definition: OSResult.cpp:1130
bool setServiceName(std::string serviceName)
Set service name.
bool setNumberOfPrimalVariableValues(int solIdx, int n)
Set the [i]th optimization solution's number of primal variable values, where i equals the given solu...
std::string getJobID()
Get the job id.
int getTimeNumber()
Get the number of time measurements.
bool setVariableNumber(int variableNumber)
Set the variable number.
~OSResult()
Class destructor.
bool setTime(double time)
Set time.
int getSolutionNumber()
get the number of solutions.
SystemResult * system
system holds the second child of the OSResult specified by the OSrL Schema.
Definition: OSResult.h:2566
bool setSolutionObjectiveIndex(int solIdx, int objectiveIdx)
Set the [i]th optimization solution's objective index, where i equals the given solution index.
Definition: OSResult.cpp:990
std::string getInstanceName()
Get instance name.
bool setTimeNumber(int timeNumber)
Set the number of time measurements.
bool setSolutionStatus(int solIdx, std::string type, std::string description)
Set the [i]th optimization solution status, where i equals the given solution index.
double getTimeValue()
Get the time measurement.
bool addTimingInformation(std::string type, std::string category, std::string unit, std::string description, double value)
Add timing information.
int getConstraintNumber()
Get constraint number.
bool setConstraintNumber(int constraintNumber)
Set the constraint number.
std::string getGeneralStatusType()
Get the general status type, which can be: success, error, warning.
bool setServiceURI(std::string serviceURI)
Set service uri.
int getNumberOfOtherVariableResults(int solIdx)
Get numberOfOtherVariableResult.
int getVariableNumber()
Get variable number.
JobResult * job
job holds the fourth child of the OSResult specified by the OSrL Schema.
Definition: OSResult.h:2576
std::string getSolutionStatusType(int solIdx)
Get the [i]th optimization solution status type, where i equals the given solution index.
int m_iConstraintNumber
m_iConstraintNumber holds the constraint number.
Definition: OSResult.h:2624
std::string getSolutionStatusDescription(int solIdx)
Get the [i]th optimization solution status description, where i equals the given solution index.
The ObjValue Class.
Definition: OSResult.h:1282
ObjValue()
Default constructor.
~ObjValue()
Class destructor.
double value
the value of the objective indexed by idx
Definition: OSResult.h:1292
int idx
idx is the index on an objective function
Definition: OSResult.h:1286
The ObjectiveSolution Class.
Definition: OSResult.h:1538
OtherObjectiveResult ** other
a pointer to an array of other pointer objects for objective functions
Definition: OSResult.h:1555
ObjectiveSolution()
Default constructor.
int numberOfOtherObjectiveResults
the number of types of objective function results other than the basic objective function values
Definition: OSResult.h:1544
~ObjectiveSolution()
Class destructor.
ObjectiveValues * values
a pointer to an array of ObjectiveValues objects
Definition: OSResult.h:1547
The ObjectiveValues Class.
Definition: OSResult.h:1333
~ObjectiveValues()
Class destructor.
int numberOfObj
record the number of objective rows for which values are given
Definition: OSResult.h:1338
ObjectiveValues()
Default constructor.
std::vector< ObjValue * > obj
obj is a pointer to an array of ObjValue objects that give an index and objective function value for ...
Definition: OSResult.h:748
The OptimizationResult Class.
Definition: OSResult.h:2474
int numberOfSolutions
numberOfSolutions is the number of objective functions reported.
Definition: OSResult.h:2480
OptimizationResult()
Default constructor.
int numberOfObjectives
numberOfObjectives is the number of objective functions reported in the solution.
Definition: OSResult.h:2490
int numberOfVariables
numberOfVariables is the number of variables reported in the solution.
Definition: OSResult.h:2485
OptimizationSolution ** solution
solution is an array of pointers to OptimizationSolution objects
Definition: OSResult.h:2500
~OptimizationResult()
Class destructor.
int numberOfConstraints
numberOfConstrants is the number of constraint functions reported in the solution.
Definition: OSResult.h:2495
The OptimizationSolution Class.
Definition: OSResult.h:2264
VariableSolution * variables
variables holds the solution information for the variables
Definition: OSResult.h:2291
OptimizationSolution()
Default constructor.
ObjectiveSolution * objectives
objectives holds the solution information for the objectives
Definition: OSResult.h:2300
int targetObjectiveIdx
the index of the objective function for which we are reporting solution information
Definition: OSResult.h:2270
std::vector< OtherOptimizationResult * > other
other is a pointer to an array of OtherOptimizationResult objects associated with this optimization s...
Definition: OSResult.h:1220
~OptimizationSolution()
Class destructor.
ConstraintSolution * constraints
constraints holds the solution information for the constraints
Definition: OSResult.h:2295
OptimizationSolutionStatus * status
status is a pointer to an OptimizationSolutionStatus object associated with this optimization solutio...
Definition: OSResult.h:2283
int numberOfOtherResults
the number of other results associated with this solution
Definition: OSResult.h:1192
std::string message
a message associated with this solution
Definition: OSResult.h:2286
The OptimizationSolutionStatus Class.
Definition: OSResult.h:793
std::vector< OptimizationSolutionSubstatus * > substatus
a pointer to an array of substatus objects
Definition: OSResult.h:394
int numberOfSubstatuses
the number of substatus objects
Definition: OSResult.h:797
std::string description
a description of the solution status type
Definition: OSResult.h:803
OptimizationSolutionStatus()
Default constructor.
std::string type
the type of solution status
Definition: OSResult.h:800
~OptimizationSolutionStatus()
Class destructor.
The OptimizationSolutionSubstatus Class.
Definition: OSResult.h:744
std::string namee
the name of the solution substatus
Definition: OSResult.h:351
std::string description
a description of the solution substatus
Definition: OSResult.h:751
~OptimizationSolutionSubstatus()
Class destructor.
OptimizationSolutionSubstatus()
Default constructor.
The OtherConResult Class.
Definition: OSResult.h:1710
int idx
idx is the index on the constraint
Definition: OSResult.h:1714
~OtherConResult()
Class destructor.
OtherConResult()
Default constructor.
std::string value
value is a value associated with the constraint indexed by idx, for example value might be the value ...
Definition: OSResult.h:1724
The OtherConstraintResult Class.
Definition: OSResult.h:1768
std::vector< OtherConResult * > con
Definition: OSResult.h:1066
std::string description
a brief description of the type of result
Definition: OSResult.h:1793
OtherConstraintResult()
Default constructor.
int numberOfCon
the number of constraints which have values for this particular type of result
Definition: OSResult.h:1774
~OtherConstraintResult()
Class destructor.
std::string name
the name of the result the user is defining
Definition: OSResult.h:1782
std::string value
this element allows a specific value associated with this particular type of result
Definition: OSResult.h:1787
The OtherObjResult Class.
Definition: OSResult.h:1388
~OtherObjResult()
Class destructor.
OtherObjResult()
Default constructor.
std::string value
value is a value associated with an objective function indexed by idx
Definition: OSResult.h:1400
int idx
idx is the index on a objective function
Definition: OSResult.h:1392
The OtherObjectiveResult Class.
Definition: OSResult.h:1444
std::string value
this element allows a specific value associated with this particular type of result
Definition: OSResult.h:1463
OtherObjectiveResult()
Default constructor.
std::string description
a brief description of the type of result
Definition: OSResult.h:1469
std::vector< OtherObjResult * > obj
Definition: OSResult.h:840
int numberOfObj
the number of objectives which have values for this particular type of result
Definition: OSResult.h:1450
~OtherObjectiveResult()
Class destructor.
std::string name
the name of the result the user is defining
Definition: OSResult.h:1458
The OtherOptimizationResult Class.
Definition: OSResult.h:1141
std::string description
a brief description of the type of result
Definition: OSResult.h:1148
std::string value
this element allows a specific value associated with this particular type of result
Definition: OSResult.h:1153
~OtherOptimizationResult()
Class destructor.
OtherOptimizationResult()
Default constructor.
std::string name
the name of the result the user is defining
Definition: OSResult.h:1145
OtherVarResult Class.
Definition: OSResult.h:1066
OtherVarResult()
Default constructor.
std::string value
value holds a general value associated with a variable, for example, rather than the value of a varia...
Definition: OSResult.h:1081
~OtherVarResult()
Class destructor.
int idx
the index of a variable in the solution
Definition: OSResult.h:1070
The OtherVariableResult Class.
Definition: OSResult.h:1125
OtherVariableResult()
Default constructor.
std::string value
this element allows a specific value associated with this particular type of result
Definition: OSResult.h:1144
~OtherVariableResult()
Class destructor.
std::string description
a brief description of the type of result
Definition: OSResult.h:1150
std::string name
the name of the result the user is defining
Definition: OSResult.h:1139
int numberOfVar
the number of variables which have values for this particular type of result
Definition: OSResult.h:1131
std::vector< OtherVarResult * > var
Definition: OSResult.h:631
The ServiceResult Class.
Definition: OSResult.h:416
~ServiceResult()
Class destructor.
ServiceResult()
Default constructor.
The SystemResult Class.
Definition: OSResult.h:350
~SystemResult()
Class destructor.
SystemResult()
Default constructor.
The Time Class.
Definition: OSResult.h:221
~Time()
Class destructor.
Definition: OSResult.cpp:163
std::string type
The type of timer used (cpuTime/elapsedTime/other)
Definition: OSResult.h:228
std::string unit
The unit of time (tick/millisecond/second/minute/hour/day/week/month/year)
Definition: OSResult.h:240
std::string description
Further description on the timer used.
Definition: OSResult.h:246
double value
The time measurement.
Definition: OSResult.h:252
Time()
Default constructor.
Definition: OSResult.cpp:150
std::string category
The category of time (total/input/preprocessing/optimization/postprocessing/output/other)
Definition: OSResult.h:234
The TimingInformation Class.
Definition: OSResult.h:605
~TimingInformation()
Class destructor.
TimingInformation()
Default constructor.
int numberOfTimes
The number of elements in the time array.
Definition: OSResult.h:612
Time ** time
An array of time measurements.
Definition: OSResult.h:285
VarStringValue Class.
Definition: OSResult.h:494
std::string value
Definition: OSResult.h:503
VarStringValue()
Default constructor.
~VarStringValue()
Class destructor.
int idx
idx is the index on variable in the solution
Definition: OSResult.h:498
VarValue Class.
Definition: OSResult.h:848
VarValue()
Default constructor.
int idx
idx is the index on variable in the solution
Definition: OSResult.h:852
~VarValue()
Class destructor.
double value
Definition: OSResult.h:860
The VariableSolution Class.
Definition: OSResult.h:1218
VariableStringValues * valuesString
a pointer to an array of VariableStringValues objects
Definition: OSResult.h:671
VariableSolution()
Default constructor.
OtherVariableResult ** other
a pointer to an array of other pointer objects for variables
Definition: OSResult.h:1238
int numberOfOtherVariableResults
the number of types of variable results other than the value of the variable
Definition: OSResult.h:1224
~VariableSolution()
Class destructor.
VariableValues * values
a pointer to a VariableValues object
Definition: OSResult.h:1227
The VariableStringValues Class.
Definition: OSResult.h:530
~VariableStringValues()
Class destructor.
int numberOfVar
the number of variable values that are in the solution
Definition: OSResult.h:535
std::vector< VarStringValue * > var
a vector of VarValue objects, there will be one for each variable in the solution
Definition: OSResult.h:540
VariableStringValues()
Default constructor.
The VariableValues Class.
Definition: OSResult.h:902
VariableValues()
Default constructor.
int numberOfVar
the number of variable values that are in the solution
Definition: OSResult.h:907
~VariableValues()
Class destructor.
std::vector< VarValue * > var
a vector of VarValue objects, there will be one for each variable in the solution
Definition: OSResult.h:465