PathPairs Class Reference

the PathPairs class. More...

#include <OSOption.h>

Collaboration diagram for PathPairs:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 PathPairs ()
 Default constructor.
 ~PathPairs ()
 Class destructor.
bool IsEqual (PathPairs *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 setPathPair (int numberOfPathPairs, PathPair **pathPair)
 A function to set an array of <pathPair> elements.
bool setPathPair (std::string *from, std::string *to, bool *makeCopy, int numberOfPathPairs)
 Alternate signature for this function.
bool addPathPair (std::string fromPath, std::string toPath, bool makeCopy)
 A function to add a <pathPair> element.

Public Attributes

int numberOfPathPairs
 the number of <path> children
PathPair ** pathPair
 the list of directory and file paths

Detailed Description

the PathPairs class.

Author:
Robert Fourer, Gus 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 839 of file OSOption.h.


Constructor & Destructor Documentation

PathPairs::PathPairs (  ) 

Default constructor.

Definition at line 330 of file OSOption.cpp.

PathPairs::~PathPairs (  ) 

Class destructor.

Definition at line 339 of file OSOption.cpp.


Member Function Documentation

bool PathPairs::IsEqual ( PathPairs that  ) 

A function to check for the equality of two objects.

Definition at line 9540 of file OSOption.cpp.

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

A function to make a random instance of this class.

Parameters:
density,: corresponds to the probability that a particular child element is created
conformant,: if true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)

Definition at line 11438 of file OSOption.cpp.

bool PathPairs::setPathPair ( int  numberOfPathPairs,
PathPair **  pathPair 
)

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

Parameters:
numberOfPathPairs,: number of <pathPair> elements to be set
path,: the array of <pathPair> elements that are to be set

Definition at line 4734 of file OSOption.cpp.

bool PathPairs::setPathPair ( std::string *  from,
std::string *  to,
bool *  makeCopy,
int  numberOfPathPairs 
)

Alternate signature for this function.

Parameters:
from,: array containing a list of objects to be moved
to,: array containing a list of destinations
makeCopy,: records whether each object is to be moved or copied
numberOfPathPairs,: number of <pathPair> elements to be set

Definition at line 4768 of file OSOption.cpp.

bool PathPairs::addPathPair ( std::string  fromPath,
std::string  toPath,
bool  makeCopy 
)

A function to add a <pathPair> element.

Parameters:
fromPath,: the path from which to copy or move
toPath,: the path to which to copy or move
makecopy,: tracks whether a copy is to be made

Definition at line 4797 of file OSOption.cpp.


Member Data Documentation

the number of <path> children

Definition at line 844 of file OSOption.h.

the list of directory and file paths

Definition at line 847 of file OSOption.h.


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

Generated on 22 May 2012 by  doxygen 1.6.1