BxBinxSchema Class Reference

Class defining the BinX XML schema tag names. More...

#include <BxBinxSchema.h>

Inheritance diagram for BxBinxSchema:

List of all members.

Static Public Member Functions
BxBinxTagNumber	search (const char *const tag)
const char *	searchTagByDataClass (int dataclass)

---

Detailed Description

The BinX XML xchema tag names are stored as static strings that can be accessed individually.
The classes BxBinxFile and BxBinxFileWriter use this class to lookup BinX XML schma tag names. Each tag string corresponds to a unique integer value. This class provides methods to search for BinX XML schema tags by string value or by number. The tag names are placed in a hashtable. This supports fast searches based on strings.
The tag names are stored as static constants in the BxBinxSchema::BxBinxTagTable structure. The search facility must be instatiated so that the static strings are placed in a list before a search can be done. All name changes to the BinX XML schema specification must be reflected by a code change in this class to replace the old tag name with the new tag name.
Since: BinX version 1.0.

---

Member Function Documentation

BxBinxTagNumber BxBinxSchema::search (  const char *const  tag  )  [static]

Get the unique number corresponding to a specified BinX XML schema tag name. This method searches the BxBinxTagTable for the specified string. The string should be a valid tag name defined by the BinX XML schema. Example tag name include: dataset, defineType, dim, indexTo, useType, struct, array, union, etc. If the specified input string is not a valid tag name, then the special value BX_TAG_NULL is returned. Parameters: tag  A string containing a tag name. Returns: the BxBinxTagTable number associated with a valid BinX schema tag name, assigned to this BinX schema tag name, The special index value BX_TAG_NULL, if the specified name is not a valid BinX schema tag name.

const char * BxBinxSchema::searchTagByDataClass (  int  dataclass  )  [static]

Get the BinX XML schema tag name corresponding to a specified number. This method returns a pointer to the selected BinX XML schema tag name stored in the BxBinxTagTable. The specified input number must be within the size of the tag name table. If the specified input number is out of range, then a NULL pointer is returned. Parameters: dataclass  A number corresponding to a BinX XML schema tag name. Returns: The BinX schema tag name corresponding to a specified number, if the number is within range, A NULL pointer, if the number is not in range.

---

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

• BxBinxSchema.h
• BxBinxSchema.cpp

---