#include <OSOption.h>
Public Member Functions | |
| PathPairs () | |
| Default constructor. More... | |
| ~PathPairs () | |
| Class destructor. More... | |
| bool | IsEqual (PathPairs *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 (PathPairs *that) |
| A function to make a deep copy of an instance of this class. More... | |
| bool | setPathPair (int numberOfPathPairs, PathPair **pathPair) |
| A function to set an array of <pathPair> elements. More... | |
| bool | setPathPair (std::string *from, std::string *to, bool *makeCopy, int numberOfPathPairs) |
| Alternate signature for this function. More... | |
| bool | addPathPair (std::string fromPath, std::string toPath, bool makeCopy) |
| A function to add a <pathPair> element. More... | |
Public Attributes | |
| int | numberOfPathPairs |
| the number of <path> children More... | |
| PathPair ** | pathPair |
| the list of directory and file paths More... | |
Detailed Description
the PathPairs class.
- 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 | ( | ) |
Default constructor.
Definition at line 327 of file OSOption.cpp.
| PathPairs::~PathPairs | ( | ) |
Class destructor.
Definition at line 336 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 10475 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 12557 of file OSOption.cpp.
| bool PathPairs::deepCopyFrom | ( | PathPairs * | that | ) |
A function to make a deep copy of an instance of this class.
- Parameters
-
that,: the instance from which information is to be copied
- Returns
- whether the copy was created successfully
Definition at line 13674 of file OSOption.cpp.
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 4827 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 4861 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 4890 of file OSOption.cpp.
Member Data Documentation
| int PathPairs::numberOfPathPairs |
the number of <path> children
Definition at line 915 of file OSOption.h.
| 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:
- /tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSOption.h
- /tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSOption.cpp
