ossimDDFFieldDefn Class Reference

Information from the DDR defining one field. More...

#include <ossimIso8211.h>

Public Member Functions
	ossimDDFFieldDefn ()
	~ossimDDFFieldDefn ()
int	Create (const char *pszTag, const char *pszFieldName, const char *pszDescription, DDF_data_struct_code eDataStructCode, DDF_data_type_code eDataTypeCode, const char *pszFormat=NULL)
void	AddSubfield (ossimDDFSubfieldDefn *poNewSFDefn, int bDontAddToFormat=false)
void	AddSubfield (const char *pszName, const char *pszFormat)
int	GenerateDDREntry (char **ppachData, int *pnLength)
int	Initialize (ossimDDFModule *poModule, const char *pszTag, int nSize, const char *pachRecord)
void	Dump (FILE *fp)
	Write out field definition info to debugging file. More...
const char *	GetName ()
	Fetch a pointer to the field name (tag). More...
const char *	GetDescription ()
	Fetch a longer descriptio of this field. More...
int	GetSubfieldCount ()
	Get the number of subfields. More...
ossimDDFSubfieldDefn *	GetSubfield (int i)
	Fetch a subfield by index. More...
ossimDDFSubfieldDefn *	FindSubfieldDefn (const char *)
	Find a subfield definition by it's mnemonic tag. More...
int	GetFixedWidth ()
	Get the width of this field. More...
int	IsRepeating ()
	Fetch repeating flag. More...
void	SetRepeatingFlag (int n)
	this is just for an S-57 hack for swedish data More...
char *	GetDefaultValue (int *pnSize)
	Return default data for field instance. More...

Static Public Member Functions
static char *	ExpandFormat (const char *)

Private Member Functions
int	BuildSubfields ()
int	ApplyFormats ()

Static Private Member Functions
static char *	ExtractSubstring (const char *)

Private Attributes
ossimDDFModule *	poModule
char *	pszTag
char *	_fieldName
char *	_arrayDescr
char *	_formatControls
int	bRepeatingSubfields
int	nFixedWidth
DDF_data_struct_code	_data_struct_code
DDF_data_type_code	_data_type_code
int	nSubfieldCount
ossimDDFSubfieldDefn **	papoSubfields

Detailed Description

Information from the DDR defining one field.

Note that just because a field is defined for a DDFModule doesn't mean that it actually occurs on any records in the module. DDFFieldDefns are normally just significant as containers of the DDFSubfieldDefns.

Definition at line 179 of file ossimIso8211.h.

Constructor & Destructor Documentation

ossimDDFFieldDefn()

ossimDDFFieldDefn::ossimDDFFieldDefn

(

)

Definition at line 47 of file ossimDdffielddefn.cpp.

References _arrayDescr, _fieldName, _formatControls, bRepeatingSubfields, nFixedWidth, nSubfieldCount, papoSubfields, poModule, and pszTag.

{
    poModule = NULL;
    pszTag = NULL;
    _fieldName = NULL;
    _arrayDescr = NULL;
    _formatControls = NULL;
    nSubfieldCount = 0;
    papoSubfields = NULL;
    bRepeatingSubfields = false;
    nFixedWidth = 0;
}

~ossimDDFFieldDefn()

ossimDDFFieldDefn::~ossimDDFFieldDefn

(

)

Definition at line 65 of file ossimDdffielddefn.cpp.

References _arrayDescr, _fieldName, _formatControls, nSubfieldCount, papoSubfields, and pszTag.

{
    int   i;

    free( pszTag );
    free( _fieldName );
    free( _arrayDescr );
    free( _formatControls );

    for( i = 0; i < nSubfieldCount; i++ )
        delete papoSubfields[i];
    free( papoSubfields );
}

Member Function Documentation

AddSubfield() [1/2]

void ossimDDFFieldDefn::AddSubfield	(	ossimDDFSubfieldDefn *	poNewSFDefn,
		int	bDontAddToFormat = false
	)

Definition at line 99 of file ossimDdffielddefn.cpp.

References _arrayDescr, _formatControls, ossimDDFSubfieldDefn::GetFormat(), ossimDDFSubfieldDefn::GetName(), nSubfieldCount, and papoSubfields.

Referenced by AddSubfield(), and BuildSubfields().

{
    nSubfieldCount++;
    papoSubfields = (ossimDDFSubfieldDefn ** )
        realloc( papoSubfields, sizeof(void*) * nSubfieldCount );
    papoSubfields[nSubfieldCount-1] = poNewSFDefn;
    
    if( bDontAddToFormat )
        return;

/* -------------------------------------------------------------------- */
/*      Add this format to the format list.  We don't bother            */
/*      aggregating formats here.                                       */
/* -------------------------------------------------------------------- */
    if( _formatControls == NULL || strlen(_formatControls) == 0 )
    {
        free( _formatControls );
        _formatControls = strdup( "()" );
    }
    
    int nOldLen = (int)strlen(_formatControls);
    
    char *pszNewFormatControls = (char *) 
        malloc(nOldLen+3+strlen(poNewSFDefn->GetFormat()));
    
    strcpy( pszNewFormatControls, _formatControls );
    pszNewFormatControls[nOldLen-1] = '\0';
    if( pszNewFormatControls[nOldLen-2] != '(' )
        strcat( pszNewFormatControls, "," );
    
    strcat( pszNewFormatControls, poNewSFDefn->GetFormat() );
    strcat( pszNewFormatControls, ")" );
    
    free( _formatControls );
    _formatControls = pszNewFormatControls;

/* -------------------------------------------------------------------- */
/*      Add the subfield name to the list.                              */
/* -------------------------------------------------------------------- */
    if( _arrayDescr == NULL )
        _arrayDescr = strdup("");

    _arrayDescr = (char *) 
        realloc(_arrayDescr, 
                   strlen(_arrayDescr)+strlen(poNewSFDefn->GetName())+2);
    if( strlen(_arrayDescr) > 0 )
        strcat( _arrayDescr, "!" );
    strcat( _arrayDescr, poNewSFDefn->GetName() );
}

AddSubfield() [2/2]

void ossimDDFFieldDefn::AddSubfield	(	const char *	pszName,
		const char *	pszFormat
	)

Definition at line 84 of file ossimDdffielddefn.cpp.

References AddSubfield(), ossimDDFSubfieldDefn::SetFormat(), and ossimDDFSubfieldDefn::SetName().

{
    ossimDDFSubfieldDefn *poSFDefn = new ossimDDFSubfieldDefn;

    poSFDefn->SetName( pszName );
    poSFDefn->SetFormat( pszFormat );
    AddSubfield( poSFDefn );
}

ApplyFormats()

int ossimDDFFieldDefn::ApplyFormats ( )

private

Definition at line 659 of file ossimDdffielddefn.cpp.

References _formatControls, ExpandFormat(), ossimDDFSubfieldDefn::GetWidth(), nFixedWidth, nSubfieldCount, ossimCSLDestroy(), ossimCSLTokenizeStringComplex(), ossimNotify(), ossimNotifyLevel_DEBUG, ossimNotifyLevel_WARN, papoSubfields, and pszTag.

{
    char        *pszFormatList;
    char        **papszFormatItems;
    
/* -------------------------------------------------------------------- */
/*      Verify that the format string is contained within brackets.     */
/* -------------------------------------------------------------------- */
    if( strlen(_formatControls) < 2
        || _formatControls[0] != '('
        || _formatControls[strlen(_formatControls)-1] != ')' )
    {
       ossimNotify(ossimNotifyLevel_WARN)
          << "Format controls for `%s' field missing brackets:%s\n"
          << pszTag << _formatControls << std::endl;
        
        return false;
    }

/* -------------------------------------------------------------------- */
/*      Duplicate the string, and strip off the brackets.               */
/* -------------------------------------------------------------------- */

    pszFormatList = ExpandFormat( _formatControls );

/* -------------------------------------------------------------------- */
/*      Tokenize based on commas.                                       */
/* -------------------------------------------------------------------- */
    papszFormatItems =
        ossimCSLTokenizeStringComplex(pszFormatList, ",", false, false );

    free( pszFormatList );

/* -------------------------------------------------------------------- */
/*      Apply the format items to subfields.                            */
/* -------------------------------------------------------------------- */
    int iFormatItem;
    
    for( iFormatItem = 0;
         papszFormatItems[iFormatItem] != NULL;
         iFormatItem++ )
    {
        const char      *pszPastPrefix;

        pszPastPrefix = papszFormatItems[iFormatItem];
        while( *pszPastPrefix >= '0' && *pszPastPrefix <= '9' )
            pszPastPrefix++;

        // Did we get too many formats for the subfields created
        // by names?  This may be legal by the 8211 specification, but
        // isn't encountered in any formats we care about so we just
        // blow.
        
        if( iFormatItem >= nSubfieldCount )
        {
           ossimNotify(ossimNotifyLevel_WARN)
              << "Got more formats than subfields for field `%s'.\n"
              << pszTag << std::endl;
            break;
        }
        
        if( !papoSubfields[iFormatItem]->SetFormat(pszPastPrefix) )
            return false;
    }

/* -------------------------------------------------------------------- */
/*      Verify that we got enough formats, cleanup and return.          */
/* -------------------------------------------------------------------- */
    ossimCSLDestroy( papszFormatItems );

    if( iFormatItem < nSubfieldCount )
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "Got less formats than subfields for field `%s',\n"
          << pszTag << std::endl;
        return false;
    }

/* -------------------------------------------------------------------- */
/*      If all the fields are fixed width, then we are fixed width      */
/*      too.  This is important for repeating fields.                   */
/* -------------------------------------------------------------------- */
    nFixedWidth = 0;
    for( int i = 0; i < nSubfieldCount; i++ )
    {
        if( papoSubfields[i]->GetWidth() == 0 )
        {
            nFixedWidth = 0;
            break;
        }
        else
            nFixedWidth += papoSubfields[i]->GetWidth();
    }

    return true;
}

BuildSubfields()

int ossimDDFFieldDefn::BuildSubfields ( )

private

Definition at line 481 of file ossimDdffielddefn.cpp.

References _arrayDescr, AddSubfield(), bRepeatingSubfields, ossimCSLCount(), ossimCSLDestroy(), ossimCSLTokenizeStringComplex(), and ossimDDFSubfieldDefn::SetName().

{
    char        **papszSubfieldNames;
    const char  *pszSublist = _arrayDescr;

    if( pszSublist[0] == '*' )
    {
        bRepeatingSubfields = true;
        pszSublist++;
    }

    papszSubfieldNames = ossimCSLTokenizeStringComplex( pszSublist, "!",
                                                   false, false );

    int nSFCount = ossimCSLCount( papszSubfieldNames );
    for( int iSF = 0; iSF < nSFCount; iSF++ )
    {
        ossimDDFSubfieldDefn *poSFDefn = new ossimDDFSubfieldDefn;
        
        poSFDefn->SetName( papszSubfieldNames[iSF] );
        AddSubfield( poSFDefn, true );
    }

    ossimCSLDestroy( papszSubfieldNames );

    return true;
}

Create()

int ossimDDFFieldDefn::Create	(	const char *	pszTag,
		const char *	pszFieldName,
		const char *	pszDescription,
		DDF_data_struct_code	eDataStructCode,
		DDF_data_type_code	eDataTypeCode,
		const char *	pszFormat = NULL
	)

Definition at line 158 of file ossimDdffielddefn.cpp.

References _arrayDescr, _data_struct_code, _data_type_code, _fieldName, _formatControls, bRepeatingSubfields, poModule, and pszTag.

{
   // assert( this->pszTag == NULL );
   poModule = NULL;
   this->pszTag = strdup( pszTag );
   _fieldName = strdup( pszFieldName );
   _arrayDescr = strdup( pszDescription );
   _formatControls = strdup( "" );
   
   _data_struct_code = eDataStructCode;
   _data_type_code = eDataTypeCode;
   
   if( pszFormat != NULL )
      _formatControls = strdup( pszFormat );
   
   if( pszDescription != NULL && *pszDescription == '*' )
      bRepeatingSubfields = true;
   
   return true;
}

Dump()

void ossimDDFFieldDefn::Dump

(

FILE *

fp

)

Write out field definition info to debugging file.

A variety of information about this field definition, and all it's subfields is written to the give debugging file handle.

Parameters

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

Definition at line 397 of file ossimDdffielddefn.cpp.

References _arrayDescr, _data_struct_code, _data_type_code, _fieldName, _formatControls, dsc_array, dsc_concatenated, dsc_elementary, dsc_vector, dtc_bit_string, dtc_char_bit_string, dtc_char_string, dtc_explicit_point, dtc_explicit_point_scaled, dtc_implicit_point, dtc_mixed_data_type, nSubfieldCount, papoSubfields, and pszTag.

Referenced by ossimDDFModule::Dump().

{
    const char  *pszValue = "";
    
    fprintf( fp, "  DDFFieldDefn:\n" );
    fprintf( fp, "      Tag = `%s'\n", pszTag );
    fprintf( fp, "      _fieldName = `%s'\n", _fieldName );
    fprintf( fp, "      _arrayDescr = `%s'\n", _arrayDescr );
    fprintf( fp, "      _formatControls = `%s'\n", _formatControls );

    switch( _data_struct_code )
    {
      case dsc_elementary:
        pszValue = "elementary";
        break;
        
      case dsc_vector:
        pszValue = "vector";
        break;
        
      case dsc_array:
        pszValue = "array";
        break;
        
      case dsc_concatenated:
        pszValue = "concatenated";
        break;
        
      default:
         // assert( false );
        pszValue = "(unknown)";
    }

    fprintf( fp, "      _data_struct_code = %s\n", pszValue );

    switch( _data_type_code )
    {
      case dtc_char_string:
        pszValue = "char_string";
        break;
        
      case dtc_implicit_point:
        pszValue = "implicit_point";
        break;
        
      case dtc_explicit_point:
        pszValue = "explicit_point";
        break;
        
      case dtc_explicit_point_scaled:
        pszValue = "explicit_point_scaled";
        break;
        
      case dtc_char_bit_string:
        pszValue = "char_bit_string";
        break;
        
      case dtc_bit_string:
        pszValue = "bit_string";
        break;
        
      case dtc_mixed_data_type:
        pszValue = "mixed_data_type";
        break;

      default:
         // assert( false );
        pszValue = "(unknown)";
        break;
    }
    
    fprintf( fp, "      _data_type_code = %s\n", pszValue );

    for( int i = 0; i < nSubfieldCount; i++ )
        papoSubfields[i]->Dump( fp );
}

ExpandFormat()

char * ossimDDFFieldDefn::ExpandFormat ( const char *  pszSrc )

static

Definition at line 557 of file ossimDdffielddefn.cpp.

References ExtractSubstring().

Referenced by ApplyFormats().

{
    int         nDestMax = 32;
    char       *pszDest = (char *) malloc(nDestMax+1);
    int         iSrc, iDst;
    int         nRepeat = 0;

    iSrc = 0;
    iDst = 0;
    pszDest[0] = '\0';

    while( pszSrc[iSrc] != '\0' )
    {
        /* This is presumably an extra level of brackets around some
           binary stuff related to rescaning which we don't care to do
           (see 6.4.3.3 of the standard.  We just strip off the extra
           layer of brackets */
        if( (iSrc == 0 || pszSrc[iSrc-1] == ',') && pszSrc[iSrc] == '(' )
        {
            char       *pszContents = ExtractSubstring( pszSrc+iSrc );
            char       *pszExpandedContents = ExpandFormat( pszContents );

            if( (int) (strlen(pszExpandedContents) + strlen(pszDest) + 1)
                > nDestMax )
            {
                nDestMax = 2 * ((int)strlen(pszExpandedContents) + (int)strlen(pszDest));
                pszDest = (char *) realloc(pszDest,nDestMax+1);
            }

            strcat( pszDest, pszExpandedContents );
            iDst = (int)strlen(pszDest);
            
            iSrc = iSrc + (int)strlen(pszContents) + 2;

            free( pszContents );
            free( pszExpandedContents );
        }

        /* this is a repeated subclause */
        else if( (iSrc == 0 || pszSrc[iSrc-1] == ',')
                 && isdigit(pszSrc[iSrc]) )
        {
            const char *pszNext;
            nRepeat = atoi(pszSrc+iSrc);
            
            // skip over repeat count.
            for( pszNext = pszSrc+iSrc; isdigit(*pszNext); pszNext++ )
                iSrc++;

            char       *pszContents = ExtractSubstring( pszNext );
            char       *pszExpandedContents = ExpandFormat( pszContents );
                
            for( int i = 0; i < nRepeat; i++ )
            {
                if( (int) (strlen(pszExpandedContents) + strlen(pszDest) + 1)
                    > nDestMax )
                {
                    nDestMax = 
                        2 * ((int)strlen(pszExpandedContents) + (int)strlen(pszDest));
                    pszDest = (char *) realloc(pszDest,nDestMax+1);
                }

                strcat( pszDest, pszExpandedContents );
                if( i < nRepeat-1 )
                    strcat( pszDest, "," );
            }

            iDst = (int)strlen(pszDest);
            
            if( pszNext[0] == '(' )
                iSrc = iSrc + (int)strlen(pszContents) + 2;
            else
                iSrc = iSrc + (int)strlen(pszContents);

            free( pszContents );
            free( pszExpandedContents );
        }
        else
        {
            if( iDst+1 >= nDestMax )
            {
                nDestMax = 2 * iDst;
                pszDest = (char *) realloc(pszDest,nDestMax);
            }

            pszDest[iDst++] = pszSrc[iSrc++];
            pszDest[iDst] = '\0';
        }
    }

    return pszDest;
}

ExtractSubstring()

char * ossimDDFFieldDefn::ExtractSubstring ( const char *  pszSrc )

staticprivate

Definition at line 523 of file ossimDdffielddefn.cpp.

Referenced by ExpandFormat().

{
    int         nBracket=0, i;
    char        *pszReturn;

    for( i = 0;
         pszSrc[i] != '\0' && (nBracket > 0 || pszSrc[i] != ',');
         i++ )
    {
        if( pszSrc[i] == '(' )
            nBracket++;
        else if( pszSrc[i] == ')' )
            nBracket--;
    }

    if( pszSrc[0] == '(' )
    {
        pszReturn = strdup( pszSrc + 1 );
        pszReturn[i-2] = '\0';
    }
    else
    {
        pszReturn = strdup( pszSrc  );
        pszReturn[i] = '\0';
    }

    return pszReturn;
}

FindSubfieldDefn()

ossimDDFSubfieldDefn * ossimDDFFieldDefn::FindSubfieldDefn

(

const char *

pszMnemonic

)

Find a subfield definition by it's mnemonic tag.

Parameters

pszMnemonic

The name of the field.

Returns

The subfield pointer, or NULL if there isn't any such subfield.

Definition at line 771 of file ossimDdffielddefn.cpp.

References ossimDDFSubfieldDefn::GetName(), nSubfieldCount, and papoSubfields.

Referenced by ossimDDFRecord::GetFloatSubfield(), ossimDDFRecord::GetIntSubfield(), ossimDDFRecord::GetStringSubfield(), ossimAdrgHeader::parse(), ossimDDFRecord::SetFloatSubfield(), ossimDDFRecord::SetIntSubfield(), and ossimDDFRecord::SetStringSubfield().

{
    for( int i = 0; i < nSubfieldCount; i++ )
    {
       ossimString s = papoSubfields[i]->GetName();
       if( s == pszMnemonic )
            return papoSubfields[i];
    }

    return NULL;
}

GenerateDDREntry()

int ossimDDFFieldDefn::GenerateDDREntry	(	char **	ppachData,
		int *	pnLength
	)

Definition at line 188 of file ossimDdffielddefn.cpp.

References _arrayDescr, _data_struct_code, _data_type_code, _fieldName, _formatControls, dsc_array, dsc_concatenated, dsc_elementary, dsc_vector, dtc_bit_string, dtc_char_bit_string, dtc_char_string, dtc_explicit_point, dtc_explicit_point_scaled, dtc_implicit_point, dtc_mixed_data_type, OSSIM_DDF_FIELD_TERMINATOR, and OSSIM_DDF_UNIT_TERMINATOR.

Referenced by ossimDDFModule::Create().

{
    *pnLength = 9 + (int)strlen(_fieldName) + 1 
        + (int)strlen(_arrayDescr) + 1
        + (int)strlen(_formatControls) + 1;

    if( strlen(_formatControls) == 0 )
        *pnLength -= 1;

    if( ppachData == NULL )
        return true;

    *ppachData = (char *) malloc( *pnLength+1 );
    
    if( _data_struct_code == dsc_elementary )
        (*ppachData)[0] = '0';
    else if( _data_struct_code == dsc_vector )
        (*ppachData)[0] = '1';
    else if( _data_struct_code == dsc_array )
        (*ppachData)[0] = '2';
    else if( _data_struct_code == dsc_concatenated )
        (*ppachData)[0] = '3';
    
    if( _data_type_code == dtc_char_string )
        (*ppachData)[1] = '0';
    else if( _data_type_code == dtc_implicit_point )
        (*ppachData)[1] = '1';
    else if( _data_type_code == dtc_explicit_point )
        (*ppachData)[1] = '2';
    else if( _data_type_code == dtc_explicit_point_scaled )
        (*ppachData)[1] = '3';
    else if( _data_type_code == dtc_char_bit_string )
        (*ppachData)[1] = '4';
    else if( _data_type_code == dtc_bit_string )
        (*ppachData)[1] = '5';
    else if( _data_type_code == dtc_mixed_data_type )
        (*ppachData)[1] = '6';

    (*ppachData)[2] = '0';
    (*ppachData)[3] = '0';
    (*ppachData)[4] = ';';
    (*ppachData)[5] = '&';
    (*ppachData)[6] = ' ';
    (*ppachData)[7] = ' ';
    (*ppachData)[8] = ' ';
    sprintf( *ppachData + 9, "%s%c%s", 
             _fieldName, OSSIM_DDF_UNIT_TERMINATOR, _arrayDescr );

    if( strlen(_formatControls) > 0 )
        sprintf( *ppachData + strlen(*ppachData), "%c%s",
                 OSSIM_DDF_UNIT_TERMINATOR, _formatControls );
    sprintf( *ppachData + strlen(*ppachData), "%c", OSSIM_DDF_FIELD_TERMINATOR );

    return true;
}

GetDefaultValue()

char * ossimDDFFieldDefn::GetDefaultValue

(

int *

pnSize

)

Return default data for field instance.

Definition at line 818 of file ossimDdffielddefn.cpp.

References nSubfieldCount, and papoSubfields.

Referenced by ossimDDFRecord::CreateDefaultFieldInstance().

{                                                                       
/* -------------------------------------------------------------------- */
/*      Loop once collecting the sum of the subfield lengths.           */
/* -------------------------------------------------------------------- */
    int iSubfield;
    int nTotalSize = 0;

    for( iSubfield = 0; iSubfield < nSubfieldCount; iSubfield++ )
    {
        int nSubfieldSize;

        if( !papoSubfields[iSubfield]->GetDefaultValue( NULL, 0, 
                                                        &nSubfieldSize ) )
            return NULL;
        nTotalSize += nSubfieldSize;
    }

/* -------------------------------------------------------------------- */
/*      Allocate buffer.                                                */
/* -------------------------------------------------------------------- */
    char *pachData = (char *) malloc( nTotalSize );

    if( pnSize != NULL )
        *pnSize = nTotalSize;

/* -------------------------------------------------------------------- */
/*      Loop again, collecting actual default values.                   */
/* -------------------------------------------------------------------- */
    int nOffset = 0;
    for( iSubfield = 0; iSubfield < nSubfieldCount; iSubfield++ )
    {
        int nSubfieldSize;

        if( !papoSubfields[iSubfield]->GetDefaultValue( 
                pachData + nOffset, nTotalSize - nOffset, &nSubfieldSize ) )
        {
           // assert( false );
           free( pachData );
           return NULL;
        }

        nOffset += nSubfieldSize;
    }

    // assert( nOffset == nTotalSize );

    return pachData;
}

GetDescription()

const char* ossimDDFFieldDefn::GetDescription ( )

inline

Fetch a longer descriptio of this field.

Returns

this is an internal copy and shouldn't be freed.

Definition at line 208 of file ossimIso8211.h.

References _fieldName.

{ return _fieldName; }

GetFixedWidth()

int ossimDDFFieldDefn::GetFixedWidth ( )

inline

Get the width of this field.

This function isn't normally used by applications.

Returns

The width of the field in bytes, or zero if the field is not apparently of a fixed width.

Definition at line 223 of file ossimIso8211.h.

References nFixedWidth.

Referenced by ossimDDFField::GetRepeatCount(), and ossimDDFField::GetSubfieldData().

{ return nFixedWidth; }

GetName()

const char* ossimDDFFieldDefn::GetName ( )

inline

Fetch a pointer to the field name (tag).

Returns

this is an internal copy and shouldn't be freed.

Definition at line 203 of file ossimIso8211.h.

References pszTag.

Referenced by ossimDDFRecord::CloneOn(), ossimDDFField::Dump(), ossimDDFRecord::FindField(), ossimDDFModule::FindFieldDefn(), and ossimDDFRecord::ResetDirectory().

{ return pszTag; }

GetSubfield()

ossimDDFSubfieldDefn * ossimDDFFieldDefn::GetSubfield

(

int

i

)

Fetch a subfield by index.

Parameters

i	The index subfield index. (Between 0 and GetSubfieldCount()-1)

Returns

The subfield pointer, or NULL if the index is out of range.

Definition at line 798 of file ossimDdffielddefn.cpp.

References nSubfieldCount, and papoSubfields.

Referenced by ossimDDFField::Dump(), ossimDDFField::GetInstanceData(), ossimDDFField::GetRepeatCount(), and ossimDDFField::GetSubfieldData().

{
    if( i < 0 || i >= nSubfieldCount )
    {
       // assert( false );
       return NULL;
    }
             
    return papoSubfields[i];
}

GetSubfieldCount()

int ossimDDFFieldDefn::GetSubfieldCount ( )

inline

Get the number of subfields.

Definition at line 211 of file ossimIso8211.h.

References nSubfieldCount.

Referenced by ossimDDFField::Dump(), ossimDDFField::GetInstanceData(), ossimDDFField::GetRepeatCount(), and ossimDDFField::GetSubfieldData().

{ return nSubfieldCount; }

Initialize()

int ossimDDFFieldDefn::Initialize	(	ossimDDFModule *	poModule,
		const char *	pszTag,
		int	nSize,
		const char *	pachRecord
	)

Definition at line 253 of file ossimDdffielddefn.cpp.

References _data_struct_code, dsc_array, dsc_concatenated, dsc_elementary, dsc_vector, ossimDDFModule::GetFieldControlLength(), poModule, and pszTag.

{
    int         iFDOffset = poModuleIn->GetFieldControlLength();
    int         nCharsConsumed;

    poModule = poModuleIn;
    
    pszTag = strdup( pszTagIn );

/* -------------------------------------------------------------------- */
/*      Set the data struct and type codes.                             */
/* -------------------------------------------------------------------- */
    switch( pachFieldArea[0] )
    {
      case '0':
        _data_struct_code = dsc_elementary;
        break;

      case '1':
        _data_struct_code = dsc_vector;
        break;

      case '2':
        _data_struct_code = dsc_array;
        break;

      case '3':
        _data_struct_code = dsc_concatenated;
        break;

      default:
         if (traceDebug())
         {
            ossimNotify(ossimNotifyLevel_WARN)
               << "Unrecognised data_struct_code value %c.\n"
               << "Field %s initialization incorrect.\n"
               << pachFieldArea[0]
               << pszTag
               << std::endl;
         }
        _data_struct_code = dsc_elementary;
    }

    switch( pachFieldArea[1] )
    {
      case '0':
        _data_type_code = dtc_char_string;
        break;
        
      case '1':
        _data_type_code = dtc_implicit_point;
        break;
        
      case '2':
        _data_type_code = dtc_explicit_point;
        break;
        
      case '3':
        _data_type_code = dtc_explicit_point_scaled;
        break;
        
      case '4':
        _data_type_code = dtc_char_bit_string;
        break;
        
      case '5':
        _data_type_code = dtc_bit_string;
        break;
        
      case '6':
        _data_type_code = dtc_mixed_data_type;
        break;

      default:
         if (traceDebug())
         {
            ossimNotify(ossimNotifyLevel_WARN)
               << "Unrecognised data_type_code value %c.\n"
               << "Field %s initialization incorrect.\n"
               << pachFieldArea[1] << pszTag << std::endl;
         }
        _data_type_code = dtc_char_string;
    }
    
/* -------------------------------------------------------------------- */
/*      Capture the field name, description (sub field names), and      */
/*      format statements.                                              */
/* -------------------------------------------------------------------- */

    _fieldName =
        ossimDDFFetchVariable( pachFieldArea + iFDOffset,
                          nFieldEntrySize - iFDOffset,
                          OSSIM_DDF_UNIT_TERMINATOR,
                          OSSIM_DDF_FIELD_TERMINATOR,
                          &nCharsConsumed );
    iFDOffset += nCharsConsumed;
    
    _arrayDescr =
        ossimDDFFetchVariable( pachFieldArea + iFDOffset,
                               nFieldEntrySize - iFDOffset,
                               OSSIM_DDF_UNIT_TERMINATOR,
                               OSSIM_DDF_FIELD_TERMINATOR, 
                               &nCharsConsumed );
    iFDOffset += nCharsConsumed;
    
    _formatControls =
        ossimDDFFetchVariable( pachFieldArea + iFDOffset,
                               nFieldEntrySize - iFDOffset,
                               OSSIM_DDF_UNIT_TERMINATOR,
                               OSSIM_DDF_FIELD_TERMINATOR, 
                               &nCharsConsumed );
    
/* -------------------------------------------------------------------- */
/*      Parse the subfield info.                                        */
/* -------------------------------------------------------------------- */
    if( _data_struct_code != dsc_elementary )
    {
        if( !BuildSubfields() )
            return false;

        if( !ApplyFormats() )
            return false;
    }
    
    return true;
}

IsRepeating()

int ossimDDFFieldDefn::IsRepeating ( )

inline

Fetch repeating flag.

See also

DDFField::GetRepeatCount()

Returns

TRUE if the field is marked as repeating.

Definition at line 230 of file ossimIso8211.h.

References bRepeatingSubfields.

Referenced by ossimDDFField::GetRepeatCount(), and ossimDDFRecord::SetFieldRaw().

{ return bRepeatingSubfields; }

SetRepeatingFlag()

void ossimDDFFieldDefn::SetRepeatingFlag ( int  n )

inline

this is just for an S-57 hack for swedish data

Definition at line 235 of file ossimIso8211.h.

References bRepeatingSubfields, and n.

{ bRepeatingSubfields = n; }

Member Data Documentation

_arrayDescr

char* ossimDDFFieldDefn::_arrayDescr

private

Definition at line 247 of file ossimIso8211.h.

Referenced by AddSubfield(), BuildSubfields(), Create(), Dump(), GenerateDDREntry(), ossimDDFFieldDefn(), and ~ossimDDFFieldDefn().

_data_struct_code

DDF_data_struct_code ossimDDFFieldDefn::_data_struct_code

private

Definition at line 256 of file ossimIso8211.h.

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

_data_type_code

DDF_data_type_code ossimDDFFieldDefn::_data_type_code

private

Definition at line 258 of file ossimIso8211.h.

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

_fieldName

char* ossimDDFFieldDefn::_fieldName

private

Definition at line 246 of file ossimIso8211.h.

Referenced by Create(), Dump(), GenerateDDREntry(), GetDescription(), ossimDDFFieldDefn(), and ~ossimDDFFieldDefn().

_formatControls

char* ossimDDFFieldDefn::_formatControls

private

Definition at line 248 of file ossimIso8211.h.

Referenced by AddSubfield(), ApplyFormats(), Create(), Dump(), GenerateDDREntry(), ossimDDFFieldDefn(), and ~ossimDDFFieldDefn().

bRepeatingSubfields

int ossimDDFFieldDefn::bRepeatingSubfields

private

Definition at line 250 of file ossimIso8211.h.

Referenced by BuildSubfields(), Create(), IsRepeating(), ossimDDFFieldDefn(), and SetRepeatingFlag().

nFixedWidth

int ossimDDFFieldDefn::nFixedWidth

private

Definition at line 251 of file ossimIso8211.h.

Referenced by ApplyFormats(), GetFixedWidth(), and ossimDDFFieldDefn().

nSubfieldCount

int ossimDDFFieldDefn::nSubfieldCount

private

Definition at line 260 of file ossimIso8211.h.

Referenced by AddSubfield(), ApplyFormats(), Dump(), FindSubfieldDefn(), GetDefaultValue(), GetSubfield(), GetSubfieldCount(), ossimDDFFieldDefn(), and ~ossimDDFFieldDefn().

papoSubfields

ossimDDFSubfieldDefn** ossimDDFFieldDefn::papoSubfields

private

Definition at line 261 of file ossimIso8211.h.

Referenced by AddSubfield(), ApplyFormats(), Dump(), FindSubfieldDefn(), GetDefaultValue(), GetSubfield(), ossimDDFFieldDefn(), and ~ossimDDFFieldDefn().

poModule

ossimDDFModule* ossimDDFFieldDefn::poModule

private

Definition at line 243 of file ossimIso8211.h.

Referenced by Create(), Initialize(), and ossimDDFFieldDefn().

pszTag

char* ossimDDFFieldDefn::pszTag

private

Definition at line 244 of file ossimIso8211.h.

Referenced by ApplyFormats(), Create(), Dump(), GetName(), Initialize(), ossimDDFFieldDefn(), and ~ossimDDFFieldDefn().

---

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

• ossimIso8211.h
• ossimDdffielddefn.cpp