TK_PIShell

Functions

TK_PIShell
TK_Status Interpret
TK_Status Write
TK_Status Execute
TK_Status Clone

Detailed Description

class TK_PIShell : public HTK_Shell

A custom HTK_Shell class which includes the HOOPS/3dgs key and pointer to an HSharedKey persistent indentifier object.

Public Functions

inline TK_PIShell(HSharedKey *persIdent)

Constructs a TK_PIShell object.

Parameters:persIdent – A pointer to the shared key that you want to associate with this object.
inline TK_Status Interpret(BStreamFileToolkit &tk, HC_KEY key, int variant = 0)
inline TK_Status Write(BStreamFileToolkit &tk)
inline TK_Status Execute(BStreamFileToolkit &tk)
virtual TK_Status Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

This method makes a copy of itself and return a pointer to the newly created object.

Parameters:
  • tk – A reference to the BStreamFileToolkit object.
  • handler – The method will return a pointer to a copy of itself.
Returns:

A #TK_Status indicating whether the operation was successful.