DdlFile Class Reference

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

#include <DdlFile.h>

Inherits CifFile.

Inherited by DicFile.

Inheritance diagram for DdlFile:

[legend]Collaboration diagram for DdlFile:

[legend]List of all members.

Public Member Functions
	DdlFile (const eFileMode fileMode, const string &fileName, const bool verbose=false, const StringCompare::eCompareType caseSense=StringCompare::eCASE_SENSITIVE, const unsigned int maxLineLength=STD_CIF_LINE_LENGTH, const string &nullValue=CifString::NullValue)
	DdlFile (const bool verbose=false, const StringCompare::eCompareType caseSense=StringCompare::eCASE_SENSITIVE, const unsigned int maxLineLength=STD_CIF_LINE_LENGTH, const string &nullValue=CifString::NullValue)
	~DdlFile ()
ISTable *	GetFormatTable ()
int	WriteFormatted (const string &cifFileName, ISTable *formatP=NULL)
int	WriteFormatted (const string &cifFileName, TableFile *ddl, ISTable *formatP=NULL)
void	Compress (DdlFile *ddl)
Protected Member Functions
int	WriteFormatted (ostream &cifo, ISTable *formatP)
int	WriteFormatted (ostream &cifo, TableFile *ddl, ISTable *formatP)
Protected Attributes
ISTable *	_formatP

---

Detailed Description

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

This class represents a DDL file. In addition to inherited methods from CifFile class, this class provides methods for writing formatted data to a text file.

---

Constructor & Destructor Documentation

DdlFile::DdlFile	(	const eFileMode	fileMode,
		const string &	fileName,
		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 DDL file.

Parameters:

[in]	fileMode	- DDL 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::NullValue is used.

Returns:

Not applicable

Precondition:

None

Postcondition:

None

Exceptions:

None

DdlFile::DdlFile	(	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 DDL 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::NullValue is used.

Returns:

Not applicable

Precondition:

None

Postcondition:

None

Exceptions:

None

DdlFile::~DdlFile

(

)

Destructs a DDL file, by releasing all consumed resources.

Parameters:

Not applicable

Returns:

Not applicable

Precondition:

None

Postcondition:

None

Exceptions:

None

---

Member Function Documentation

ISTable * DdlFile::GetFormatTable

(

)

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

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

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

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

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

void DdlFile::Compress

(

DdlFile *

ddl

)

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

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

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

---

Member Data Documentation

ISTable* DdlFile::_formatP [protected]

---

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

• DdlFile.h
• DdlFile.C

---