The TK_Dispatch_XML class stores a list of XML Handlers. More...

#include <HDispatchXML.h>

Public Member Functions

void AddHandler (TK_XML *handler)
 
TK_Status Execute (BStreamFileToolkit &tk)
 
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, int variant)
 
TK_Dispatch_XMLMakeCopy ()
 
TK_Status Read (BStreamFileToolkit &tk)
 
void StopIteration ()
 
 TK_Dispatch_XML (HBaseModel *model)
 

Protected Attributes

struct vlist_s * m_XMLHandlerList
 

Detailed Description

The TK_Dispatch_XML class stores a list of XML Handlers.

This class allows more than one handler to be registered at a time so that multiple chunks of XML data can be read in and written out.

Constructor & Destructor Documentation

◆ TK_Dispatch_XML()

TK_Dispatch_XML::TK_Dispatch_XML ( HBaseModel model)

Constructs a TK_Dispatch_XML object.

Parameters
modelA pointer to HBaseModel object.

Member Function Documentation

◆ AddHandler()

void TK_Dispatch_XML::AddHandler ( TK_XML *  handler)

This method lets you add a handler so it will be on the list that will be iterated when Interpret is invoked.

Parameters
handlerA pointer to the handler that you want to register.

◆ Execute()

TK_Status TK_Dispatch_XML::Execute ( BStreamFileToolkit &  tk)

This method iterates through the list of registers handlers invokes their Execute method.

Parameters
tkA reference to the BStreamFileToolkit object.

◆ Interpret()

TK_Status TK_Dispatch_XML::Interpret ( BStreamFileToolkit &  tk,
ID_Key  key,
int  variant 
)

This method iterates through the list of registers handlers invokes their Interpret method.

Parameters
tkA reference to the BStreamFileToolkit object.
keyThe key that you want to extract information from.
variantOptional information specific to the object specified by the key.

◆ MakeCopy()

TK_Dispatch_XML* TK_Dispatch_XML::MakeCopy ( )

This method makes an exact copy of itself.

Returns
A pointer to the newly created copy of this object.

◆ Read()

TK_Status TK_Dispatch_XML::Read ( BStreamFileToolkit &  tk)

This method iterates through the list of registers handlers invokes their Read method.

Parameters
tkA reference to the BStreamFileToolkit object.

◆ StopIteration()

void TK_Dispatch_XML::StopIteration ( )
inline

This method stops the dispatcher from iterating through the handlers list.

Member Data Documentation

◆ m_XMLHandlerList

struct vlist_s* TK_Dispatch_XML::m_XMLHandlerList
protected

A pointer to the list of XML handlers.


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