BBaseOpcodeHandler

class BBaseOpcodeHandler

The BBaseOpcodeHandler abstract class is used as a base for derived classes which manage logical pieces of HOOPS Stream File information

BBaseOpcodeHandler provides virtual functions which are implemented by derived classes to handle reading, writing, execution and interpretation of HOOPS Stream File information. Execution refers to the process of populating application-specific data structures with the information that has been read. Interpretation refers to the process of extracting application-specific data to prepare it for subsequent writing.

Each opcode handler manages opcodes which represent the various HOOPS/3dGS scene-graph objects which include segments, attributes, and geometric primitives.

The HSF file reading process involves reading the opcode at the start of each piece of binary information, and calling the Read method of the associated opcode handler. After the opcode handler reports that reading is complete, the Execute method should be called. (When using HoopsStream or BaseStream, the ParseBuffer method of the BStreamFileToolkit object encapsulates this process.)

The HSF file writing process involves determining the proper opcode for each piece of binary information, and calling the Interpret method of the associated opcode handler. After interpretation is complete, the Write method of the opcode handler should be called until writing is complete. (When using HoopsStream, the GenerateBuffer method of the HStreamFileToolkit encapsulates this process. However, if BaseStream is used, the Interpret/Write process must be performed manually.)

Inherits from: BControlledMemoryObject

Index

Methods

Variables

Enumerations

Methods

int BBaseOpcodeHandler::choose_crc_bytes(uint32_t input, uint8_t bytes, unsigned char *chosen)

protected

int BBaseOpcodeHandler::choose_crc_bytes(uint32_t input, CRC bytes, unsigned char *chosen)

protected

uint8_t BBaseOpcodeHandler::selector(int size)

protected

TK_Status BBaseOpcodeHandler::GetOpcode(BStreamFileToolkit &tk, unsigned char &opcode)

protected

Gets a the object’s opcode into the toolkit buffer and initializes CRC; returns result of function call.

TK_Status BBaseOpcodeHandler::GetGeneral(BStreamFileToolkit &tk, unsigned char valid_bits = 0)

protected

Gets a the object’s general flags from the toolkit buffer if appropriate; returns result of function call.

TK_Status BBaseOpcodeHandler::GetCRC(BStreamFileToolkit &tk, uint8_t bytes = uint8_t(CRC::All))

protected

Gets a selected portion of the object’s CRC value from the toolkit buffer if appropriate, and compares to the value generated from reading the object; returns result of function call.

TK_Status BBaseOpcodeHandler::GetCRC(BStreamFileToolkit &tk, CRC bytes)

protected

TK_Status BBaseOpcodeHandler::PutOpcode(BStreamFileToolkit &tk, int adjust = 1)

protected

Puts a the object’s opcode into the toolkit buffer; returns result of function call.

TK_Status BBaseOpcodeHandler::PutGeneral(BStreamFileToolkit &tk)

protected

Puts a the object’s general flags into the toolkit buffer if appropriate; returns result of function call.

TK_Status BBaseOpcodeHandler::PutCRC(BStreamFileToolkit &tk, uint8_t bytes = uint8_t(CRC::All))

protected

Puts a selected portion of the object’s CRC value into the toolkit buffer if appropriate; returns result of function call.

TK_Status BBaseOpcodeHandler::PutCRC(BStreamFileToolkit &tk, CRC bytes)

protected

void BBaseOpcodeHandler::log_opcode(BStreamFileToolkit &tk, unsigned int sequence, unsigned char opcode)

protected

for internal use only

void BBaseOpcodeHandler::floats_to_bytes(float const *in, unsigned char *out, int count) const

protected const

for internal use only

void BBaseOpcodeHandler::bytes_to_floats(unsigned char const *in, float *out, int count) const

protected const

for internal use only

void BBaseOpcodeHandler::add_segment(BStreamFileToolkit &tk, ID_Key key)

protected

for internal use only

ID_Key BBaseOpcodeHandler::remove_segment(BStreamFileToolkit &tk)

protected

for internal use only

void BBaseOpcodeHandler::set_last_key(BStreamFileToolkit &tk, ID_Key key)

protected

sets the given key as “most recent” on the toolkit for the purposes of associating keys with indices

ID_Key BBaseOpcodeHandler::last_key(BStreamFileToolkit &tk) const

protected const

obsolete

void BBaseOpcodeHandler::adjust_written(BStreamFileToolkit &tk, int count)

protected

for internal use only

void BBaseOpcodeHandler::increase_nesting(BStreamFileToolkit &tk, int amount = 1)

protected

for internal use only

void BBaseOpcodeHandler::decrease_nesting(BStreamFileToolkit &tk, int amount = 1)

protected

for internal use only

void BBaseOpcodeHandler::Revisit(BStreamFileToolkit &tk, float priority = 0.0f, int variant = 0) const

protected const

Indicates that an object requires further processing during a subsequent pass

BBaseOpcodeHandler *BBaseOpcodeHandler::Opcode_Handler(BStreamFileToolkit &tk, unsigned char op) const

protected const

Allows an object to access handlers defined for other objects

void BBaseOpcodeHandler::Record_Instance(BStreamFileToolkit &tk, ID_Key key, int variant, int val1, int val2, int val3) const

protected const

Allows us to later find objects which are a [transformed] copy of previous objects

bool BBaseOpcodeHandler::Find_Instance(BStreamFileToolkit &tk, int val1, int val2, int val3)

protected

Searches for objects which are a [transformed] copy of previous objects

void BBaseOpcodeHandler::Remember_Item(BStreamFileToolkit &tk, ID_Key key) const

protected const

Allows us to remember which segments have been processed (avoid multiple writes of inclusions)

bool BBaseOpcodeHandler::Find_Item(BStreamFileToolkit &tk, ID_Key key) const

protected const

Determines if a segment has already been processed (avoid multiple writes of inclusions)

bool BBaseOpcodeHandler::validate_count(int count, int limit = 1 << 24) const

protected const

sanity checking. for internal use only

bool BBaseOpcodeHandler::validate_count(int count, bool negative_ok, int limit = 1 << 24) const

protected const

TK_Status BBaseOpcodeHandler::SkipNewlineAndTabs(BStreamFileToolkit &tk, unsigned int *readSize = 0)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::ReadAsciiLine(BStreamFileToolkit &tk, unsigned int *readSize = 0)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::ReadAsciiWord(BStreamFileToolkit &tk, unsigned int *readSize = 0)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::ReadEndOpcode(BStreamFileToolkit &tk)

protected

This is a deprecated method.

bool BBaseOpcodeHandler::RemoveAngularBrackets(char *string)

protected

This is a deprecated method.

bool BBaseOpcodeHandler::RemoveQuotes(char *string)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::Read_Referenced_Segment(BStreamFileToolkit &tk, int &i_progress)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiData(BStreamFileToolkit &tk, int *rInts, unsigned int n)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiData(BStreamFileToolkit &tk, char const *tag, unsigned char &value)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiData(BStreamFileToolkit &tk, char const *tag, char &value)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiData(BStreamFileToolkit &tk, char const *tag, unsigned short &value)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiData(BStreamFileToolkit &tk, char const *tag, short &value)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiData(BStreamFileToolkit &tk, char const *tag, int &value)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiData(BStreamFileToolkit &tk, char const *tag, float &value)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiData(BStreamFileToolkit &tk, char const *tag, float *rFloats, unsigned int n)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiData(BStreamFileToolkit &tk, char const *tag, char *m_string, unsigned int n)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiData(BStreamFileToolkit &tk, char const *tag, unsigned char *m_string, unsigned int n)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiData(BStreamFileToolkit &tk, char const *tag, int *rInts, unsigned int n)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiData(BStreamFileToolkit &tk, char const *tag, short *rShorts, unsigned int n)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiData(BStreamFileToolkit &tk, char const *tag, unsigned short *rShorts, unsigned int n)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiHex(BStreamFileToolkit &tk, char const *tag, unsigned char &value)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiHex(BStreamFileToolkit &tk, char const *tag, int &value)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiHex(BStreamFileToolkit &tk, char const *tag, char &value)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiHex(BStreamFileToolkit &tk, char const *tag, unsigned short &value)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::GetAsciiImageData(BStreamFileToolkit &tk, char const *tag, unsigned char *rValues, unsigned int n)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiOpcode(BStreamFileToolkit &tk, int adjust = 1, bool is_end = false, bool want_newline = true)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiData(BStreamFileToolkit &tk, char const *tag, char const *b, int n)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiData(BStreamFileToolkit &tk, char const *tag, short const *s, int n)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiData(BStreamFileToolkit &tk, char const *tag, int const *i, int n)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiData(BStreamFileToolkit &tk, char const *tag, float const *f, int n)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiData(BStreamFileToolkit &tk, char const *tag, unsigned char const *b, int n)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiData(BStreamFileToolkit &tk, char const *tag, unsigned short const *s, int n)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiData(BStreamFileToolkit &tk, char const *tag, unsigned int const *i, int n)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiData(BStreamFileToolkit &tk, char const *tag, char const &c)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiData(BStreamFileToolkit &tk, char const *tag, short const &s)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiData(BStreamFileToolkit &tk, char const *tag, int const &i)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiFlag(BStreamFileToolkit &tk, char const *tag, int const &i)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiData(BStreamFileToolkit &tk, char const *tag, unsigned char const &b)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiData(BStreamFileToolkit &tk, char const *tag, unsigned short const &s)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiData(BStreamFileToolkit &tk, char const *tag, unsigned int const &i)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiData(BStreamFileToolkit &tk, char const *tag, float const &f)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiMask(BStreamFileToolkit &tk, char const *tag, int const &i)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutAsciiHex(BStreamFileToolkit &tk, char const *tag, int const &i)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutStartXMLTag(BStreamFileToolkit &tk, char const *tag)

protected

This is a deprecated method.

TK_Status BBaseOpcodeHandler::PutEndXMLTag(BStreamFileToolkit &tk, char const *tag)

protected

This is a deprecated method.

BBaseOpcodeHandler::BBaseOpcodeHandler(int op)

Default constructor for an BBaseOpcodeHandler object

Parameters

op: value denoting the opcode that the object supports. This is necessary for opcode handlers that support more than one opcode, such as TK_Polypoint, which supports both TKE_Polygon and TKE_Polyline opcodes.
virtual BBaseOpcodeHandler::~BBaseOpcodeHandler()

virtual

virtual TK_Status BBaseOpcodeHandler::Read(BStreamFileToolkit &tk) = 0

virtual

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 BBaseOpcodeHandler::Write(BStreamFileToolkit &tk) = 0

virtual

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.
virtual TK_Status BBaseOpcodeHandler::Execute(BStreamFileToolkit &tk)

virtual

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 BBaseOpcodeHandler::Interpret(BStreamFileToolkit &tk, ID_Key key, int variant = 0)

virtual

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.
virtual TK_Status BBaseOpcodeHandler::Interpret(BStreamFileToolkit &tk, ID_Key key, char const *special)

virtual

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 BBaseOpcodeHandler::Reset()

virtual

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.

virtual bool BBaseOpcodeHandler::Match_Instance(BStreamFileToolkit const &tk, Recorded_Instance *instance)

virtual

Determines whether a stored instance of an object is compatible with the current object, and if it is, prepares the object to write the instance instead.

unsigned char BBaseOpcodeHandler::Opcode() const

const

Returns the current opcode

unsigned char BBaseOpcodeHandler::General_Flags() const

const

Returns the current general flags

void BBaseOpcodeHandler::Set_General_Flags(int f)

Sets the current general flags

int BBaseOpcodeHandler::Pass(BStreamFileToolkit &tk) const

const

The toolkit makes multiple passes of objects which have LOD representations in the HOOPS database. This function returns the number of the pass which the toolkit is currently on.

TK_Status BBaseOpcodeHandler::Tag(BStreamFileToolkit &tk, int variant = -1) const

const

Adds a Tag to the file for the current object, and also adds an entry to the toolkit’s tag table which stores an association between the tag (also called an ‘index’) and the current object’s HOOPS key

bool BBaseOpcodeHandler::Tagging(BStreamFileToolkit &tk) const

const

Provides a simple interface to check if this object requires tagging or the toolkit is set for Force_Tags.

void BBaseOpcodeHandler::SetNeedsTag(bool n)

Sets whether the object requests tagging

bool BBaseOpcodeHandler::NeedsTag() const

const

Determine if the object is set to request tagging

void BBaseOpcodeHandler::SetCollectionPart(bool n)

Sets whether the object is part of a collection

bool BBaseOpcodeHandler::IsCollectionPart() const

const

Determine if the object is part of a collection

virtual TK_Status BBaseOpcodeHandler::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

const virtual

Copies the opcode handler

Parameters

tk: A reference to the BStreamFileToolkit object.

handler: A pointer to the opcode handler object. Passed by reference.

Returns

The result of the function call.
virtual bool BBaseOpcodeHandler::NeedsContext(BStreamFileToolkit &tk) const

const virtual

Allows the handler to specify if it needs the containing context to be reopened (currently only used for revisits on geometry references)

Returns

The answer.
void BBaseOpcodeHandler::SetLoggingString(char const *segment)

Set the debug string. Makes sure the buffer is big enough to hold the debug string, and copies it in

void BBaseOpcodeHandler::SetLoggingString(int length)

Set the debug string. Makes sure the buffer is big enough to hold a string of ‘length’ characters

char const *BBaseOpcodeHandler::GetLoggingString() const

const

Get the debug string. Returns a pointer to the current debug string

char *BBaseOpcodeHandler::GetLoggingString()

Get the debug string buffer. Returns a pointer to the current debug string buffer which may then be modified directly

void BBaseOpcodeHandler::LogDebug(BStreamFileToolkit &tk, char const *string = 0)

write out any logging string (provided or previously recorded) and reset

static TK_Status BBaseOpcodeHandler::GetData(BStreamFileToolkit &tk, char *b, int n)

protected static

Gets n characters from the toolkit buffer and writes them into buffer b; returns result of function call.

static TK_Status BBaseOpcodeHandler::GetData(BStreamFileToolkit &tk, short *s, int n)

protected static

Gets n short integers from the toolkit buffer and writes them into buffer s; returns result of function call.

static TK_Status BBaseOpcodeHandler::GetData(BStreamFileToolkit &tk, int *i, int n)

protected static

Gets n integers from the toolkit buffer and writes them into buffer i; returns result of function call.

static TK_Status BBaseOpcodeHandler::GetData(BStreamFileToolkit &tk, float *f, int n)

protected static

Gets n floats from the toolkit buffer and writes them into buffer f; returns result of function call.

static TK_Status BBaseOpcodeHandler::GetData(BStreamFileToolkit &tk, double *d, int n)

protected static

Gets n doubles from the toolkit buffer and writes them into buffer d; returns result of function call.

static TK_Status BBaseOpcodeHandler::GetData(BStreamFileToolkit &tk, unsigned char *b, int n)

protected static

Gets n unsigned characters from the toolkit buffer and writes them into buffer b; returns result of function call.

static TK_Status BBaseOpcodeHandler::GetData(BStreamFileToolkit &tk, unsigned short *s, int n)

protected static

Gets n unsigned shorts from the toolkit buffer and writes them into buffer s; returns result of function call.

static TK_Status BBaseOpcodeHandler::GetData(BStreamFileToolkit &tk, unsigned int *i, int n)

protected static

Gets n unsigned integers from the toolkit buffer and writes them into buffer i; returns result of function call.

static TK_Status BBaseOpcodeHandler::GetData(BStreamFileToolkit &tk, char &c)

protected static

Gets a single characters from the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::GetData(BStreamFileToolkit &tk, short &s)

protected static

Gets a single short integer from the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::GetData(BStreamFileToolkit &tk, int &i)

protected static

Gets a single integer from the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::GetData(BStreamFileToolkit &tk, unsigned char &b)

protected static

Gets a single unsigned character from the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::GetData(BStreamFileToolkit &tk, unsigned short &s)

protected static

Gets a single unsigned short integer from the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::GetData(BStreamFileToolkit &tk, unsigned int &i)

protected static

Gets a single unsigned integer from the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::GetData(BStreamFileToolkit &tk, float &f)

protected static

Gets a single float from the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::GetData(BStreamFileToolkit &tk, double &d)

protected static

Gets a single double from the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::LookatData(BStreamFileToolkit &tk, unsigned char &b)

protected static

Examines a single unsigned character from the toolkit buffer (does not Get); returns result of function call.

static TK_Status BBaseOpcodeHandler::PutData(BStreamFileToolkit &tk, char const *b, int n)

protected static

Puts n characters from buffer b into the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::PutData(BStreamFileToolkit &tk, short const *s, int n)

protected static

Puts n short integers from buffer s into the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::PutData(BStreamFileToolkit &tk, int const *i, int n)

protected static

Puts n integers from buffer i into the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::PutData(BStreamFileToolkit &tk, float const *f, int n)

protected static

Puts n floats from buffer f into the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::PutData(BStreamFileToolkit &tk, double const *d, int n)

protected static

Puts n doubles from buffer d into the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::PutData(BStreamFileToolkit &tk, unsigned char const *b, int n)

protected static

Puts n unsigned characters from buffer b into the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::PutData(BStreamFileToolkit &tk, unsigned short const *s, int n)

protected static

Puts n unsigned short integers from buffer s into the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::PutData(BStreamFileToolkit &tk, unsigned int const *i, int n)

protected static

Puts n unsigned integers from buffer i into the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::PutData(BStreamFileToolkit &tk, char const &c)

protected static

Puts a single character c into the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::PutData(BStreamFileToolkit &tk, short const &s)

protected static

Puts a single short integer s into the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::PutData(BStreamFileToolkit &tk, int const &i)

protected static

Puts a single integer i into the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::PutData(BStreamFileToolkit &tk, unsigned char const &b)

protected static

Puts a single unsigned character b into the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::PutData(BStreamFileToolkit &tk, unsigned short const &s)

protected static

Puts a single unsigned short s into the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::PutData(BStreamFileToolkit &tk, unsigned int const &i)

protected static

Puts a single unsigned integer i into the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::PutData(BStreamFileToolkit &tk, float const &f)

protected static

Puts a single float f into the toolkit buffer; returns result of function call.

static TK_Status BBaseOpcodeHandler::PutData(BStreamFileToolkit &tk, double const &d)

protected static

Puts a single double d into the toolkit buffer; returns result of function call.

static short BBaseOpcodeHandler::flip(short s)

protected static

for internal use only

static int BBaseOpcodeHandler::flip(int i)

protected static

for internal use only

static void BBaseOpcodeHandler::fix(int *i, int n)

protected static

for internal use only

static void BBaseOpcodeHandler::fix(short *s, int n)

protected static

for internal use only

static void BBaseOpcodeHandler::fix_in(float *f, int n)

protected static

for internal use only

static void BBaseOpcodeHandler::fix_in(double *d, int n)

protected static

for internal use only

static void BBaseOpcodeHandler::fix_out(float *f, int n)

protected static

for internal use only

static void BBaseOpcodeHandler::fix_out(double *d, int n)

protected static

for internal use only

static float BBaseOpcodeHandler::read_float(char const *cp, char const **newcpp = 0)

protected static

Internal use: utility functions for conversion between float & string without dealing with locale issues

static float BBaseOpcodeHandler::read_float(char const *cp, char **newcpp)

protected static

for internal use only

Variables

int BBaseOpcodeHandler::m_stage

protected

int

The writing stage.

int BBaseOpcodeHandler::m_progress

protected

int

Tracks the amount of data that has been read/written so far.

unsigned char BBaseOpcodeHandler::m_opcode

protected

unsigned char

The opcode being handled by this particular object.

unsigned char BBaseOpcodeHandler::m_general_flags

protected

unsigned char

Basic flags common to many handlers.

bool BBaseOpcodeHandler::m_needs_tag

protected

bool

Indicate if this object explicitly needs tagging.

bool BBaseOpcodeHandler::m_collection_part

protected

bool

Indicates if this object is part of a LOD collection.

int BBaseOpcodeHandler::m_debug_allocated

protected

int

Size of currently available debug string buffer

char *BBaseOpcodeHandler::m_debug_string

protected

char

Debug String

char *BBaseOpcodeHandler::m_ascii_buffer

protected

char
int BBaseOpcodeHandler::m_ascii_size

protected

int
int BBaseOpcodeHandler::m_ascii_length

protected

int
int BBaseOpcodeHandler::m_ascii_stage

protected

int
int BBaseOpcodeHandler::m_ascii_progress

protected

int

Tracks the amount of data that has been read/written so far by GetAscii functions.

unsigned char BBaseOpcodeHandler::m_byte

protected

unsigned char

temporary

unsigned short BBaseOpcodeHandler::m_unsigned_short

protected

unsigned short

temporary

int BBaseOpcodeHandler::m_int

protected

int

temporary

char BBaseOpcodeHandler::m_char

protected

char

temporary

constexpr uint8_t BBaseOpcodeHandler::CRC_mask

protected static

const expr uint8_t
constexpr int BBaseOpcodeHandler::CRC_bit_count

protected static

const expr int