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. | |
~GeneralFileHeader () | |
Default destructor. | |
bool | IsEqual (GeneralFileHeader *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. | |
std::string | getHeaderItem (std::string item) |
A function to retrieve a data item contained in this class. | |
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. | |
Public Attributes | |
std::string | name |
used to give a name to the file or the problem contained within it | |
std::string | source |
used when the file or problem appeared in the literature (could be in BiBTeX format or similar) | |
std::string | description |
further information about the file or the problem contained within it | |
std::string | fileCreator |
name(s) of author(s) who created this file | |
std::string | licence |
licensing information if applicable |
a data structure that holds general information about files that conform to one of the OSxL schemas
Definition at line 29 of file OSGeneral.h.
GeneralFileHeader::GeneralFileHeader | ( | ) |
Constructor.
Definition at line 32 of file OSGeneral.cpp.
GeneralFileHeader::~GeneralFileHeader | ( | ) |
Default destructor.
Definition at line 41 of file OSGeneral.cpp.
bool GeneralFileHeader::IsEqual | ( | GeneralFileHeader * | that | ) |
A function to check for the equality of two objects.
Definition at line 48 of file OSGeneral.cpp.
bool GeneralFileHeader::setRandom | ( | double | density, | |
bool | conformant | |||
) |
A function to make a random instance of this class.
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 96 of file OSGeneral.cpp.
std::string GeneralFileHeader::getHeaderItem | ( | std::string | item | ) |
A function to retrieve a data item contained in this class.
item,: | the type of information sought (name, source, description, fileCreator, licence) |
Definition at line 106 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.
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 115 of file OSGeneral.cpp.
std::string GeneralFileHeader::name |
used to give a name to the file or the problem contained within it
Definition at line 36 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 42 of file OSGeneral.h.
std::string GeneralFileHeader::description |
further information about the file or the problem contained within it
Definition at line 47 of file OSGeneral.h.
std::string GeneralFileHeader::fileCreator |
name(s) of author(s) who created this file
Definition at line 52 of file OSGeneral.h.
std::string GeneralFileHeader::licence |
licensing information if applicable
Definition at line 57 of file OSGeneral.h.