CdotXSIDict Class Reference

Class used for dictionary entries (binary format). More...

#include <XSIParser.h>

List of all members.

Public Member Functions
  CdotXSIDict ()
  ~CdotXSIDict ()
SI_Void  Init (SI_Int i_nCount)
SI_Void  Add (SI_Char *i_pLabel)
SI_Int  GetCount ()
SI_Void  Find (SI_Int i_nInd, SI_Char **o_pLabel)
SI_Int  Find (SI_Char *i_pLabel)
SI_Void  Read (_SI_FILE i_pFptr)
SI_Void  Write (_SI_FILE i_pFptr)

Detailed Description

Class used for dictionary entries (binary format).

Constructor & Destructor Documentation

CdotXSIDict (  ) 

Constructor

~CdotXSIDict (  ) 

Destructor

Member Function Documentation

SI_Void Init ( SI_Int  i_nCount  ) 

Initializes the dictionary with a preallocated number of elements.

Parameters:
[in]  i_nCount  Number of elements

SI_Void Add ( SI_Char *  i_pLabel  ) 

Adds an element (they must be preallocated first).

Parameters:
[in]  i_pLabel  New entry

SI_Int GetCount (  ) 

Returns the number of elements.

Returns:
Number of elements

SI_Void Find ( SI_Int  i_nInd,
SI_Char **  o_pLabel  
)

Returns the specified element by index.

Parameters:
[in]  i_nInd  Index of the element to retrieve
[out]  o_pLabel  Returned label

SI_Int Find ( SI_Char *  i_pLabel  ) 

Get the specified element by label.

Parameters:
[in]  i_pLabel  The label to search for
Returns:
Index of the element

SI_Void Read ( _SI_FILE  i_pFptr  ) 

Returns the total number of elements from a file.

Parameters:
[in]  i_pFptr  File pointer to read from

SI_Void Write ( _SI_FILE  i_pFptr  ) 

Writes the used elements to file.

Parameters:
[in]  i_pFptr  File pointer to write to.

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