OS  2.10.1
Public Member Functions | Public Attributes | List of all members
ContactOption Class Reference

the ContactOption class. More...

#include <OSOption.h>

+ Collaboration diagram for ContactOption:

Public Member Functions

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

Public Attributes

std::string transportType
 the contact mechanism More...
 
std::string value
 the value of the <contact> element More...
 

Detailed Description

the ContactOption 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 contact method in the OSoL schema.

Definition at line 96 of file OSOption.h.

Constructor & Destructor Documentation

§ ContactOption()

ContactOption::ContactOption ( )

Default constructor.

§ ~ContactOption()

ContactOption::~ContactOption ( )

Class destructor.

Member Function Documentation

§ IsEqual()

bool ContactOption::IsEqual ( ContactOption that)

A function to check for the equality of two objects.

§ setRandom()

bool ContactOption::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)

§ deepCopyFrom()

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

Member Data Documentation

§ transportType

std::string ContactOption::transportType

the contact mechanism

Definition at line 101 of file OSOption.h.

§ value

std::string ContactOption::value

the value of the <contact> element

Definition at line 104 of file OSOption.h.


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