ISO8211Lib
Public Member Functions | List of all members
DDFFieldDefn Class Reference

#include <iso8211.h>

Public Member Functions

void Dump (FILE *fp)
 
const char * GetName () const
 
const char * GetDescription () const
 
int GetSubfieldCount () const
 
DDFSubfieldDefnGetSubfield (int i)
 
DDFSubfieldDefnFindSubfieldDefn (const char *)
 
int GetFixedWidth () const
 
int IsRepeating () const
 
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

◆ Dump()

void DDFFieldDefn::Dump ( FILE *  fp)

Write out field definition info to debugging file.

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

Parameters
fpThe standard IO file handle to write to. i.e. stderr

◆ FindSubfieldDefn()

DDFSubfieldDefn * DDFFieldDefn::FindSubfieldDefn ( const char *  pszMnemonic)

Find a subfield definition by its mnemonic tag.

Parameters
pszMnemonicThe name of the field.
Returns
The subfield pointer, or NULL if there isn't any such subfield.

◆ GetDefaultValue()

char * DDFFieldDefn::GetDefaultValue ( int *  pnSize)

Return default data for field instance.

◆ GetDescription()

const char* DDFFieldDefn::GetDescription ( ) const
inline

Fetch a longer description of this field.

Returns
this is an internal copy and should not be freed.

◆ GetFixedWidth()

int DDFFieldDefn::GetFixedWidth ( ) const
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.

◆ GetName()

const char* DDFFieldDefn::GetName ( ) const
inline

Fetch a pointer to the field name (tag).

Returns
this is an internal copy and should not be freed.

◆ GetSubfield()

DDFSubfieldDefn * DDFFieldDefn::GetSubfield ( int  i)

Fetch a subfield by index.

Parameters
iThe index subfield index. (Between 0 and GetSubfieldCount()-1)
Returns
The subfield pointer, or NULL if the index is out of range.

◆ GetSubfieldCount()

int DDFFieldDefn::GetSubfieldCount ( ) const
inline

Get the number of subfields.

◆ IsRepeating()

int DDFFieldDefn::IsRepeating ( ) const
inline

Fetch repeating flag.

See also
DDFField::GetRepeatCount()
Returns
TRUE if the field is marked as repeating.

◆ SetRepeatingFlag()

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: