My Project
DirectoriesAndFiles Class Reference

the DirectoriesAndFiles class. More...

#include <OSOption.h>

Public Member Functions

 DirectoriesAndFiles ()
 Default constructor.
 
 ~DirectoriesAndFiles ()
 Class destructor.
 
bool IsEqual (DirectoriesAndFiles *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 (DirectoriesAndFiles *that)
 A function to make a deep copy of an instance of this class.
 
bool setPath (int numberOfPaths, std::string *path)
 A function to set an array of <path> elements.
 
bool addPath (std::string path)
 A function to add a <path> element.
 

Public Attributes

int numberOfPaths
 the number of <path> children
 
std::string * path
 the list of directory and file paths
 

Detailed Description

the DirectoriesAndFiles 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 an xml element in the OSoL schema.

Definition at line 780 of file OSOption.h.

Constructor & Destructor Documentation

◆ DirectoriesAndFiles()

DirectoriesAndFiles::DirectoriesAndFiles ( )

Default constructor.

Definition at line 287 of file OSOption.cpp.

◆ ~DirectoriesAndFiles()

DirectoriesAndFiles::~DirectoriesAndFiles ( )

Class destructor.

Definition at line 296 of file OSOption.cpp.

Member Function Documentation

◆ IsEqual()

bool DirectoriesAndFiles::IsEqual ( DirectoriesAndFiles * that)

A function to check for the equality of two objects.

Definition at line 10418 of file OSOption.cpp.

◆ setRandom()

bool DirectoriesAndFiles::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 12537 of file OSOption.cpp.

◆ deepCopyFrom()

bool DirectoriesAndFiles::deepCopyFrom ( DirectoriesAndFiles * 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 13654 of file OSOption.cpp.

◆ setPath()

bool DirectoriesAndFiles::setPath ( int numberOfPaths,
std::string * path )

A function to set an array of <path> elements.

Parameters
numberOfPathsnumber of <path> elements to be set
paththe array of <path> elements that are to be set

Definition at line 4752 of file OSOption.cpp.

◆ addPath()

bool DirectoriesAndFiles::addPath ( std::string path)

A function to add a <path> element.

Parameters
paththe path to be added

Definition at line 4787 of file OSOption.cpp.

Member Data Documentation

◆ numberOfPaths

int DirectoriesAndFiles::numberOfPaths

the number of <path> children

Definition at line 785 of file OSOption.h.

◆ path

std::string* DirectoriesAndFiles::path

the list of directory and file paths

Definition at line 788 of file OSOption.h.


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