Base class for the generic wrapper family of functions. More...
#include <generic_wrapper_base.h>
Inheritance diagram for utilities::Generic_wrapper_base:
Collaboration diagram for utilities::Generic_wrapper_base:
Public Member Functions | |
| Generic_wrapper_base (bool a, bool b) | |
| Constructor. | |
| virtual | ~Generic_wrapper_base () |
| Destructor. | |
row operations | |
| virtual void | start_new_row ()=0 |
| Opens a new row to add data to. | |
| virtual void | append_to_row (float data_in)=0 |
| Inputs data to be added to the wrapper. | |
| virtual void | finish_row ()=0 |
| finishes the row and sets it to the underlying structure | |
wrapper operations | |
| virtual void | initialize_wrapper ()=0 |
| Tells the wrapper to setup to accept rows. | |
| virtual void | finalize_wrapper ()=0 |
| cleans up the wrapper | |
Protected Attributes | |
| bool | row_open_ |
| If a row is open to write to. | |
| bool | wrapper_open_ |
| If wrapper is open to write to. | |
Detailed Description
Base class for the generic wrapper family of functions.
These exist because the other wrapper functions are very specific for reading in and writing out particles. These are intended to be used for getting arbitrary data out.
The basic idea is to write to the under ling data structure in atomic rows, ie ask for a new row, fill it with what ever, store to the underling data structure.
This is an abstract base class.
Constructor & Destructor Documentation
| utilities::Generic_wrapper_base::Generic_wrapper_base | ( | bool | a, |
| bool | b | ||
| ) | [inline] |
Constructor.
| virtual utilities::Generic_wrapper_base::~Generic_wrapper_base | ( | ) | [inline, virtual] |
Destructor.
Member Function Documentation
| virtual void utilities::Generic_wrapper_base::append_to_row | ( | float | data_in | ) | [pure virtual] |
Inputs data to be added to the wrapper.
This may write directly in to the underlying data structure, or it may buffer the data until a finalize call
Implemented in utilities::Generic_wrapper_matlab.
Referenced by utilities::Histogram2D::output_to_wrapper(), and utilities::Array::set_array().
| virtual void utilities::Generic_wrapper_base::finalize_wrapper | ( | ) | [pure virtual] |
cleans up the wrapper
Implemented in utilities::Generic_wrapper_matlab.
Referenced by utilities::Histogram2D::output_to_wrapper(), and utilities::Array::set_array().
| virtual void utilities::Generic_wrapper_base::finish_row | ( | ) | [pure virtual] |
finishes the row and sets it to the underlying structure
Implemented in utilities::Generic_wrapper_matlab.
Referenced by utilities::Histogram2D::output_to_wrapper(), and utilities::Array::set_array().
| virtual void utilities::Generic_wrapper_base::initialize_wrapper | ( | ) | [pure virtual] |
Tells the wrapper to setup to accept rows.
Implemented in utilities::Generic_wrapper_matlab.
Referenced by utilities::Histogram2D::output_to_wrapper(), and utilities::Array::set_array().
| virtual void utilities::Generic_wrapper_base::start_new_row | ( | ) | [pure virtual] |
Opens a new row to add data to.
Implemented in utilities::Generic_wrapper_matlab.
Referenced by utilities::Histogram2D::output_to_wrapper(), and utilities::Array::set_array().
Member Data Documentation
bool utilities::Generic_wrapper_base::row_open_ [protected] |
If a row is open to write to.
bool utilities::Generic_wrapper_base::wrapper_open_ [protected] |
If wrapper is open to write to.
The documentation for this class was generated from the following file:
- common_src/include/generic_wrapper_base.h
