# TK_Dictionary_Locater

## Functions

| `TK_Dictionary_Locater`
`TK_Status` | `Read`
`TK_Status` | `Write`
`TK_Status` | `ReadAscii`
`TK_Status` | `WriteAscii`
`TK_Status` | `Execute`
`TK_Status` | `Interpret`
`TK_Status` | `Interpret`
void | `Reset`
void | `SetSize`
int | `GetSize`
void | `SetOffset`
int | `GetOffset`

## Detailed Description

class TK_Dictionary_Locater : public BBaseOpcodeHandler

  Handles the TKE_Dictionary_Locater opcode.

  TK_Dictionary_Locater provides support for writing/reading the TKE_Dictionary_Locater opcode object to/from an HSF file.

  The dictionary provides a mean for locating specific entities in the file, the locater will be placed at the end of the file if the dictionary itself isn’t. See the Programming Guide for more detailed information.

  Public Functions

  inline TK_Dictionary_Locater()

    constructor

  virtual TK_Status Read(BStreamFileToolkit &tk)

    Reads data from the toolkit buffer, decodes/decompresses it, and maps it to the opcode handlers data members. User-defined classes which need to write out custom data should utilize one of the available GetData() methods.

    Parameters

      tk – A reference to the BStreamFileToolkit object.

    Returns

      The result of the function call.

  virtual TK_Status Write(BStreamFileToolkit &tk)

    Encodes/compresses data and writes data to the toolkit buffer. User-defined classes which need to write out custom data should utilize one of the available PutData() methods, and first write out the opcode associated with the group of binary data followed by the data itself.

    Parameters

      tk – A reference to the BStreamFileToolkit object.

    Returns

      The result of the function call.

  TK_Status ReadAscii(BStreamFileToolkit &tk)

    Deprecated.

  TK_Status WriteAscii(BStreamFileToolkit &tk)

    Deprecated.

  virtual TK_Status Execute(BStreamFileToolkit &tk)

    Processes the binary data that has been read for the current object, which involves passing the data to application-specific data structures.

    Parameters

      tk – A reference to the BStreamFileToolkit object.

    Returns

      The result of the function call.

  virtual TK_Status Interpret(BStreamFileToolkit &tk, long key, int variant = 0)

    Extracts graphics data (typically from the application’s scene-graph) and maps it to the opcode handler’s data members in preparation for writing out an object to the file.

    Parameters

      - tk – A reference to the BStreamFileToolkit object.

      - key – An identifier to the object (for example, the HOOPS key of a geometry item)

      - variant – optional specification of an alternate form, such as a Level-of-Detail representation

    Returns

      The result of the function call.

  inline virtual TK_Status Interpret(BStreamFileToolkit &tk, long key, char const *special)

    Extracts graphics data (typically from the application’s scene-graph) and maps it to the opcode handler’s data members in preparation for writing out an object to the file.

    Parameters

      - tk – A reference to the BStreamFileToolkit object.

      - key – An identifier to the object (for example, the HOOPS key of a geometry item)

      - special – A string value of particular data

    Returns

      The result of the function call.

  virtual void Reset()

    Resets the current opcode handler. This is called by the toolkit when it is done processing an opcode. This method reinitializes any opcode handler variables and frees up temporary data.

  inline void SetSize(int size)

    Sets the size value

  inline int GetSize() const

    Returns the size value

  inline void SetOffset(int offset)

    Sets the offset value

  inline int GetOffset() const

    Returns the offset value