ossimDDFModule Class Reference

The primary class for reading ISO 8211 files. More...

#include <ossimIso8211.h>

Public Member Functions
	ossimDDFModule ()
	The constructor. More...
	~ossimDDFModule ()
	The destructor. More...
int	Open (const char *pszFilename, int bFailQuietly=false)
	Open a ISO 8211 (DDF) file for reading. More...
int	Create (const char *pszFilename)
void	Close ()
	Close an ISO 8211 file. More...
int	Initialize (char chInterchangeLevel='3', char chLeaderIden='L', char chCodeExtensionIndicator='E', char chVersionNumber='1', char chAppIndicator=' ', const char *pszExtendedCharSet=" ! ", int nSizeFieldLength=3, int nSizeFieldPos=4, int nSizeFieldTag=4)
void	Dump (FILE *fp)
	Write out module info to debugging file. More...
ossimDDFRecord *	ReadRecord (void)
	Read one record from the file. More...
void	Rewind (long nOffset=-1)
	Return to first record. More...
ossimDDFFieldDefn *	FindFieldDefn (const char *)
	Fetch the definition of the named field. More...
int	GetFieldCount ()
	Fetch the number of defined fields. More...
ossimDDFFieldDefn *	GetField (int)
	Fetch a field definition by index. More...
void	AddField (ossimDDFFieldDefn *poNewFDefn)
	Add new field definition. More...
int	GetFieldControlLength ()
void	AddCloneRecord (ossimDDFRecord *)
void	RemoveCloneRecord (ossimDDFRecord *)
FILE *	GetFP ()

Private Attributes
FILE *	fpDDF
int	bReadOnly
long	nFirstRecordOffset
char	_interchangeLevel
char	_inlineCodeExtensionIndicator
char	_versionNumber
char	_appIndicator
int	_fieldControlLength
char	_extendedCharSet [4]
long	_recLength
char	_leaderIden
long	_fieldAreaStart
long	_sizeFieldLength
long	_sizeFieldPos
long	_sizeFieldTag
int	nFieldDefnCount
ossimDDFFieldDefn **	papoFieldDefns
ossimDDFRecord *	poRecord
int	nCloneCount
int	nMaxCloneCount
ossimDDFRecord **	papoClones

Detailed Description

The primary class for reading ISO 8211 files.

This class contains all the information read from the DDR record, and is used to read records from the file.

Definition at line 88 of file ossimIso8211.h.

Constructor & Destructor Documentation

ossimDDFModule()

ossimDDFModule::ossimDDFModule

(

)

The constructor.

Definition at line 46 of file ossimDdfmodule.cpp.

References _appIndicator, _extendedCharSet, _fieldAreaStart, _fieldControlLength, _inlineCodeExtensionIndicator, _interchangeLevel, _leaderIden, _recLength, _sizeFieldLength, _sizeFieldPos, _sizeFieldTag, _versionNumber, bReadOnly, fpDDF, nCloneCount, nFieldDefnCount, nMaxCloneCount, papoClones, papoFieldDefns, and poRecord.

{
    nFieldDefnCount = 0;
    papoFieldDefns = NULL;
    poRecord = NULL;

    papoClones = NULL;
    nCloneCount = nMaxCloneCount = 0;

    fpDDF = NULL;
    bReadOnly = true;

    _interchangeLevel = '\0';
    _inlineCodeExtensionIndicator = '\0';
    _versionNumber = '\0';
    _appIndicator = '\0';
    _fieldControlLength = '\0';
    strcpy( _extendedCharSet, " ! " );

    _recLength = 0;
    _leaderIden = 'L';
    _fieldAreaStart = 0;
    _sizeFieldLength = 0;
    _sizeFieldPos = 0;
    _sizeFieldTag = 0;
}

~ossimDDFModule()

ossimDDFModule::~ossimDDFModule

(

)

The destructor.

Definition at line 82 of file ossimDdfmodule.cpp.

References Close().

{
    Close();
}

Member Function Documentation

AddCloneRecord()

void ossimDDFModule::AddCloneRecord

(

ossimDDFRecord *

poRecord

)

Definition at line 647 of file ossimDdfmodule.cpp.

References nCloneCount, nMaxCloneCount, ossimCPLRealloc(), papoClones, and poRecord.

Referenced by ossimDDFRecord::Clone(), and ossimDDFRecord::CloneOn().

{
/* -------------------------------------------------------------------- */
/*      Do we need to grow the container array?                         */
/* -------------------------------------------------------------------- */
    if( nCloneCount == nMaxCloneCount )
    {
        nMaxCloneCount = nCloneCount*2 + 20;
        papoClones = (ossimDDFRecord **) ossimCPLRealloc(papoClones,
                                               nMaxCloneCount * sizeof(void*));
    }

/* -------------------------------------------------------------------- */
/*      Add to the list.                                                */
/* -------------------------------------------------------------------- */
    papoClones[nCloneCount++] = poRecord;
}

AddField()

void ossimDDFModule::AddField

(

ossimDDFFieldDefn *

poNewFDefn

)

Add new field definition.

Field definitions may only be added to DDFModules being used for writing, not those being used for reading. Ownership of the DDFFieldDefn object is taken by the DDFModule.

Parameters

poNewFDefn

definition to be added to the module.

Definition at line 611 of file ossimDdfmodule.cpp.

References nFieldDefnCount, ossimCPLRealloc(), and papoFieldDefns.

{
    nFieldDefnCount++;
    papoFieldDefns = (ossimDDFFieldDefn **) 
        ossimCPLRealloc(papoFieldDefns, sizeof(void*)*nFieldDefnCount);
    papoFieldDefns[nFieldDefnCount-1] = poNewFDefn;
}

Close()

void ossimDDFModule::Close

(

)

Close an ISO 8211 file.

Definition at line 99 of file ossimDdfmodule.cpp.

References fpDDF, nCloneCount, nFieldDefnCount, nMaxCloneCount, papoClones, papoFieldDefns, and poRecord.

Referenced by ossimAdrgHeader::parse(), and ~ossimDDFModule().

{
/* -------------------------------------------------------------------- */
/*      Close the file.                                                 */
/* -------------------------------------------------------------------- */
    if( fpDDF != NULL )
    {
        fclose( fpDDF );
        fpDDF = NULL;
    }

/* -------------------------------------------------------------------- */
/*      Cleanup the working record.                                     */
/* -------------------------------------------------------------------- */
    if( poRecord != NULL )
    {
        delete poRecord;
        poRecord = NULL;
    }

/* -------------------------------------------------------------------- */
/*      Cleanup the clones.  Deleting them will cause a callback to     */
/*      remove them from the list.                                      */
/* -------------------------------------------------------------------- */
    while( nCloneCount > 0 )
        delete papoClones[0];

    nMaxCloneCount = 0;
    free( papoClones );
    papoClones = NULL;
    
/* -------------------------------------------------------------------- */
/*      Cleanup the field definitions.                                  */
/* -------------------------------------------------------------------- */
    int i;

    for( i = 0; i < nFieldDefnCount; i++ )
        delete papoFieldDefns[i];
    free( papoFieldDefns );
    papoFieldDefns = NULL;
    nFieldDefnCount = 0;
}

Create()

int ossimDDFModule::Create

(

const char *

pszFilename

)

Definition at line 381 of file ossimDdfmodule.cpp.

References _appIndicator, _extendedCharSet, _fieldAreaStart, _fieldControlLength, _inlineCodeExtensionIndicator, _interchangeLevel, _leaderIden, _recLength, _sizeFieldLength, _sizeFieldPos, _sizeFieldTag, _versionNumber, bReadOnly, fpDDF, ossimDDFFieldDefn::GenerateDDREntry(), nFieldDefnCount, OSSIM_DDF_FIELD_TERMINATOR, ossimNotify(), ossimNotifyLevel_WARN, and papoFieldDefns.

{
   // CPLAssert( fpDDF == NULL );
    
/* -------------------------------------------------------------------- */
/*      Create the file on disk.                                        */
/* -------------------------------------------------------------------- */
    fpDDF = fopen( pszFilename, "wb+" );
    if( fpDDF == NULL )
    {
       ossimNotify(ossimNotifyLevel_WARN)
          << "Failed to create file %s, check path and permissions."
          << pszFilename << std::endl;
        return false;
    }
    
    bReadOnly = false;

/* -------------------------------------------------------------------- */
/*      Prepare all the field definition information.                   */
/* -------------------------------------------------------------------- */
    int iField;

    _fieldControlLength = 9;
    _recLength = 24 
        + nFieldDefnCount * (_sizeFieldLength+_sizeFieldPos+_sizeFieldTag) 
        + 1;
    
    _fieldAreaStart = _recLength;

    for( iField=0; iField < nFieldDefnCount; iField++ )
    {
        int nLength;

        papoFieldDefns[iField]->GenerateDDREntry( NULL, &nLength );
        _recLength += nLength;
    }

/* -------------------------------------------------------------------- */
/*      Setup 24 byte leader.                                           */
/* -------------------------------------------------------------------- */
    char achLeader[25];

    sprintf( achLeader+0, "%05d", (int) _recLength );
    achLeader[5] = _interchangeLevel;
    achLeader[6] = _leaderIden;
    achLeader[7] = _inlineCodeExtensionIndicator;
    achLeader[8] = _versionNumber;
    achLeader[9] = _appIndicator;
    sprintf( achLeader+10, "%02d", (int) _fieldControlLength );
    sprintf( achLeader+12, "%05d", (int) _fieldAreaStart );
    strncpy( achLeader+17, _extendedCharSet, 3 );
    sprintf( achLeader+20, "%1d", (int) _sizeFieldLength );
    sprintf( achLeader+21, "%1d", (int) _sizeFieldPos );
    achLeader[22] = '0';
    sprintf( achLeader+23, "%1d", (int) _sizeFieldTag );
    fwrite( achLeader, 24, 1, fpDDF );

/* -------------------------------------------------------------------- */
/*      Write out directory entries.                                    */
/* -------------------------------------------------------------------- */
    int nOffset = 0;
    for( iField=0; iField < nFieldDefnCount; iField++ )
    {
        char achDirEntry[12];
        int nLength;

        papoFieldDefns[iField]->GenerateDDREntry( NULL, &nLength );

        strcpy( achDirEntry, papoFieldDefns[iField]->GetName() );
        sprintf( achDirEntry + _sizeFieldTag, "%03d", nLength );
        sprintf( achDirEntry + _sizeFieldTag + _sizeFieldLength, 
                 "%04d", nOffset );
        nOffset += nLength;

        fwrite( achDirEntry, 11, 1, fpDDF );
    }

    char chUT = OSSIM_DDF_FIELD_TERMINATOR;
    fwrite( &chUT, 1, 1, fpDDF );

/* -------------------------------------------------------------------- */
/*      Write out the field descriptions themselves.                    */
/* -------------------------------------------------------------------- */
    for( iField=0; iField < nFieldDefnCount; iField++ )
    {
        char *pachData;
        int nLength;

        papoFieldDefns[iField]->GenerateDDREntry( &pachData, &nLength );
        fwrite( pachData, nLength, 1, fpDDF );
        free( pachData );
    }
    
    return true;
}

Dump()

void ossimDDFModule::Dump

(

FILE *

fp

)

Write out module info to debugging file.

A variety of information about the module is written to the debugging file. This includes all the field and subfield definitions read from the header.

Parameters

fp	The standard io file handle to write to. ie. stderr.

Definition at line 493 of file ossimDdfmodule.cpp.

References _appIndicator, _extendedCharSet, _fieldAreaStart, _fieldControlLength, _inlineCodeExtensionIndicator, _interchangeLevel, _leaderIden, _recLength, _sizeFieldLength, _sizeFieldPos, _sizeFieldTag, _versionNumber, ossimDDFFieldDefn::Dump(), nFieldDefnCount, and papoFieldDefns.

{
    fprintf( fp, "DDFModule:\n" );
    fprintf( fp, "    _recLength = %ld\n", _recLength );
    fprintf( fp, "    _interchangeLevel = %c\n", _interchangeLevel );
    fprintf( fp, "    _leaderIden = %c\n", _leaderIden );
    fprintf( fp, "    _inlineCodeExtensionIndicator = %c\n",
             _inlineCodeExtensionIndicator );
    fprintf( fp, "    _versionNumber = %c\n", _versionNumber );
    fprintf( fp, "    _appIndicator = %c\n", _appIndicator );
    fprintf( fp, "    _extendedCharSet = `%s'\n", _extendedCharSet );
    fprintf( fp, "    _fieldControlLength = %d\n", _fieldControlLength );
    fprintf( fp, "    _fieldAreaStart = %ld\n", _fieldAreaStart );
    fprintf( fp, "    _sizeFieldLength = %ld\n", _sizeFieldLength );
    fprintf( fp, "    _sizeFieldPos = %ld\n", _sizeFieldPos );
    fprintf( fp, "    _sizeFieldTag = %ld\n", _sizeFieldTag );

    for( int i = 0; i < nFieldDefnCount; i++ )
    {
        papoFieldDefns[i]->Dump( fp );
    }
}

FindFieldDefn()

ossimDDFFieldDefn * ossimDDFModule::FindFieldDefn

(

const char *

pszFieldName

)

Fetch the definition of the named field.

This function will scan the DDFFieldDefn's on this module, to find one with the indicated field name.

Parameters

pszFieldName

The name of the field to search for. The comparison is case insensitive.

Returns

A pointer to the request DDFFieldDefn object is returned, or NULL if none matching the name are found. The return object remains owned by the DDFModule, and should not be deleted by application code.

Definition at line 535 of file ossimDdfmodule.cpp.

References ossimDDFFieldDefn::GetName(), nFieldDefnCount, and papoFieldDefns.

Referenced by ossimDDFRecord::CloneOn().

{
    int         i;
    
/* -------------------------------------------------------------------- */
/*      This pass tries to reduce the cost of comparing strings by      */
/*      first checking the first character, and by using strcmp()       */
/* -------------------------------------------------------------------- */
    for( i = 0; i < nFieldDefnCount; i++ )
    {
        const char *pszThisName = papoFieldDefns[i]->GetName();
        
        if( *pszThisName == *pszFieldName
            && strcmp( pszFieldName+1, pszThisName+1) == 0 )
            return papoFieldDefns[i];
    }

/* -------------------------------------------------------------------- */
/*      Now do a more general check.  Application code may not          */
/*      always use the correct name case.                               */
/* -------------------------------------------------------------------- */
    for( i = 0; i < nFieldDefnCount; i++ )
    {
       ossimString s = papoFieldDefns[i]->GetName();
       if( s == pszFieldName )
          return papoFieldDefns[i];
    }

    return NULL;
}

GetField()

ossimDDFFieldDefn * ossimDDFModule::GetField

(

int

i

)

Fetch a field definition by index.

Parameters

i	(from 0 to GetFieldCount() - 1.

Returns

the returned field pointer or NULL if the index is out of range.

Definition at line 631 of file ossimDdfmodule.cpp.

References nFieldDefnCount, and papoFieldDefns.

{
    if( i < 0 || i >= nFieldDefnCount )
        return NULL;
    else
        return papoFieldDefns[i];
}

GetFieldControlLength()

int ossimDDFModule::GetFieldControlLength ( )

inline

Definition at line 122 of file ossimIso8211.h.

References _fieldControlLength.

Referenced by ossimDDFFieldDefn::Initialize().

{ return _fieldControlLength; }

GetFieldCount()

int ossimDDFModule::GetFieldCount ( )

inline

Fetch the number of defined fields.

Definition at line 117 of file ossimIso8211.h.

References nFieldDefnCount.

{ return nFieldDefnCount; }

GetFP()

FILE* ossimDDFModule::GetFP ( )

inline

Definition at line 127 of file ossimIso8211.h.

References fpDDF.

Referenced by ossimDDFRecord::Read().

{ return fpDDF; }

Initialize()

int ossimDDFModule::Initialize	(	char	chInterchangeLevel = '3',
		char	chLeaderIden = 'L',
		char	chCodeExtensionIndicator = 'E',
		char	chVersionNumber = '1',
		char	chAppIndicator = ' ',
		const char *	pszExtendedCharSet = " ! ",
		int	nSizeFieldLength = 3,
		int	nSizeFieldPos = 4,
		int	nSizeFieldTag = 4
	)

Definition at line 353 of file ossimDdfmodule.cpp.

References _appIndicator, _extendedCharSet, _inlineCodeExtensionIndicator, _interchangeLevel, _leaderIden, _sizeFieldLength, _sizeFieldPos, _sizeFieldTag, and _versionNumber.

{
    _interchangeLevel = chInterchangeLevel;
    _leaderIden = chLeaderIden;
    _inlineCodeExtensionIndicator = chCodeExtensionIndicator;
    _versionNumber = chVersionNumber;
    _appIndicator = chAppIndicator;
    strcpy( _extendedCharSet, pszExtendedCharSet );
    _sizeFieldLength = nSizeFieldLength;
    _sizeFieldPos = nSizeFieldPos;
    _sizeFieldTag = nSizeFieldTag;

    return true;
}

Open()

int ossimDDFModule::Open	(	const char *	pszFilename,
		int	bFailQuietly = false
	)

Open a ISO 8211 (DDF) file for reading.

If the open succeeds the data descriptive record (DDR) will have been read, and all the field and subfield definitions will be available.

Parameters

pszFilename	The name of the file to open.
bFailQuietly	If false a CPL Error is issued for non-8211 files, otherwise quietly return NULL.

Returns

false if the open fails or true if it succeeds. Errors messages are issued internally with CPLError().

Definition at line 164 of file ossimDdfmodule.cpp.

Referenced by ossimAdrgHeader::parse().

{
    static const size_t nLeaderSize = 24;

/* -------------------------------------------------------------------- */
/*      Close the existing file if there is one.                        */
/* -------------------------------------------------------------------- */
    if( fpDDF != NULL )
        Close();

    // Check for empty filename.
    if (!pszFilename)
    {
       return false;
    }
    
/* -------------------------------------------------------------------- */
/*      Open the file.                                                  */
/* -------------------------------------------------------------------- */
    fpDDF = fopen( pszFilename, "rb" );

    if( fpDDF == NULL )
    {
        if( !bFailQuietly )
           ossimNotify(ossimNotifyLevel_WARN)
              << "Unable to open DDF file `%s'."
              << pszFilename << std::endl;
        return false;
    }

/* -------------------------------------------------------------------- */
/*      Read the 24 byte leader.                                        */
/* -------------------------------------------------------------------- */
    char        achLeader[nLeaderSize];
    
    if( fread( achLeader, 1, nLeaderSize, fpDDF ) != nLeaderSize )
    {
        fclose( fpDDF );
        fpDDF = NULL;

        if( !bFailQuietly )
           ossimNotify(ossimNotifyLevel_WARN)
              << "Leader is short on DDF file `%s'."
              << pszFilename << std::endl;
        
        return false;
    }

/* -------------------------------------------------------------------- */
/*      Verify that this appears to be a valid DDF file.                */
/* -------------------------------------------------------------------- */
    int         i, bValid = true;

    for( i = 0; i < (int)nLeaderSize; i++ )
    {
        if( achLeader[i] < 32 || achLeader[i] > 126 )
            bValid = false;
    }

    if( achLeader[5] != '1' && achLeader[5] != '2' && achLeader[5] != '3' )
        bValid = false;

    if( achLeader[6] != 'L' )
        bValid = false;
    if( achLeader[8] != '1' && achLeader[8] != ' ' )
        bValid = false;

/* -------------------------------------------------------------------- */
/*      Extract information from leader.                                */
/* -------------------------------------------------------------------- */

    if( bValid )
    {
        _recLength                        = ossimDDFScanInt( achLeader+0, 5 );
        _interchangeLevel                 = achLeader[5];
        _leaderIden                   = achLeader[6];
        _inlineCodeExtensionIndicator = achLeader[7];
        _versionNumber                = achLeader[8];
        _appIndicator                 = achLeader[9];
        _fieldControlLength           = ossimDDFScanInt(achLeader+10,2);
        _fieldAreaStart               = ossimDDFScanInt(achLeader+12,5);
        _extendedCharSet[0]           = achLeader[17];
        _extendedCharSet[1]           = achLeader[18];
        _extendedCharSet[2]           = achLeader[19];
        _extendedCharSet[3]           = '\0';
        _sizeFieldLength              = ossimDDFScanInt(achLeader+20,1);
        _sizeFieldPos                 = ossimDDFScanInt(achLeader+21,1);
        _sizeFieldTag                 = ossimDDFScanInt(achLeader+23,1);

        if( _recLength < 12 || _fieldControlLength == 0
            || _fieldAreaStart < 24 || _sizeFieldLength == 0
            || _sizeFieldPos == 0 || _sizeFieldTag == 0 )
        {
            bValid = false;
        }
    }

/* -------------------------------------------------------------------- */
/*      If the header is invalid, then clean up, report the error       */
/*      and return.                                                     */
/* -------------------------------------------------------------------- */
    if( !bValid )
    {
        fclose( fpDDF );
        fpDDF = NULL;

        if( !bFailQuietly )
           ossimNotify(ossimNotifyLevel_WARN)
              << "File `%s' does not appear to have\n"
              << "a valid ISO 8211 header.\n"
              << pszFilename << std::endl;
        return false;
    }

/* -------------------------------------------------------------------- */
/*      Read the whole record info memory.                              */
/* -------------------------------------------------------------------- */
    char        *pachRecord;

    pachRecord = (char *) malloc(_recLength);
    memcpy( pachRecord, achLeader, nLeaderSize );

    if( fread( pachRecord+nLeaderSize, 1, _recLength-nLeaderSize, fpDDF )
        != _recLength - nLeaderSize )
    {
        if( !bFailQuietly )
            ossimNotify(ossimNotifyLevel_WARN)
               << "Header record is short on DDF file `%s'."
               << pszFilename << std::endl;
        
        return false;
    }

/* -------------------------------------------------------------------- */
/*      First make a pass counting the directory entries.               */
/* -------------------------------------------------------------------- */
    int         nFieldEntryWidth, nFDCount = 0;

    nFieldEntryWidth = _sizeFieldLength + _sizeFieldPos + _sizeFieldTag;

    for( i = nLeaderSize; i < _recLength; i += nFieldEntryWidth )
    {
        if( pachRecord[i] == OSSIM_DDF_FIELD_TERMINATOR )
            break;

        nFDCount++;
    }

/* -------------------------------------------------------------------- */
/*      Allocate, and read field definitions.                           */
/* -------------------------------------------------------------------- */
    for( i = 0; i < nFDCount; i++ )
    {
        char    szTag[128];
        int     nEntryOffset = nLeaderSize + i*nFieldEntryWidth;
        int     nFieldLength, nFieldPos;
        ossimDDFFieldDefn *poFDefn;
        
        strncpy( szTag, pachRecord+nEntryOffset, _sizeFieldTag );
        szTag[_sizeFieldTag] = '\0';

        nEntryOffset += _sizeFieldTag;
        nFieldLength = ossimDDFScanInt( pachRecord+nEntryOffset, _sizeFieldLength );
        
        nEntryOffset += _sizeFieldLength;
        nFieldPos = ossimDDFScanInt( pachRecord+nEntryOffset, _sizeFieldPos );
        
        poFDefn = new ossimDDFFieldDefn();
        poFDefn->Initialize( this, szTag, nFieldLength,
                             pachRecord+_fieldAreaStart+nFieldPos );
        AddField( poFDefn );
    }

    free( pachRecord );
    
/* -------------------------------------------------------------------- */
/*      Record the current file offset, the beginning of the first      */
/*      data record.                                                    */
/* -------------------------------------------------------------------- */
    nFirstRecordOffset = ftell( fpDDF );
    
    return true;
}

ReadRecord()

ossimDDFRecord * ossimDDFModule::ReadRecord

(

void

)

Read one record from the file.

Returns

A pointer to a DDFRecord object is returned, or NULL if a read error, or end of file occurs. The returned record is owned by the module, and should not be deleted by the application. The record is only valid untill the next ReadRecord() at which point it is overwritten.

Definition at line 585 of file ossimDdfmodule.cpp.

References poRecord, and ossimDDFRecord::Read().

Referenced by ossimAdrgHeader::parse().

{
    if( poRecord == NULL )
        poRecord = new ossimDDFRecord( this );

    if( poRecord->Read() )
        return poRecord;
    else
        return NULL;
}

RemoveCloneRecord()

void ossimDDFModule::RemoveCloneRecord

(

ossimDDFRecord *

poRecord

)

Definition at line 670 of file ossimDdfmodule.cpp.

References nCloneCount, papoClones, and poRecord.

Referenced by ossimDDFRecord::CloneOn(), and ossimDDFRecord::~ossimDDFRecord().

{
    int         i;
 
    for( i = 0; i < nCloneCount; i++ )
    {
        if( papoClones[i] == poRecord )
        {
            papoClones[i] = papoClones[nCloneCount-1];
            nCloneCount--;
            return;
        }
    }

    // CPLAssert( false );
}

Rewind()

void ossimDDFModule::Rewind

(

long

nOffset = -1

)

Return to first record.

The next call to ReadRecord() will read the first data record in the file.

Parameters

nOffset

the offset in the file to return to. By default this is -1, a special value indicating that reading should return to the first data record. Otherwise it is an absolute byte offset in the file.

Definition at line 702 of file ossimDdfmodule.cpp.

References ossimDDFRecord::Clear(), fpDDF, nFirstRecordOffset, and poRecord.

{
    if( nOffset == -1 )
        nOffset = nFirstRecordOffset;

    if( fpDDF == NULL )
        return;
    
    fseek( fpDDF, nOffset, SEEK_SET );

    if( nOffset == nFirstRecordOffset && poRecord != NULL )
        poRecord->Clear();
        
}

Member Data Documentation

_appIndicator

char ossimDDFModule::_appIndicator

private

Definition at line 137 of file ossimIso8211.h.

Referenced by Create(), Dump(), Initialize(), and ossimDDFModule().

_extendedCharSet

char ossimDDFModule::_extendedCharSet[4]

private

Definition at line 139 of file ossimIso8211.h.

Referenced by Create(), Dump(), Initialize(), and ossimDDFModule().

_fieldAreaStart

long ossimDDFModule::_fieldAreaStart

private

Definition at line 143 of file ossimIso8211.h.

Referenced by Create(), Dump(), and ossimDDFModule().

_fieldControlLength

int ossimDDFModule::_fieldControlLength

private

Definition at line 138 of file ossimIso8211.h.

Referenced by Create(), Dump(), GetFieldControlLength(), and ossimDDFModule().

_inlineCodeExtensionIndicator

char ossimDDFModule::_inlineCodeExtensionIndicator

private

Definition at line 135 of file ossimIso8211.h.

Referenced by Create(), Dump(), Initialize(), and ossimDDFModule().

_interchangeLevel

char ossimDDFModule::_interchangeLevel

private

Definition at line 134 of file ossimIso8211.h.

Referenced by Create(), Dump(), Initialize(), and ossimDDFModule().

_leaderIden

char ossimDDFModule::_leaderIden

private

Definition at line 142 of file ossimIso8211.h.

Referenced by Create(), Dump(), Initialize(), and ossimDDFModule().

_recLength

long ossimDDFModule::_recLength

private

Definition at line 141 of file ossimIso8211.h.

Referenced by Create(), Dump(), and ossimDDFModule().

_sizeFieldLength

long ossimDDFModule::_sizeFieldLength

private

Definition at line 144 of file ossimIso8211.h.

Referenced by Create(), Dump(), Initialize(), and ossimDDFModule().

_sizeFieldPos

long ossimDDFModule::_sizeFieldPos

private

Definition at line 145 of file ossimIso8211.h.

Referenced by Create(), Dump(), Initialize(), and ossimDDFModule().

_sizeFieldTag

long ossimDDFModule::_sizeFieldTag

private

Definition at line 146 of file ossimIso8211.h.

Referenced by Create(), Dump(), Initialize(), and ossimDDFModule().

_versionNumber

char ossimDDFModule::_versionNumber

private

Definition at line 136 of file ossimIso8211.h.

Referenced by Create(), Dump(), Initialize(), and ossimDDFModule().

bReadOnly

int ossimDDFModule::bReadOnly

private

Definition at line 131 of file ossimIso8211.h.

Referenced by Create(), and ossimDDFModule().

fpDDF

FILE* ossimDDFModule::fpDDF

private

Definition at line 130 of file ossimIso8211.h.

Referenced by Close(), Create(), GetFP(), ossimDDFModule(), and Rewind().

nCloneCount

int ossimDDFModule::nCloneCount

private

Definition at line 154 of file ossimIso8211.h.

Referenced by AddCloneRecord(), Close(), ossimDDFModule(), and RemoveCloneRecord().

nFieldDefnCount

int ossimDDFModule::nFieldDefnCount

private

Definition at line 149 of file ossimIso8211.h.

Referenced by AddField(), Close(), Create(), Dump(), FindFieldDefn(), GetField(), GetFieldCount(), and ossimDDFModule().

nFirstRecordOffset

long ossimDDFModule::nFirstRecordOffset

private

Definition at line 132 of file ossimIso8211.h.

Referenced by Rewind().

nMaxCloneCount

int ossimDDFModule::nMaxCloneCount

private

Definition at line 155 of file ossimIso8211.h.

Referenced by AddCloneRecord(), Close(), and ossimDDFModule().

papoClones

ossimDDFRecord** ossimDDFModule::papoClones

private

Definition at line 156 of file ossimIso8211.h.

Referenced by AddCloneRecord(), Close(), ossimDDFModule(), and RemoveCloneRecord().

papoFieldDefns

ossimDDFFieldDefn** ossimDDFModule::papoFieldDefns

private

Definition at line 150 of file ossimIso8211.h.

Referenced by AddField(), Close(), Create(), Dump(), FindFieldDefn(), GetField(), and ossimDDFModule().

poRecord

ossimDDFRecord* ossimDDFModule::poRecord

private

Definition at line 152 of file ossimIso8211.h.

Referenced by AddCloneRecord(), Close(), ossimDDFModule(), ReadRecord(), RemoveCloneRecord(), and Rewind().

---

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

• ossimIso8211.h
• ossimDdfmodule.cpp