Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

---

DDFFieldDefn Class Reference

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

#include <iso8211.h>

List of all members.

Public Members
		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.
		DDFSubfieldDefn*	GetSubfield ( int i )
			Fetch a subfield by index. More...
		DDFSubfieldDefn*	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...

---

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

const char * DDFFieldDefn::GetName ()

Fetch a pointer to the field name (tag).

Returns:

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

const char * DDFFieldDefn::GetDescription ()

Fetch a longer descriptio of this field.

Returns:

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

DDFSubfieldDefn * DDFFieldDefn::GetSubfield (int i)

Fetch a subfield by index.

Parameters:

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

Returns:

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

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

Find a subfield definition by it's mnemonic tag.

Parameters:

The - name of the field.

Returns:

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

int DDFFieldDefn::GetFixedWidth ()

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.

int DDFFieldDefn::IsRepeating ()

Fetch repeating flag.

See also:

DDFField::GetRepeatCount()

Returns:

TRUE if the field is marked as repeating.

---

The documentation for this classwas generated from the following files:

• iso8211.h
• ddffielddefn.cpp

---