Mech-Eye API 2.3.3
API reference documentation for Mech-Eye 3D Laser Profiler
|
Represents the data struct of the profile data. More...
#include <BatchArray.h>
Public Member Functions | |
BatchArray (size_t width) | |
Describes a constructor. | |
~BatchArray ()=default | |
Describes a destructor. | |
size_t | width () const |
Returns the width of the BatchArray object. | |
size_t | height () const |
Returns the height of the BatchArray object. | |
void | setHeight (size_t height) |
Sets the height of the BatchArray object. | |
size_t | capacity () const |
Returns the size of the storage space currently allocated for the BatchArray object, expressed in number of lines. | |
bool | isEmpty () const |
Returns true if the BatchArray object has no elements. | |
void | reserve (size_t height) |
Requests for enough capacity of the BatchArray object to contain the number of lines corresponding to the height. | |
bool | append (const BatchArray &data) |
Appends the data variable onto the end of this BatchArray object. | |
const ElementData * | data () const |
Returns the pointer to the element data. | |
ElementData * | data () |
Returns the pointer to the element data. | |
const ElementData & | operator[] (std::size_t n) const |
Returns a const element reference to the specified index in the BatchArray object using the operator []. | |
ElementData & | operator[] (std::size_t n) |
Returns an element reference to the specified index in the BatchArray object using the operator []. | |
const ElementData & | at (uint32_t row, uint32_t col) const |
Returns a const element reference to the specified row and column index in the BatchArray object. | |
ElementData & | at (size_t row, size_t col) |
Returns an element reference to the specified row and column index in the BatchArray object. | |
BatchArray< ElementData > | clone () const |
Creates a deep copy of the BatchArray object. | |
void | clear () |
Clears the data of the BatchArray object. | |
Represents the data struct of the profile data.
Definition at line 14 of file BatchArray.h.
|
inline |
Describes a constructor.
Definition at line 20 of file BatchArray.h.
|
inline |
Appends the data variable onto the end of this BatchArray object.
Definition at line 79 of file BatchArray.h.
|
inline |
Returns an element reference to the specified row and column index in the BatchArray object.
row | Index along the height dimension. An exception is thrown if the input row is greater than width. |
col | Index along the width dimension. An exception is thrown if the input col is greater than height. |
Definition at line 152 of file BatchArray.h.
|
inline |
Returns a const element reference to the specified row and column index in the BatchArray object.
row | Index along the height dimension. An exception is thrown if the input row is greater than width. |
col | Index along the width dimension. An exception is thrown if the input col is greater than height. |
Definition at line 136 of file BatchArray.h.
|
inline |
Returns the size of the storage space currently allocated for the BatchArray object, expressed in number of lines.
Definition at line 51 of file BatchArray.h.
|
inline |
Clears the data of the BatchArray object.
Definition at line 173 of file BatchArray.h.
|
inline |
Creates a deep copy of the BatchArray object.
Definition at line 161 of file BatchArray.h.
|
inline |
Returns the pointer to the element data.
Definition at line 101 of file BatchArray.h.
|
inline |
Returns the pointer to the element data.
Definition at line 96 of file BatchArray.h.
|
inline |
Returns the height of the BatchArray object.
Definition at line 34 of file BatchArray.h.
|
inline |
Returns true if the BatchArray object has no elements.
Definition at line 56 of file BatchArray.h.
|
inline |
Returns an element reference to the specified index in the BatchArray object using the operator [].
n | Index of an element. An exception is thrown if the input n is greater than width * height. |
Definition at line 123 of file BatchArray.h.
|
inline |
Returns a const element reference to the specified index in the BatchArray object using the operator [].
n | Index of an element. An exception is thrown if the input n is greater than width * height. |
Definition at line 109 of file BatchArray.h.
|
inline |
Requests for enough capacity of the BatchArray object to contain the number of lines corresponding to the height.
Definition at line 62 of file BatchArray.h.
|
inline |
Sets the height of the BatchArray object.
Definition at line 39 of file BatchArray.h.
|
inline |
Returns the width of the BatchArray object.
Definition at line 29 of file BatchArray.h.