TK_Dispatch_XML

Detailed Description

class TK_Dispatch_XML : public TK_XML

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.

Public Functions

TK_Dispatch_XML(HBaseModel *model)

Constructs a TK_Dispatch_XML object.

Parameters:model – A pointer to HBaseModel object.
~TK_Dispatch_XML()
TK_Status Interpret(BStreamFileToolkit &tk, ID_Key key, int variant)

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

Parameters:
  • tk – A reference to the BStreamFileToolkit object.
  • key – The key that you want to extract information from.
  • variant – Optional information specific to the object specified by the key.
TK_Status Execute(BStreamFileToolkit &tk)

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

Parameters:tk – A reference to the BStreamFileToolkit object.
TK_Status Read(BStreamFileToolkit &tk)

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

Parameters:tk – A reference to the BStreamFileToolkit object.
void 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:handler – A pointer to the handler that you want to register.
inline void StopIteration()

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

TK_Dispatch_XML *MakeCopy()

This method makes an exact copy of itself.

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