My Project
InstanceLocationOption Class Reference

the InstanceLocationOption class. More...

#include <OSOption.h>

Public Member Functions

 InstanceLocationOption ()
 Default constructor.
 
 ~InstanceLocationOption ()
 Class destructor.
 
bool IsEqual (InstanceLocationOption *that)
 A function to check for the equality of two objects.
 
bool setRandom (double density, bool conformant)
 A function to make a random instance of this class.
 
bool deepCopyFrom (InstanceLocationOption *that)
 A function to make a deep copy of an instance of this class.
 

Public Attributes

std::string locationType
 the type of the location
 
std::string value
 the value of the <instanceLocation> element
 

Detailed Description

the InstanceLocationOption class.

Author
Robert Fourer, Horand Gassmann, Jun Ma, Kipp Martin
Version
1.0, 21/07/2008
Since
OS 1.1
Remarks
A data structure class that corresponds to the instanceLocation element in the OSoL schema.

Definition at line 39 of file OSOption.h.

Constructor & Destructor Documentation

◆ InstanceLocationOption()

InstanceLocationOption::InstanceLocationOption ( )

Default constructor.

Definition at line 32 of file OSOption.cpp.

◆ ~InstanceLocationOption()

InstanceLocationOption::~InstanceLocationOption ( )

Class destructor.

Definition at line 41 of file OSOption.cpp.

Member Function Documentation

◆ IsEqual()

bool InstanceLocationOption::IsEqual ( InstanceLocationOption * that)

A function to check for the equality of two objects.

Definition at line 9978 of file OSOption.cpp.

◆ setRandom()

bool InstanceLocationOption::setRandom ( double density,
bool conformant )

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)

Definition at line 12444 of file OSOption.cpp.

◆ deepCopyFrom()

bool InstanceLocationOption::deepCopyFrom ( InstanceLocationOption * 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

Definition at line 13577 of file OSOption.cpp.

Member Data Documentation

◆ locationType

std::string InstanceLocationOption::locationType

the type of the location

Definition at line 44 of file OSOption.h.

◆ value

std::string InstanceLocationOption::value

the value of the <instanceLocation> element

Definition at line 47 of file OSOption.h.


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