DicFile Class Reference

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

#include <DicFile.h>

Inherits CifFile.

Inheritance diagram for DicFile:

[legend]Collaboration diagram for DicFile:

[legend]List of all members.

Public Member Functions
	DicFile (const eFileMode fileMode, const std::string &objFileName, const bool verbose=false, const Char::eCompareType caseSense=Char::eCASE_SENSITIVE, const unsigned int maxLineLength=STD_CIF_LINE_LENGTH, const std::string &nullValue=CifString::UnknownValue)
	DicFile (const bool verbose=false, const Char::eCompareType caseSense=Char::eCASE_SENSITIVE, const unsigned int maxLineLength=STD_CIF_LINE_LENGTH, const std::string &nullValue=CifString::UnknownValue)
	~DicFile ()
void	WriteItemAliases (const std::string &fileName)
ISTable *	GetFormatTable ()
int	WriteFormatted (const std::string &cifFileName, ISTable *formatP=NULL)
int	WriteFormatted (const std::string &cifFileName, TableFile *ddl, ISTable *formatP=NULL)
void	Compress (CifFile *ddl)
CifFile *	GetRefFile ()
Protected Member Functions
int	WriteFormatted (std::ostream &cifo, ISTable *formatP)
int	WriteFormatted (std::ostream &cifo, TableFile *ddl, ISTable *formatP)
void	WriteItemAliases (std::ostream &cifo)
Protected Attributes
ISTable *	_formatP
Private Member Functions
void	AddRefRow (ISTable &table, const char *first, const char *second, const char *third)

---

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 CifFile class, this class provides a method for writing the content of "item_aliases" table to a text file.

---

Constructor & Destructor Documentation

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

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 specified, 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::UnknownValue is used.

Returns:

Not applicable

Precondition:

None

Postcondition:

None

Exceptions:

None

DicFile::DicFile	(	const bool	verbose = false,
		const Char::eCompareType	caseSense = Char::eCASE_SENSITIVE,
		const unsigned int	maxLineLength = STD_CIF_LINE_LENGTH,
		const std::string &	nullValue = CifString::UnknownValue
	)

Constructs a dictionary file in virtual mode.

Parameters:

[in]	verbose	- optional parameter that indicates whether logging should be turned on (if true) or off (if false). If verbose is not specified, 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::UnknownValue 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::AddRefRow	(	ISTable &	table,
		const char *	first,
		const char *	second,
		const char *	third
	)			[private]

void DicFile::Compress

(

CifFile *

ddl

)

Method, not currently part of users public API, and will soon be re-examined.

ISTable * DicFile::GetFormatTable

(

)

Method, not currently part of users public API, and will soon be re-examined.

CifFile * DicFile::GetRefFile

(

)

int DicFile::WriteFormatted	(	std::ostream &	cifo,
		TableFile *	ddl,
		ISTable *	formatP
	)			[protected]

int DicFile::WriteFormatted	(	std::ostream &	cifo,
		ISTable *	formatP
	)			[protected]

int DicFile::WriteFormatted	(	const std::string &	cifFileName,
		TableFile *	ddl,
		ISTable *	formatP = NULL
	)

Method, not currently part of users public API, and will soon be re-examined.

int DicFile::WriteFormatted	(	const std::string &	cifFileName,
		ISTable *	formatP = NULL
	)

Method, not currently part of users public API, and will soon be re-examined.

void DicFile::WriteItemAliases

(

std::ostream &

cifo

)

[protected]

void DicFile::WriteItemAliases

(

const std::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

---

Member Data Documentation

ISTable* DicFile::_formatP [protected]

---

The documentation for this class was generated from the following files:

• DicFile.h
• DicFile.C

---