RECORDBUFFER Class Reference
Base for record buffer classes. More...
#include <mi32/recordbuffer.h>
Inheritance diagram for RECORDBUFFER:
Public Member Functions | |
| void | Clear () |
| INT8 | GetINT8 (int offset) const |
| const UINT8 * | GetPtr () const |
| UINT8 * | GetPtr () |
| int | GetSize () const |
| UINT8 | GetUINT8 (int offset) const |
| void | PutINT8 (int offset, INT8 value) |
| void | PutString (int offset, int maxchars, const char *string, char fillchar=0) |
| void | PutString (int offset, const char *string) |
| void | PutUINT8 (int offset, UINT8 value) |
| ERRVALUE | Resize (int numbytes, bool keepold=true, bool clear=false) |
Protected Member Functions | |
| RECORDBUFFER () | |
| ~RECORDBUFFER () | |
Detailed Description
Base for record buffer classes.
Constructor & Destructor Documentation
| RECORDBUFFER::RECORDBUFFER | ( | ) | [inline, protected] |
| RECORDBUFFER::~RECORDBUFFER | ( | ) | [inline, protected] |
Member Function Documentation
| void RECORDBUFFER::Clear | ( | ) | [inline] |
Clear data in record - does not change size.
| INT8 RECORDBUFFER::GetINT8 | ( | int | offset | ) | const [inline] |
Get INT8 value from record.
- Parameters:
-
offset Byte offset to value, not validated
| const UINT8* RECORDBUFFER::GetPtr | ( | ) | const [inline] |
Get const pointer to buffer memory.
| UINT8* RECORDBUFFER::GetPtr | ( | ) | [inline] |
Get non-const pointer to buffer memory.
| int RECORDBUFFER::GetSize | ( | ) | const [inline] |
Get record size in bytes.
| UINT8 RECORDBUFFER::GetUINT8 | ( | int | offset | ) | const [inline] |
Get INT8 value from record.
- Parameters:
-
offset Byte offset to value, not validated
| void RECORDBUFFER::PutINT8 | ( | int | offset, | |
| INT8 | value | |||
| ) | [inline] |
Put INT8 value into record.
- Parameters:
-
value Byte offset to value, not validated
| void RECORDBUFFER::PutString | ( | int | offset, | |
| int | maxchars, | |||
| const char * | string, | |||
| char | fillchar = 0 | |||
| ) | [inline] |
Put string of single-byte characters into record with length limitation and fill.
- Parameters:
-
maxchars Byte offset, not validated string Maximum number of characters to copy fillchar String to put in record Fill character if maxchars < string length
| void RECORDBUFFER::PutString | ( | int | offset, | |
| const char * | string | |||
| ) | [inline] |
Put string of single-byte characters into record, only copying characters up to but not including terminator.
- Parameters:
-
string Byte offset, not validated String to put in record
| void RECORDBUFFER::PutUINT8 | ( | int | offset, | |
| UINT8 | value | |||
| ) | [inline] |
Put UINT8 value into record.
- Parameters:
-
value Byte offset to value, not validated
| ERRVALUE RECORDBUFFER::Resize | ( | int | numbytes, | |
| bool | keepold = true, |
|||
| bool | clear = false | |||
| ) | [inline] |
Resize record,.
- Parameters:
-
numbytes New number of bytes keepold Keep existing record entries clear Clear new record entries to zeros
The documentation for this class was generated from the following file:
- mi32/recordbuffer.h
