DtFedReader Class Reference

Instances of DtFedReader are used to read a FED file, and fill in a DtFedTarget with the information read. More...

Inheritance diagram for DtFedReader:

Collaboration diagram for DtFedReader:

Public Member Functions
	DtFedReader ()
	Constructor.
virtual	~DtFedReader ()
	Destructor.
virtual DtFedReadStatus	readFed (const char *fedFileName, DtFedTarget *fedTarget, unsigned int strictCheckingMask=DtFedReadStrictDisabled, bool useDTD=false, bool dontParseSwitches=false)
	Read the FED file fedFileName, setting values to fedTarget.
virtual DtFedReadStatus	readFedFilePtr (FILE *fedFilePtr, DtFedTarget *fedTarget, DtFilename filename, unsigned int strictCheckingMask=DtFedReadStrictDisabled, bool useDTD=false, bool dontParseSwitches=false)=0
	Read the FED file from the FILE*, setting values to fedTarget.
virtual FILE *	openFedFileWithErrCheck (const char *fileName, bool isBinary=false)
	get the a file handle to the FED File for reading in text or binary mode
virtual unsigned int	setStrictChecking (unsigned int checkMask)
	Set status of strict checking.
virtual bool	strictChecking (unsigned int checkMask) const
	Returns bool: strictChecking enabled for types of checks provided.
virtual void	setExpectedFomType (DtFomType fomType)
	Set/Get expected FOM type.
virtual DtFomType	expectedFomType () const
virtual DtFomType	lastFomType () const
	Returns the FOM type of the last FOM read.
virtual const DtString &	lastError () const
	Get the last error.
char *	takeCurrFddData ()

Static Public Member Functions
static DtFomType	checkFomType (const char *fedFileName, void *fedFilePtr)
	Get the FOM Type.
static FILE *	openFedFile (const char *fileName, bool isBinary=false)
	Open file from name and return FILE*.
static bool	readFileIntoBuffer (FILE *fileHandle, char **fileBuffer, unsigned int *fileSize)
	Read the file from the FILE* into the buffer.

Public Attributes
char *	myCurrFddBuffer
	Buffer containing the most recently read FDD file.
unsigned int	myCurrFddBufferSize
	Size of the buffer for the most recently read FDD file.

Protected Member Functions
void	appendErrorLine (xmlNode *node, DtString &output) const

Protected Attributes
DtFedTarget *	myFedTarget
DtFedReader *	myChildReader
unsigned int	myStrictChecking
bool	myDontParseSwitchTable
DtFomType	myExpectedFomType
	When set, the FOM must conform to this type.
DtFomType	myLastFomType
	The type of FOM format that was last read.
DtString	myLastError
	Description of last encountered error.

Private Member Functions
	DtFedReader (const DtFedReader &)
	Copy constructor and Assignment operator - Unimplemented.
DtFedReader &	operator= (const DtFedReader &)

Detailed Description

Instances of DtFedReader are used to read a FED file, and fill in a DtFedTarget with the information read.

Base class for contained file format specific (i.e. - mtl and xml) FED file readers

Constructor & Destructor Documentation

DtFedReader::DtFedReader

(

)

Constructor.

virtual DtFedReader::~DtFedReader ( )

virtual

Destructor.

DtFedReader::DtFedReader ( const DtFedReader &  )

private

Copy constructor and Assignment operator - Unimplemented.

Member Function Documentation

void DtFedReader::appendErrorLine ( xmlNode *  node, DtString &  output  ) const

protected

static DtFomType DtFedReader::checkFomType ( const char *  fedFileName, void *  fedFilePtr  )

static

Get the FOM Type.

virtual DtFomType DtFedReader::expectedFomType ( ) const

virtual

virtual const DtString& DtFedReader::lastError ( ) const

virtual

Get the last error.

virtual DtFomType DtFedReader::lastFomType ( ) const

virtual

Returns the FOM type of the last FOM read.

static FILE* DtFedReader::openFedFile ( const char *  fileName, bool  isBinary = false  )

static

Open file from name and return FILE*.

virtual FILE* DtFedReader::openFedFileWithErrCheck ( const char *  fileName, bool  isBinary = false  )

virtual

get the a file handle to the FED File for reading in text or binary mode

DtFedReader& DtFedReader::operator= ( const DtFedReader &  )

private

virtual DtFedReadStatus DtFedReader::readFed ( const char *  fedFileName, DtFedTarget *  fedTarget, unsigned int  strictCheckingMask = DtFedReadStrictDisabled, bool  useDTD = false, bool  dontParseSwitches = false  )

virtual

Read the FED file fedFileName, setting values to fedTarget.

Note if fedTarget is NULL the fedfile will be read and verified only.

virtual DtFedReadStatus DtFedReader::readFedFilePtr ( FILE *  fedFilePtr, DtFedTarget *  fedTarget, DtFilename  filename, unsigned int  strictCheckingMask = DtFedReadStrictDisabled, bool  useDTD = false, bool  dontParseSwitches = false  )

pure virtual

Read the FED file from the FILE*, setting values to fedTarget.

Note if fedTarget is NULL the fedfile will be read and verified only.

Implemented in DtFedReader1516e, DtFedReader1516, DtXmlFedReader, DtXmlFedReader1516e, DtFedReader13, and DtMtlFedReader.

static bool DtFedReader::readFileIntoBuffer ( FILE *  fileHandle, char **  fileBuffer, unsigned int *  fileSize  )

static

Read the file from the FILE* into the buffer.

virtual void DtFedReader::setExpectedFomType ( DtFomType  fomType )

virtual

Set/Get expected FOM type.

virtual unsigned int DtFedReader::setStrictChecking ( unsigned int  checkMask )

virtual

Set status of strict checking.

Use Enums to OR together desired checks Returns the previous value of strict checking

virtual bool DtFedReader::strictChecking ( unsigned int  checkMask ) const

virtual

Returns bool: strictChecking enabled for types of checks provided.

char* DtFedReader::takeCurrFddData

(

)

Member Data Documentation

DtFedReader* DtFedReader::myChildReader

protected

char* DtFedReader::myCurrFddBuffer

Buffer containing the most recently read FDD file.

unsigned int DtFedReader::myCurrFddBufferSize

Size of the buffer for the most recently read FDD file.

bool DtFedReader::myDontParseSwitchTable

protected

DtFomType DtFedReader::myExpectedFomType

protected

When set, the FOM must conform to this type.

DtFedTarget* DtFedReader::myFedTarget

protected

DtString DtFedReader::myLastError

protected

Description of last encountered error.

DtFomType DtFedReader::myLastFomType

protected

The type of FOM format that was last read.

unsigned int DtFedReader::myStrictChecking

protected

---

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

• fedReader.h