My Project
PathPairs Class Reference

the PathPairs class. More...

#include <OSOption.h>

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 deepCopyFrom (PathPairs *that)
 A function to make a deep copy of an 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, 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 910 of file OSOption.h.

Constructor & Destructor Documentation

◆ PathPairs()

PathPairs::PathPairs ( )

Default constructor.

Definition at line 327 of file OSOption.cpp.

◆ ~PathPairs()

PathPairs::~PathPairs ( )

Class destructor.

Definition at line 336 of file OSOption.cpp.

Member Function Documentation

◆ IsEqual()

bool PathPairs::IsEqual ( PathPairs * that)

A function to check for the equality of two objects.

Definition at line 10475 of file OSOption.cpp.

◆ setRandom()

bool PathPairs::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 12557 of file OSOption.cpp.

◆ deepCopyFrom()

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

◆ setPathPair() [1/2]

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

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

Parameters
numberOfPathPairsnumber of <pathPair> elements to be set
paththe array of <pathPair> elements that are to be set

Definition at line 4827 of file OSOption.cpp.

◆ setPathPair() [2/2]

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

Alternate signature for this function.

Parameters
fromarray containing a list of objects to be moved
toarray containing a list of destinations
makeCopyrecords whether each object is to be moved or copied
numberOfPathPairsnumber of <pathPair> elements to be set

Definition at line 4861 of file OSOption.cpp.

◆ addPathPair()

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

A function to add a <pathPair> element.

Parameters
fromPaththe path from which to copy or move
toPaththe path to which to copy or move
makecopytracks whether a copy is to be made

Definition at line 4890 of file OSOption.cpp.

Member Data Documentation

◆ numberOfPathPairs

int PathPairs::numberOfPathPairs

the number of <path> children

Definition at line 915 of file OSOption.h.

◆ pathPair

PathPair** PathPairs::pathPair

the list of directory and file paths

Definition at line 918 of file OSOption.h.


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