Salmon
Loading...
Searching...
No Matches
Buffer Class Reference

Class will be used to cache data that can later be read via the ReadAt() method without requesting frequent reads. More...

Public Member Functions

 __init__ (self, int buffer_size)
 
 clear (self)
 
int get_count (self)
 
bytearray get_data (self)
 
int get_start_pos (self)
 
 set_count (self, count)
 
 set_start_pos (self, start_pos)
 

Detailed Description

Class will be used to cache data that can later be read via the ReadAt() method without requesting frequent reads.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
int buffer_size )
Instantiate a cache buffer.

@param buffer_size:             

Member Function Documentation

◆ clear()

clear ( self)
Clear the buffer.

◆ get_count()

int get_count ( self)
Get the number of bytes in the buffer
@returns The byte count

◆ get_data()

bytearray get_data ( self)
Get the buffer data
@returns The buffer data

◆ get_start_pos()

int get_start_pos ( self)
Get the start position
@returns The start position

◆ set_count()

set_count ( self,
count )
Set the data count
@param count The data count

◆ set_start_pos()

set_start_pos ( self,
start_pos )
Set the start position
@param start_pos The start position

The documentation for this class was generated from the following file: