a data structure that holds general information about files that conform to one of the OSxL schemas More...
#include <OSGeneral.h>
Public Member Functions | |
| GeneralFileHeader () | |
| Constructor. More... | |
| ~GeneralFileHeader () | |
| Default destructor. More... | |
| bool | IsEqual (GeneralFileHeader *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 (GeneralFileHeader *that) |
| A function to make a deep copy of an instance of this class. More... | |
| std::string | getHeaderItem (std::string item) |
| A function to retrieve a data item contained in this class. More... | |
| bool | setHeader (std::string name, std::string source, std::string description, std::string fileCreator, std::string licence) |
| A function to populate an instance of this class. More... | |
Public Attributes | |
| std::string | name |
| used to give a name to the file or the problem contained within it More... | |
| std::string | source |
| used when the file or problem appeared in the literature (could be in BiBTeX format or similar) More... | |
| std::string | description |
| further information about the file or the problem contained within it More... | |
| std::string | fileCreator |
| name(s) of author(s) who created this file More... | |
| std::string | licence |
| licensing information if applicable More... | |
Detailed Description
a data structure that holds general information about files that conform to one of the OSxL schemas
Definition at line 32 of file OSGeneral.h.
Constructor & Destructor Documentation
| GeneralFileHeader::GeneralFileHeader | ( | ) |
Constructor.
Definition at line 30 of file OSGeneral.cpp.
| GeneralFileHeader::~GeneralFileHeader | ( | ) |
Default destructor.
Definition at line 39 of file OSGeneral.cpp.
Member Function Documentation
| bool GeneralFileHeader::IsEqual | ( | GeneralFileHeader * | that | ) |
A function to check for the equality of two objects.
Definition at line 46 of file OSGeneral.cpp.
| bool GeneralFileHeader::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 100 of file OSGeneral.cpp.
| bool GeneralFileHeader::deepCopyFrom | ( | GeneralFileHeader * | 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 110 of file OSGeneral.cpp.
| std::string GeneralFileHeader::getHeaderItem | ( | std::string | item | ) |
A function to retrieve a data item contained in this class.
- Parameters
-
item,: the type of information sought (name, source, description, fileCreator, licence)
Definition at line 123 of file OSGeneral.cpp.
| bool GeneralFileHeader::setHeader | ( | std::string | name, |
| std::string | source, | ||
| std::string | description, | ||
| std::string | fileCreator, | ||
| std::string | licence | ||
| ) |
A function to populate an instance of this class.
- Parameters
-
name,: the name of this file or instance source,: the source (e.g., in BiBTeX format) description,: further description about this file and/or its contents fileCreator,: the creator of this file licence,: licence information if applicable
Definition at line 133 of file OSGeneral.cpp.
Member Data Documentation
| std::string GeneralFileHeader::name |
used to give a name to the file or the problem contained within it
Definition at line 39 of file OSGeneral.h.
| std::string GeneralFileHeader::source |
used when the file or problem appeared in the literature (could be in BiBTeX format or similar)
Definition at line 45 of file OSGeneral.h.
| std::string GeneralFileHeader::description |
further information about the file or the problem contained within it
Definition at line 50 of file OSGeneral.h.
| std::string GeneralFileHeader::fileCreator |
name(s) of author(s) who created this file
Definition at line 55 of file OSGeneral.h.
| std::string GeneralFileHeader::licence |
licensing information if applicable
Definition at line 60 of file OSGeneral.h.
The documentation for this class was generated from the following files:
- /tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSGeneral.h
- /tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSGeneral.cpp
