OS  2.10.1
Public Member Functions | Public Attributes | List of all members
GeneralFileHeader Class Reference

a data structure that holds general information about files that conform to one of the OSxL schemas More...

#include <OSGeneral.h>

+ Collaboration diagram for GeneralFileHeader:

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::GeneralFileHeader ( )

Constructor.

◆ ~GeneralFileHeader()

GeneralFileHeader::~GeneralFileHeader ( )

Default destructor.

Member Function Documentation

◆ IsEqual()

bool GeneralFileHeader::IsEqual ( GeneralFileHeader that)

A function to check for the equality of two objects.

◆ setRandom()

bool GeneralFileHeader::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)

◆ deepCopyFrom()

bool GeneralFileHeader::deepCopyFrom ( GeneralFileHeader 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

◆ getHeaderItem()

std::string GeneralFileHeader::getHeaderItem ( std::string  item)

A function to retrieve a data item contained in this class.

Parameters
itemthe type of information sought (name, source, description, fileCreator, licence)

◆ setHeader()

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
namethe name of this file or instance
sourcethe source (e.g., in BiBTeX format)
descriptionfurther description about this file and/or its contents
fileCreatorthe creator of this file
licencelicence information if applicable

Member Data Documentation

◆ name

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.

◆ source

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.

◆ description

std::string GeneralFileHeader::description

further information about the file or the problem contained within it

Definition at line 50 of file OSGeneral.h.

◆ fileCreator

std::string GeneralFileHeader::fileCreator

name(s) of author(s) who created this file

Definition at line 55 of file OSGeneral.h.

◆ licence

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 file: