DDFFieldDefn Class Reference

#include <iso8211.h>

List of all members.

Public Member Functions

void Dump (FILE *fp)
const char * GetName ()
const char * GetDescription ()
int GetSubfieldCount ()
DDFSubfieldDefnGetSubfield (int i)
DDFSubfieldDefnFindSubfieldDefn (const char *)
int GetFixedWidth ()
int IsRepeating ()
void SetRepeatingFlag (int n)
char * GetDefaultValue (int *pnSize)

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.


Member Function Documentation

void DDFFieldDefn::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
DDFSubfieldDefn * DDFFieldDefn::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.
char * DDFFieldDefn::GetDefaultValue ( int *  pnSize  ) 

Return default data for field instance.

const char* DDFFieldDefn::GetDescription (  )  [inline]

Fetch a longer descriptio of this field.

Returns:
this is an internal copy and shouldn't be freed.
int DDFFieldDefn::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.
const char* DDFFieldDefn::GetName (  )  [inline]

Fetch a pointer to the field name (tag).

Returns:
this is an internal copy and shouldn't be freed.
DDFSubfieldDefn * DDFFieldDefn::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.
int DDFFieldDefn::GetSubfieldCount (  )  [inline]

Get the number of subfields.

int DDFFieldDefn::IsRepeating (  )  [inline]

Fetch repeating flag.

See also:
DDFField::GetRepeatCount()
Returns:
TRUE if the field is marked as repeating.
void DDFFieldDefn::SetRepeatingFlag ( int  n  )  [inline]

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


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

Generated on 2 Aug 2014 for ISO8211Lib by  doxygen 1.6.1