ossimDDFSubfieldDefn Class Reference

Information from the DDR record describing one subfield of a DDFFieldDefn. More...

#include <ossimIso8211.h>

Public Types
enum	DDFBinaryFormat {   NotBinary =0, UInt =1, SInt =2, FPReal =3,   FloatReal =4, FloatComplex =5 }
	Binary format: this is the digit immediately following the B or b for binary formats. More...

Public Member Functions
	ossimDDFSubfieldDefn ()
	~ossimDDFSubfieldDefn ()
void	SetName (const char *pszName)
const char *	GetName ()
	Get pointer to subfield name. More...
const char *	GetFormat ()
	Get pointer to subfield format string. More...
int	SetFormat (const char *pszFormat)
DDFDataType	GetType ()
	Get the general type of the subfield. More...
double	ExtractFloatData (const char *pachData, int nMaxBytes, int *pnConsumedBytes)
	Extract a subfield value as a float. More...
int	ExtractIntData (const char *pachData, int nMaxBytes, int *pnConsumedBytes)
	Extract a subfield value as an integer. More...
const char *	ExtractStringData (const char *pachData, int nMaxBytes, int *pnConsumedBytes)
	Extract a zero terminated string containing the data for this subfield. More...
int	GetDataLength (const char *, int, int *)
	Scan for the end of variable length data. More...
void	DumpData (const char *pachData, int nMaxBytes, FILE *fp)
	Dump subfield value to debugging file. More...
int	FormatStringValue (char *pachData, int nBytesAvailable, int *pnBytesUsed, const char *pszValue, int nValueLength=-1)
	Format string subfield value. More...
int	FormatIntValue (char *pachData, int nBytesAvailable, int *pnBytesUsed, int nNewValue)
	Format int subfield value. More...
int	FormatFloatValue (char *pachData, int nBytesAvailable, int *pnBytesUsed, double dfNewValue)
	Format float subfield value. More...
int	GetWidth ()
	Get the subfield width (zero for variable). More...
int	GetDefaultValue (char *pachData, int nBytesAvailable, int *pnBytesUsed)
	Get default data. More...
void	Dump (FILE *fp)
	Write out subfield definition info to debugging file. More...
DDFBinaryFormat	GetBinaryFormat (void) const

Private Attributes
char *	pszName
char *	pszFormatString
DDFDataType	eType
DDFBinaryFormat	eBinaryFormat
int	bIsVariable
char	chFormatDelimeter
int	nFormatWidth
int	nMaxBufChars
char *	pachBuffer

Detailed Description

Information from the DDR record describing one subfield of a DDFFieldDefn.

All subfields of a field will occur in each occurance of that field (as a DDFField) in a DDFRecord. Subfield's actually contain formatted data (as instances within a record).

Definition at line 278 of file ossimIso8211.h.

Member Enumeration Documentation

DDFBinaryFormat

enum ossimDDFSubfieldDefn::DDFBinaryFormat

Binary format: this is the digit immediately following the B or b for binary formats.

Enumerator
NotBinary
UInt
SInt
FPReal
FloatReal
FloatComplex

Definition at line 335 of file ossimIso8211.h.

             {
    NotBinary=0,
    UInt=1,
    SInt=2,
    FPReal=3,
    FloatReal=4,
    FloatComplex=5
} DDFBinaryFormat;

Constructor & Destructor Documentation

ossimDDFSubfieldDefn()

ossimDDFSubfieldDefn::ossimDDFSubfieldDefn

(

)

Definition at line 41 of file ossimDdfsubfielddefn.cpp.

References bIsVariable, chFormatDelimeter, DDFString, eBinaryFormat, eType, nFormatWidth, nMaxBufChars, NotBinary, OSSIM_DDF_UNIT_TERMINATOR, pachBuffer, pszFormatString, and pszName.

{
    pszName = NULL;
    
    bIsVariable = true;
    nFormatWidth = 0;
    chFormatDelimeter = OSSIM_DDF_UNIT_TERMINATOR;
    eBinaryFormat = NotBinary;
    eType = DDFString;
    
    pszFormatString = strdup("");

    nMaxBufChars = 0;
    pachBuffer = NULL;
}

~ossimDDFSubfieldDefn()

ossimDDFSubfieldDefn::~ossimDDFSubfieldDefn

(

)

Definition at line 62 of file ossimDdfsubfielddefn.cpp.

References pachBuffer, pszFormatString, and pszName.

{
    free( pszName );
    free( pszFormatString );
    free( pachBuffer );
}

Member Function Documentation

Dump()

void ossimDDFSubfieldDefn::Dump

(

FILE *

fp

)

Write out subfield definition info to debugging file.

A variety of information about this field definition is written to the give debugging file handle.

Parameters

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

Definition at line 199 of file ossimDdfsubfielddefn.cpp.

References pszFormatString, and pszName.

{
    fprintf( fp, "    DDFSubfieldDefn:\n" );
    fprintf( fp, "        Label = `%s'\n", pszName );
    fprintf( fp, "        FormatString = `%s'\n", pszFormatString );
}

DumpData()

void ossimDDFSubfieldDefn::DumpData	(	const char *	pachData,
		int	nMaxBytes,
		FILE *	fp
	)

Dump subfield value to debugging file.

Parameters

pachData	Pointer to data for this subfield.
nMaxBytes	Maximum number of bytes available in pachData.
fp	File to write report to.

Definition at line 689 of file ossimDdfsubfielddefn.cpp.

References DDFBinaryString, DDFFloat, DDFInt, eType, ExtractFloatData(), ExtractIntData(), ExtractStringData(), min, and pszName.

Referenced by ossimDDFField::Dump().

{
    if( eType == DDFFloat )
        fprintf( fp, "      Subfield `%s' = %f\n",
                 pszName,
                 ExtractFloatData( pachData, nMaxBytes, NULL ) );
    else if( eType == DDFInt )
        fprintf( fp, "      Subfield `%s' = %d\n",
                 pszName,
                 ExtractIntData( pachData, nMaxBytes, NULL ) );
    else if( eType == DDFBinaryString )
    {
        int     nBytes, i;
        ossim_uint8   *pabyBString = (ossim_uint8 *) ExtractStringData( pachData, nMaxBytes, &nBytes );

        fprintf( fp, "      Subfield `%s' = 0x", pszName );
        for( i = 0; i < std::min(nBytes,24); i++ )
            fprintf( fp, "%02X", pabyBString[i] );

        if( nBytes > 24 )
            fprintf( fp, "%s", "..." );

        fprintf( fp, "\n" );
    }
    else
        fprintf( fp, "      Subfield `%s' = `%s'\n",
                 pszName,
                 ExtractStringData( pachData, nMaxBytes, NULL ) );
}

ExtractFloatData()

double ossimDDFSubfieldDefn::ExtractFloatData	(	const char *	pachSourceData,
		int	nMaxBytes,
		int *	pnConsumedBytes
	)

Extract a subfield value as a float.

Given a pointer to the data for this subfield (from within a DDFRecord) this method will return the floating point data for this subfield. The number of bytes consumed as part of this field can also be fetched. This method may be called for any type of subfield, and will return zero if the subfield is not numeric.

Parameters

pachSourceData	The pointer to the raw data for this field. This may have come from DDFRecord::GetData(), taking into account skip factors over previous subfields data.
nMaxBytes	The maximum number of bytes that are accessable after pachSourceData.
pnConsumedBytes	Pointer to an integer into which the number of bytes consumed by this field should be written. May be NULL to ignore. This is used as a skip factor to increment pachSourceData to point to the next subfields data.

Returns

The subfield's numeric value (or zero if it isn't numeric).

See also

ExtractIntData(), ExtractStringData()

Definition at line 394 of file ossimDdfsubfielddefn.cpp.

References eBinaryFormat, ExtractStringData(), FloatComplex, FloatReal, FPReal, nFormatWidth, NotBinary, pszFormatString, SInt, and UInt.

Referenced by DumpData(), and ossimDDFRecord::GetFloatSubfield().

{
    switch( pszFormatString[0] )
    {
      case 'A':
      case 'I':
      case 'R':
      case 'S':
      case 'C':
        return atof(ExtractStringData(pachSourceData, nMaxBytes,
                                      pnConsumedBytes));

      case 'B':
      case 'b':
      {
          unsigned char   abyData[8];

          // CPLAssert( nFormatWidth <= nMaxBytes );
          if( pnConsumedBytes != NULL )
              *pnConsumedBytes = nFormatWidth;

          // Byte swap the data if it isn't in machine native format.
          // In any event we copy it into our buffer to ensure it is
          // word aligned.
#ifdef CPL_LSB
          if( pszFormatString[0] == 'B' )
#else            
              if( pszFormatString[0] == 'b' )
#endif            
              {
                  for( int i = 0; i < nFormatWidth; i++ )
                      abyData[nFormatWidth-i-1] = pachSourceData[i];
              }
              else
              {
                  memcpy( abyData, pachSourceData, nFormatWidth );
              }

          // Interpret the bytes of data.
          switch( eBinaryFormat )
          {
             case UInt:
                if( nFormatWidth == 1 )
                {
                   return( abyData[0] );
                }
                else if( nFormatWidth == 2 )
                {
                   ossim_uint16* ptr = (ossim_uint16*) abyData;
                   return *ptr;
                }
                else if( nFormatWidth == 4 )
                {
                   ossim_uint32* ptr = (ossim_uint32*) abyData;
                   return *ptr;
                }
                else
                {
                   // CPLAssert( false );
                   return 0.0;
                }
                
             case SInt:
                if( nFormatWidth == 1 )
                {
                   signed char* ptr = (signed char*) abyData;
                   return *ptr;
                }
                else if( nFormatWidth == 2 )
                {
                   ossim_int16* ptr = (ossim_int16*) abyData;
                   return *ptr;
                }
                else if( nFormatWidth == 4 )
                {
                   ossim_int32* ptr = (ossim_int32*) abyData;
                   return *ptr;
                }
                else
                {
                   // CPLAssert( false );
                   return 0.0;
                }
            
             case FloatReal:
                if( nFormatWidth == 4 )
                {
                   float* ptr = (float*) abyData;
                   return *ptr;
                }
                else if( nFormatWidth == 8 )
                {
                   double* ptr = (double*) abyData;
                   return *ptr;
                }
                else
                {
                   // CPLAssert( false );
                   return 0.0;
                }
                
             case NotBinary:            
             case FPReal:
             case FloatComplex:
                // CPLAssert( false );
                return 0.0;
          }
          break;
          // end of 'b'/'B' case.
      }

      default:
        // CPLAssert( false );
        return 0.0;
    }

    // CPLAssert( false );
    return 0.0;
}

ExtractIntData()

int ossimDDFSubfieldDefn::ExtractIntData	(	const char *	pachSourceData,
		int	nMaxBytes,
		int *	pnConsumedBytes
	)

Extract a subfield value as an integer.

Given a pointer to the data for this subfield (from within a DDFRecord) this method will return the int data for this subfield. The number of bytes consumed as part of this field can also be fetched. This method may be called for any type of subfield, and will return zero if the subfield is not numeric.

Parameters

pachSourceData	The pointer to the raw data for this field. This may have come from DDFRecord::GetData(), taking into account skip factors over previous subfields data.
nMaxBytes	The maximum number of bytes that are accessable after pachSourceData.
pnConsumedBytes	Pointer to an integer into which the number of bytes consumed by this field should be written. May be NULL to ignore. This is used as a skip factor to increment pachSourceData to point to the next subfields data.

Returns

The subfield's numeric value (or zero if it isn't numeric).

See also

ExtractFloatData(), ExtractStringData()

Definition at line 544 of file ossimDdfsubfielddefn.cpp.

References eBinaryFormat, ExtractStringData(), FloatComplex, FloatReal, FPReal, nFormatWidth, NotBinary, ossimNotify(), ossimNotifyLevel_WARN, pszFormatString, pszName, SInt, and UInt.

Referenced by DumpData(), and ossimDDFRecord::GetIntSubfield().

{
    switch( pszFormatString[0] )
    {
      case 'A':
      case 'I':
      case 'R':
      case 'S':
      case 'C':
        return atoi(ExtractStringData(pachSourceData, nMaxBytes,
                                      pnConsumedBytes));

      case 'B':
      case 'b':
      {
          unsigned char   abyData[8];

          if( nFormatWidth > nMaxBytes )
          {
              ossimNotify(ossimNotifyLevel_WARN)
                 << "Attempt to extract int subfield %s with format %s\n"
                 << "failed as only %d bytes available.  Using zero."
                 << pszName << pszFormatString << nMaxBytes << std::endl;
              return 0;
          }

          if( pnConsumedBytes != NULL )
              *pnConsumedBytes = nFormatWidth;

          // Byte swap the data if it isn't in machine native format.
          // In any event we copy it into our buffer to ensure it is
          // word aligned.
#ifdef CPL_LSB
          if( pszFormatString[0] == 'B' )
#else            
              if( pszFormatString[0] == 'b' )
#endif            
              {
                  for( int i = 0; i < nFormatWidth; i++ )
                      abyData[nFormatWidth-i-1] = pachSourceData[i];
              }
              else
              {
                  memcpy( abyData, pachSourceData, nFormatWidth );
              }

          // Interpret the bytes of data.
          switch( eBinaryFormat )
          {
            case UInt:
              if( nFormatWidth == 4 )
              {
                 ossim_uint32* ptr = (ossim_uint32*) abyData;
                 return *ptr;
              }
              else if( nFormatWidth == 1 )
              {
                 return( abyData[0] );
              }
              else if( nFormatWidth == 2 )
              {
                 ossim_uint16* ptr = (ossim_uint16*)abyData;
                 return *ptr;
              }
              else
              {
                 // CPLAssert( false );
                 return 0;
              }
              
             case SInt:
                if( nFormatWidth == 4 )
                {
                   ossim_int32* ptr = (ossim_int32 *) abyData;
                   return *ptr;
                }
                else if( nFormatWidth == 1 )
                {
                   signed char* ptr = (signed char *) abyData;
                   return *ptr;
                }
                else if( nFormatWidth == 2 )
                {
                   ossim_int16* ptr = (ossim_int16 *) abyData;
                   return *ptr;
                }
                else
                {
                   // CPLAssert( false );
                   return 0;
                }
                
             case FloatReal:
                if( nFormatWidth == 4 )
                {
                   float* ptr = (float *) abyData;
                   return (int) *ptr;
                }
                else if( nFormatWidth == 8 )
                {
                   double* ptr = (double *) abyData;
                   return (int) *ptr;
                }
                else
                {
                   // CPLAssert( false );
                   return 0;
                }

             case NotBinary:            
             case FPReal:
             case FloatComplex:
                // CPLAssert( false );
                return 0;
          }
          break;
          // end of 'b'/'B' case.
      }
      
       default:
          // CPLAssert( false );
          return 0;
    }
    
    // CPLAssert( false );
    return 0;
}

ExtractStringData()

const char * ossimDDFSubfieldDefn::ExtractStringData	(	const char *	pachSourceData,
		int	nMaxBytes,
		int *	pnConsumedBytes
	)

Extract a zero terminated string containing the data for this subfield.

Given a pointer to the data for this subfield (from within a DDFRecord) this method will return the data for this subfield. The number of bytes consumed as part of this field can also be fetched. This number may be one longer than the string length if there is a terminator character used.

This function will return the raw binary data of a subfield for types other than DDFString, including data past zero chars. This is the standard way of extracting DDFBinaryString subfields for instance.

Parameters

pachSourceData	The pointer to the raw data for this field. This may have come from DDFRecord::GetData(), taking into account skip factors over previous subfields data.
nMaxBytes	The maximum number of bytes that are accessable after pachSourceData.
pnConsumedBytes	Pointer to an integer into which the number of bytes consumed by this field should be written. May be NULL to ignore. This is used as a skip factor to increment pachSourceData to point to the next subfields data.

Returns

A pointer to a buffer containing the data for this field. The returned pointer is to an internal buffer which is invalidated on the next ExtractStringData() call on this DDFSubfieldDefn(). It should not be freed by the application.

See also

ExtractIntData(), ExtractFloatData()

Definition at line 338 of file ossimDdfsubfielddefn.cpp.

References GetDataLength(), nMaxBufChars, and pachBuffer.

Referenced by DumpData(), ExtractFloatData(), ExtractIntData(), ossimDDFRecord::GetStringSubfield(), and ossimAdrgHeader::parse().

{
    int         nLength = GetDataLength( pachSourceData, nMaxBytes,
                                         pnConsumedBytes );

/* -------------------------------------------------------------------- */
/*      Do we need to grow the buffer.                                  */
/* -------------------------------------------------------------------- */
    if( nMaxBufChars < nLength+1 )
    {
        free( pachBuffer );
        
        nMaxBufChars = nLength+1;
        pachBuffer = (char *) malloc(nMaxBufChars);
    }

/* -------------------------------------------------------------------- */
/*      Copy the data to the buffer.  We use memcpy() so that it        */
/*      will work for binary data.                                      */
/* -------------------------------------------------------------------- */
    memcpy( pachBuffer, pachSourceData, nLength );
    pachBuffer[nLength] = '\0';

    return pachBuffer;
}

FormatFloatValue()

int ossimDDFSubfieldDefn::FormatFloatValue	(	char *	pachData,
		int	nBytesAvailable,
		int *	pnBytesUsed,
		double	dfNewValue
	)

Format float subfield value.

Returns a buffer with the passed in float value reformatted in a way suitable for storage in a DDFField for this subfield.

Definition at line 946 of file ossimDdfsubfielddefn.cpp.

References bIsVariable, GetBinaryFormat(), nFormatWidth, NotBinary, and OSSIM_DDF_UNIT_TERMINATOR.

Referenced by ossimDDFRecord::SetFloatSubfield().

{
    int nSize;
    char szWork[120];

    sprintf( szWork, "%.16g", dfNewValue );

    if( bIsVariable )
    {
        nSize = (int)strlen(szWork) + 1;
    }
    else
    {
        nSize = nFormatWidth;

        if( GetBinaryFormat() == NotBinary && (int) strlen(szWork) > nSize )
            return false;
    }

    if( pnBytesUsed != NULL )
        *pnBytesUsed = nSize;

    if( pachData == NULL )
        return true;

    if( nBytesAvailable < nSize )
        return false;

    if( bIsVariable )
    {
        strncpy( pachData, szWork, nSize-1 );
        pachData[nSize-1] = OSSIM_DDF_UNIT_TERMINATOR;
    }
    else
    {
        if( GetBinaryFormat() == NotBinary )
        {
            memset( pachData, '0', nSize );
            strncpy( pachData + nSize - strlen(szWork), szWork,
                     strlen(szWork) );
        }
        else
        {
            // CPLAssert( false );
            /* implement me */
        }
    }

    return true;
}

FormatIntValue()

int ossimDDFSubfieldDefn::FormatIntValue	(	char *	pachData,
		int	nBytesAvailable,
		int *	pnBytesUsed,
		int	nNewValue
	)

Format int subfield value.

Returns a buffer with the passed in int value reformatted in a way suitable for storage in a DDFField for this subfield.

Definition at line 857 of file ossimDdfsubfielddefn.cpp.

References bIsVariable, FloatReal, GetBinaryFormat(), nFormatWidth, NotBinary, OSSIM_DDF_UNIT_TERMINATOR, pszFormatString, SInt, and UInt.

Referenced by ossimDDFRecord::SetIntSubfield().

{
    int nSize;
    char szWork[30];

    sprintf( szWork, "%d", nNewValue );

    if( bIsVariable )
    {
        nSize = (int)strlen(szWork) + 1;
    }
    else
    {                                                                  
        nSize = nFormatWidth;

        if( GetBinaryFormat() == NotBinary && (int) strlen(szWork) > nSize )
            return false;
    }

    if( pnBytesUsed != NULL )
        *pnBytesUsed = nSize;

    if( pachData == NULL )
        return true;

    if( nBytesAvailable < nSize )
        return false;

    if( bIsVariable )
    {
        strncpy( pachData, szWork, nSize-1 );
        pachData[nSize-1] = OSSIM_DDF_UNIT_TERMINATOR;
    }
    else
    {
        ossim_uint32 nMask = 0xff;
        int i;

        switch( GetBinaryFormat() )
        {
          case NotBinary:
            memset( pachData, '0', nSize );
            strncpy( pachData + nSize - strlen(szWork), szWork,
                     strlen(szWork) );
            break;

          case UInt:
          case SInt:
            for( i = 0; i < nFormatWidth; i++ )
            {
                int iOut;

                // big endian required?
                if( pszFormatString[0] == 'B' )
                    iOut = nFormatWidth - i - 1;
                else
                    iOut = i;

                pachData[iOut] = (nNewValue & nMask) >> (i*8);
                nMask *= 256;
            }
            break;

          case FloatReal:
            // CPLAssert( false );
            break;

          default:
            // CPLAssert( false );
            break;
        }
    }

    return true;
}

FormatStringValue()

int ossimDDFSubfieldDefn::FormatStringValue	(	char *	pachData,
		int	nBytesAvailable,
		int *	pnBytesUsed,
		const char *	pszValue,
		int	nValueLength = -1
	)

Format string subfield value.

Returns a buffer with the passed in string value reformatted in a way suitable for storage in a DDFField for this subfield.

Definition at line 795 of file ossimDdfsubfielddefn.cpp.

References bIsVariable, GetBinaryFormat(), min, nFormatWidth, NotBinary, and OSSIM_DDF_UNIT_TERMINATOR.

Referenced by ossimDDFRecord::SetStringSubfield().

{
    int nSize;

    if( nValueLength == -1 )
        nValueLength = (int)strlen(pszValue);

    if( bIsVariable )
    {
        nSize = nValueLength + 1;
    }
    else
    {                                                                  
        nSize = nFormatWidth;
    }

    if( pnBytesUsed != NULL )
        *pnBytesUsed = nSize;

    if( pachData == NULL )
        return true;

    if( nBytesAvailable < nSize )
        return false;

    if( bIsVariable )
    {
        strncpy( pachData, pszValue, nSize-1 );
        pachData[nSize-1] = OSSIM_DDF_UNIT_TERMINATOR;
    }
    else
    {
        if( GetBinaryFormat() == NotBinary )
        {
            memset( pachData, ' ', nSize );
            memcpy( pachData, pszValue, std::min(nValueLength,nSize) );
        }
        else
        {
            memset( pachData, 0, nSize );
            memcpy( pachData, pszValue, std::min(nValueLength,nSize) );
        }
    }

    return true;
}

GetBinaryFormat()

DDFBinaryFormat ossimDDFSubfieldDefn::GetBinaryFormat ( void  ) const

inline

Definition at line 344 of file ossimIso8211.h.

References eBinaryFormat.

Referenced by FormatFloatValue(), FormatIntValue(), FormatStringValue(), and GetDefaultValue().

{ return eBinaryFormat; }

GetDataLength()

int ossimDDFSubfieldDefn::GetDataLength	(	const char *	pachSourceData,
		int	nMaxBytes,
		int *	pnConsumedBytes
	)

Scan for the end of variable length data.

Given a pointer to the data for this subfield (from within a DDFRecord) this method will return the number of bytes which are data for this subfield. The number of bytes consumed as part of this field can also be fetched. This number may be one longer than the length if there is a terminator character used.

This method is mainly for internal use, or for applications which want the raw binary data to interpret themselves. Otherwise use one of ExtractStringData(), ExtractIntData() or ExtractFloatData().

Parameters

pachSourceData	The pointer to the raw data for this field. This may have come from DDFRecord::GetData(), taking into account skip factors over previous subfields data.
nMaxBytes	The maximum number of bytes that are accessable after pachSourceData.
pnConsumedBytes	Pointer to an integer into which the number of bytes consumed by this field should be written. May be NULL to ignore.

Returns

The number of bytes at pachSourceData which are actual data for this record (not including unit, or field terminator).

Definition at line 237 of file ossimDdfsubfielddefn.cpp.

References bIsVariable, chFormatDelimeter, nFormatWidth, OSSIM_DDF_FIELD_TERMINATOR, ossimNotify(), ossimNotifyLevel_WARN, pszFormatString, and pszName.

Referenced by ossimDDFField::Dump(), ExtractStringData(), ossimDDFField::GetInstanceData(), ossimDDFField::GetRepeatCount(), ossimDDFField::GetSubfieldData(), ossimDDFRecord::SetFloatSubfield(), ossimDDFRecord::SetIntSubfield(), and ossimDDFRecord::SetStringSubfield().

{
    if( !bIsVariable )
    {
        if( nFormatWidth > nMaxBytes )
        {
            ossimNotify(ossimNotifyLevel_WARN)
               << "Only %d bytes available for subfield %s with\n"
               << "format string %s ... returning shortened data."
               << nMaxBytes << pszName << pszFormatString << std::endl;

            if( pnConsumedBytes != NULL )
                *pnConsumedBytes = nMaxBytes;

            return nMaxBytes;
        }
        else
        {
            if( pnConsumedBytes != NULL )
                *pnConsumedBytes = nFormatWidth;

            return nFormatWidth;
        }
    }
    else
    {
        int     nLength = 0;
        int     bCheckFieldTerminator = true;

        /* We only check for the field terminator because of some buggy 
         * datasets with missing format terminators.  However, we have found
         * the field terminator is a legal character within the fields of
         * some extended datasets (such as JP34NC94.000).  So we don't check
         * for the field terminator if the field appears to be multi-byte
         * which we established by the first character being out of the 
         * ASCII printable range (32-127). 
         */

        if( pachSourceData[0] < 32 || pachSourceData[0] >= 127 )
            bCheckFieldTerminator = false;
        
        while( nLength < nMaxBytes
               && pachSourceData[nLength] != chFormatDelimeter )
        {
            if( bCheckFieldTerminator 
                && pachSourceData[nLength] == OSSIM_DDF_FIELD_TERMINATOR )
                break;

            nLength++;
        }

        if( pnConsumedBytes != NULL )
        {
            if( nMaxBytes == 0 )
                *pnConsumedBytes = nLength;
            else
                *pnConsumedBytes = nLength+1;
        }
        
        return nLength;
    }
}

GetDefaultValue()

int ossimDDFSubfieldDefn::GetDefaultValue	(	char *	pachData,
		int	nBytesAvailable,
		int *	pnBytesUsed
	)

Get default data.

Returns the default subfield data contents for this subfield definition. For variable length numbers this will normally be "0<unit-terminator>". For variable length strings it will be "<unit-terminator>". For fixed length numbers it is zero filled. For fixed length strings it is space filled. For binary numbers it is binary zero filled.

Parameters

pachData	the buffer into which the returned default will be placed. May be NULL if just querying default size.
nBytesAvailable	the size of pachData in bytes.
pnBytesUsed	will receive the size of the subfield default data in bytes.

Returns

true on success or false on failure or if the passed buffer is too small to hold the default.

Definition at line 744 of file ossimDdfsubfielddefn.cpp.

References bIsVariable, DDFFloat, DDFInt, GetBinaryFormat(), GetType(), nFormatWidth, NotBinary, and OSSIM_DDF_UNIT_TERMINATOR.

{
    int nDefaultSize;

    if( !bIsVariable )
        nDefaultSize = nFormatWidth;
    else
        nDefaultSize = 1;

    if( pnBytesUsed != NULL )
        *pnBytesUsed = nDefaultSize;

    if( pachData == NULL )
        return true;

    if( nBytesAvailable < nDefaultSize )
        return false;

    if( bIsVariable )
    {
        pachData[0] = OSSIM_DDF_UNIT_TERMINATOR;
    }
    else
    {
        if( GetBinaryFormat() == NotBinary )
        {
            if( GetType() == DDFInt || GetType() == DDFFloat )
                memset( pachData, 0, nDefaultSize );
            else
                memset( pachData, ' ', nDefaultSize );
        }
        else
            memset( pachData, 0, nDefaultSize );
    }

    return true;
}

GetFormat()

const char* ossimDDFSubfieldDefn::GetFormat ( )

inline

Get pointer to subfield format string.

Definition at line 291 of file ossimIso8211.h.

References pszFormatString.

Referenced by ossimDDFFieldDefn::AddSubfield().

{ return pszFormatString; }

GetName()

const char* ossimDDFSubfieldDefn::GetName ( )

inline

Get pointer to subfield name.

Definition at line 288 of file ossimIso8211.h.

References pszName.

Referenced by ossimDDFFieldDefn::AddSubfield(), and ossimDDFFieldDefn::FindSubfieldDefn().

{ return pszName; }

GetType()

DDFDataType ossimDDFSubfieldDefn::GetType ( )

inline

Get the general type of the subfield.

This can be used to determine which of ExtractFloatData(), ExtractIntData() or ExtractStringData() should be used.

Returns

The subfield type. One of DDFInt, DDFFloat, DDFString or DDFBinaryString.

Definition at line 302 of file ossimIso8211.h.

References eType.

Referenced by GetDefaultValue().

{ return eType; }

GetWidth()

int ossimDDFSubfieldDefn::GetWidth ( )

inline

Get the subfield width (zero for variable).

Definition at line 324 of file ossimIso8211.h.

References nFormatWidth.

Referenced by ossimDDFFieldDefn::ApplyFormats(), and ossimDDFField::GetRepeatCount().

{ return nFormatWidth; } // zero for variable.

SetFormat()

int ossimDDFSubfieldDefn::SetFormat

(

const char *

pszFormat

)

Definition at line 98 of file ossimDdfsubfielddefn.cpp.

References bIsVariable, DDFBinaryString, DDFFloat, DDFInt, DDFString, eBinaryFormat, eType, nFormatWidth, ossimNotify(), ossimNotifyLevel_WARN, pszFormatString, SInt, and UInt.

Referenced by ossimDDFFieldDefn::AddSubfield().

{
    free( pszFormatString );
    pszFormatString = strdup( pszFormat );

/* -------------------------------------------------------------------- */
/*      These values will likely be used.                               */
/* -------------------------------------------------------------------- */
    if( pszFormatString[1] == '(' )
    {
        nFormatWidth = atoi(pszFormatString+2);
        bIsVariable = nFormatWidth == 0;
    }
    else
        bIsVariable = true;
    
/* -------------------------------------------------------------------- */
/*      Interpret the format string.                                    */
/* -------------------------------------------------------------------- */
    switch( pszFormatString[0] )
    {
      case 'A':
      case 'C':         // It isn't clear to me how this is different than 'A'
        eType = DDFString;
        break;

      case 'R':
        eType = DDFFloat;
        break;
        
      case 'I':
      case 'S':
        eType = DDFInt;
        break;

      case 'B':
      case 'b':
        // Is the width expressed in bits? (is it a bitstring)
        bIsVariable = false;
        if( pszFormatString[1] == '(' )
        {
           // CPLAssert( atoi(pszFormatString+2) % 8 == 0 );
            
            nFormatWidth = atoi(pszFormatString+2) / 8;
            eBinaryFormat = SInt; // good default, works for SDTS.

            if( nFormatWidth < 5 )
                eType = DDFInt;
            else
                eType = DDFBinaryString;
        }
        
        // or do we have a binary type indicator? (is it binary)
        else
        {
            eBinaryFormat = (DDFBinaryFormat) (pszFormatString[1] - '0');
            nFormatWidth = atoi(pszFormatString+2);

            if( eBinaryFormat == SInt || eBinaryFormat == UInt )
                eType = DDFInt;
            else
                eType = DDFFloat;
        }
        break;

      case 'X':
        // 'X' is extra space, and shouldn't be directly assigned to a
        // subfield ... I haven't encountered it in use yet though.
        ossimNotify(ossimNotifyLevel_WARN)
           << "Format type of `%c' not supported.\n"
           << pszFormatString[0] << std::endl;
        
        // CPLAssert( false );
        return false;
        
      default:
        ossimNotify(ossimNotifyLevel_WARN)
           << "Format type of `%c' not recognised.\n"
           << pszFormatString[0] << std::endl;
        
        // CPLAssert( false );
        return false;
    }
    
    return true;
}

SetName()

void ossimDDFSubfieldDefn::SetName

(

const char *

pszName

)

Definition at line 74 of file ossimDdfsubfielddefn.cpp.

References pszName.

Referenced by ossimDDFFieldDefn::AddSubfield(), and ossimDDFFieldDefn::BuildSubfields().

{
    int         i;
    
    free( pszName );

    pszName = strdup( pszNewName );

    for( i = (int)strlen(pszName)-1; i > 0 && pszName[i] == ' '; i-- )
        pszName[i] = '\0';
}

Member Data Documentation

bIsVariable

int ossimDDFSubfieldDefn::bIsVariable

private

Definition at line 359 of file ossimIso8211.h.

Referenced by FormatFloatValue(), FormatIntValue(), FormatStringValue(), GetDataLength(), GetDefaultValue(), ossimDDFSubfieldDefn(), and SetFormat().

chFormatDelimeter

char ossimDDFSubfieldDefn::chFormatDelimeter

private

Definition at line 361 of file ossimIso8211.h.

Referenced by GetDataLength(), and ossimDDFSubfieldDefn().

eBinaryFormat

DDFBinaryFormat ossimDDFSubfieldDefn::eBinaryFormat

private

Definition at line 353 of file ossimIso8211.h.

Referenced by ExtractFloatData(), ExtractIntData(), GetBinaryFormat(), ossimDDFSubfieldDefn(), and SetFormat().

eType

DDFDataType ossimDDFSubfieldDefn::eType

private

Definition at line 352 of file ossimIso8211.h.

Referenced by DumpData(), GetType(), ossimDDFSubfieldDefn(), and SetFormat().

nFormatWidth

int ossimDDFSubfieldDefn::nFormatWidth

private

Definition at line 362 of file ossimIso8211.h.

Referenced by ExtractFloatData(), ExtractIntData(), FormatFloatValue(), FormatIntValue(), FormatStringValue(), GetDataLength(), GetDefaultValue(), GetWidth(), ossimDDFSubfieldDefn(), and SetFormat().

nMaxBufChars

int ossimDDFSubfieldDefn::nMaxBufChars

private

Definition at line 368 of file ossimIso8211.h.

Referenced by ExtractStringData(), and ossimDDFSubfieldDefn().

pachBuffer

char* ossimDDFSubfieldDefn::pachBuffer

private

Definition at line 369 of file ossimIso8211.h.

Referenced by ExtractStringData(), ossimDDFSubfieldDefn(), and ~ossimDDFSubfieldDefn().

pszFormatString

char* ossimDDFSubfieldDefn::pszFormatString

private

Definition at line 350 of file ossimIso8211.h.

Referenced by Dump(), ExtractFloatData(), ExtractIntData(), FormatIntValue(), GetDataLength(), GetFormat(), ossimDDFSubfieldDefn(), SetFormat(), and ~ossimDDFSubfieldDefn().

pszName

char* ossimDDFSubfieldDefn::pszName

private

Definition at line 349 of file ossimIso8211.h.

Referenced by Dump(), DumpData(), ExtractIntData(), GetDataLength(), GetName(), ossimDDFSubfieldDefn(), SetName(), and ~ossimDDFSubfieldDefn().

---

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

• ossimIso8211.h
• ossimDdfsubfielddefn.cpp