DicFile Class Reference

Public class that represents a dictionary file, composed of blocks with tables. More...

#include <DicFile.h>

Inherits DdlFile.

Inheritance diagram for DicFile:

Inheritance graph
[legend]
Collaboration diagram for DicFile:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 DicFile ()
 DicFile (const eFileMode fileMode, const string &objFileName, const bool verbose=false, const StringCompare::eCompareType caseSense=StringCompare::eCASE_SENSITIVE, const unsigned int maxLineLength=STD_CIF_LINE_LENGTH, const string &nullValue=CifString::NullValue)
 ~DicFile ()
void WriteItemAliases (const string &fileName)

Protected Member Functions

void WriteItemAliases (ostream &cifo)

Detailed Description

Public class that represents a dictionary file, composed of blocks with tables.

This class represents a dictionary file. In addition to inherited methods from DdlFile class, this class provides a method for writing the content of "item_aliases" table to a text file.


Constructor & Destructor Documentation

DicFile::DicFile (  ) 

Constructs a dictionary file.

Parameters:
 None
Returns:
Not applicable
Precondition:
None
Postcondition:
Constructed dictionary file has virtual file mode, logging is turned off, case sensitive table names are assumed, maximum line length is set to STD_CIF_LINE_LENGTH, and unknown CIF value character is set to CifString::NullValue.
Exceptions:
 None

DicFile::DicFile ( const eFileMode  fileMode,
const string &  objFileName,
const bool  verbose = false,
const StringCompare::eCompareType  caseSense = StringCompare::eCASE_SENSITIVE,
const unsigned int  maxLineLength = STD_CIF_LINE_LENGTH,
const string &  nullValue = CifString::NullValue 
)

Constructs a dictionary file.

Parameters:
[in] fileMode - dictionary file mode. Possible values are read-only, create, update and virtual. Detailed description of file mode is given in TableFile documentation.
[in] fileName - relative or absolute name of the file where object persistency is maintained. If fileMode specifies virtual mode, this parameter is ignored.
[in] verbose - optional parameter that indicates whether logging should be turned on (if true) or off (if false). If verbose is not spefified, logging is turned off.
[in] caseSense - optional parameter that indicates case sensitivity of table names. Possible values are case sensitive and case in-sensitive. If not specified, case sensitive table names are assumed.
[in] maxLineLength - optional parameter that indicates the maximum number of written characters in one line in the written text file. If not specified, STD_CIF_LINE_LENGTH is used.
[in] nullValue - optional parameter that indicates the character that is to be used to denote unknown value in the written CIF file. If not specified, CifString::NullValue is used.
Returns:
Not applicable
Precondition:
None
Postcondition:
None
Exceptions:
 None

DicFile::~DicFile (  ) 

Destructs a dictionary file, by releasing all consumed resources.

Parameters:
 Not applicable
Returns:
Not applicable
Precondition:
None
Postcondition:
None
Exceptions:
 None


Member Function Documentation

void DicFile::WriteItemAliases ( const string &  fileName  ) 

Writes the content of "item_aliases" table to a text file.

Parameters:
[in] fileName - relative or absolute name of the text file to which the content of "item_aliases" table is to be written to.
Returns:
None
Precondition:
None
Postcondition:
None
Exceptions:
 None

void DicFile::WriteItemAliases ( ostream &  cifo  )  [protected]


The documentation for this class was generated from the following files:
Generated on Tue Apr 24 09:25:37 2007 for cif-file-v1.0 by  doxygen 1.5.1