OS  2.10.2
Public Member Functions | Public Attributes | List of all members
OtherOptionOrResultEnumeration Class Reference

#include <OSGeneral.h>

+ Inheritance diagram for OtherOptionOrResultEnumeration:
+ Collaboration diagram for OtherOptionOrResultEnumeration:

Public Member Functions

 OtherOptionOrResultEnumeration ()
 
 ~OtherOptionOrResultEnumeration ()
 
 OtherOptionOrResultEnumeration (int n)
 alternate constructor More...
 
bool IsEqual (OtherOptionOrResultEnumeration *that)
 A function to check for the equality of two objects. More...
 
bool setRandom (double density, bool conformant, int iMin, int iMax)
 A function to make a random instance of this class. More...
 
bool deepCopyFrom (OtherOptionOrResultEnumeration *that)
 A function to make a deep copy of an instance of this class. More...
 
bool setOtherOptionOrResultEnumeration (std::string value, std::string description, int *i, int ni)
 Set the indices for a particular level in an enumeration. More...
 
std::string getValue ()
 Get the value for a particular level in an enumeration. More...
 
std::string getDescription ()
 Get the description for a particular level in an enumeration. More...
 
- Public Member Functions inherited from IntVector
 IntVector ()
 
 ~IntVector ()
 
 IntVector (int n)
 alternate constructor More...
 
bool IsEqual (IntVector *that)
 A method to compare two invectors. More...
 
bool setRandom (double density, bool conformant, int iMin, int iMax)
 A function to make a random instance of this class. More...
 
bool deepCopyFrom (IntVector *that)
 A function to make a deep copy of an instance of this class. More...
 
bool setIntVector (int *i, int ni)
 set values into an IntVector More...
 
bool extendIntVector (int i)
 append a value to an IntVector More...
 
int getNumberOfEl ()
 get the dimension of an IntVector More...
 
int getEl (int j)
 get an entry in the data array of an IntVector More...
 
bool getEl (int *i)
 Get the integer data array of an IntVector. More...
 

Public Attributes

std::string value
 
std::string description
 
- Public Attributes inherited from IntVector
bool bDeleteArrays
 bDeleteArrays is true if we delete the arrays in garbage collection set to true by default More...
 
int numberOfEl
 
int * el
 

Detailed Description

brief an integer vector data structure used in OSOption and OSResult

This class extends IntVector by adding two string-valued elements, value and description

Definition at line 549 of file OSGeneral.h.

Constructor & Destructor Documentation

◆ OtherOptionOrResultEnumeration() [1/2]

OtherOptionOrResultEnumeration::OtherOptionOrResultEnumeration ( )

◆ ~OtherOptionOrResultEnumeration()

OtherOptionOrResultEnumeration::~OtherOptionOrResultEnumeration ( )

◆ OtherOptionOrResultEnumeration() [2/2]

OtherOptionOrResultEnumeration::OtherOptionOrResultEnumeration ( int  n)

alternate constructor

Member Function Documentation

◆ IsEqual()

bool OtherOptionOrResultEnumeration::IsEqual ( OtherOptionOrResultEnumeration that)

A function to check for the equality of two objects.

◆ setRandom()

bool OtherOptionOrResultEnumeration::setRandom ( double  density,
bool  conformant,
int  iMin,
int  iMax 
)

A function to make a random instance of this class.

Parameters
densitycorresponds to the probability that a particular child element is created
conformantif true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)
iMinlowest value (inclusive) that an entry in this vector can take
iMaxgreatest value (inclusive) that an entry in this vector can take

◆ deepCopyFrom()

bool OtherOptionOrResultEnumeration::deepCopyFrom ( OtherOptionOrResultEnumeration that)

A function to make a deep copy of an instance of this class.

Parameters
thatthe instance from which information is to be copied
Returns
whether the copy was created successfully

◆ setOtherOptionOrResultEnumeration()

bool OtherOptionOrResultEnumeration::setOtherOptionOrResultEnumeration ( std::string  value,
std::string  description,
int *  i,
int  ni 
)

Set the indices for a particular level in an enumeration.

Parameters
valuerepresents the value of this enumeration member
descriptionholds additional information about this value
icontains the array of indices
nicontains the number of elements in i

◆ getValue()

std::string OtherOptionOrResultEnumeration::getValue ( )

Get the value for a particular level in an enumeration.

◆ getDescription()

std::string OtherOptionOrResultEnumeration::getDescription ( )

Get the description for a particular level in an enumeration.

Member Data Documentation

◆ value

std::string OtherOptionOrResultEnumeration::value

Definition at line 552 of file OSGeneral.h.

◆ description

std::string OtherOptionOrResultEnumeration::description

Definition at line 553 of file OSGeneral.h.


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