class Gambit::Printers::asciiPrinter
[No description available]
Inherits from Gambit::Printers::BasePrinter, Gambit::Printers::BaseBasePrinter
Public Functions
Name | |
---|---|
virtual void | initialise(const std::vector< int > & ) Initialisation function. |
virtual void | reset(bool force =false) Delete contents of output file (to be replaced/updated) and erase everything in the buffer. |
virtual void | finalise(bool abnormal =false) Do final buffer dumps. |
virtual void | flush() |
virtual Options | resume_reader_options() |
virtual void | _print_metadata(map_str_str metadata) |
template <typename T > void | _print(T const & , const std::string & label, const int vertexID, const uint, const ulong) Print functions. |
template <typename T > void | _print(T const & in, const std::string & label, const uint rank, const ulong pointID) Print functions. |
template <class T > void | template_print(T const & value, const std::string & label, const int IDcode, const uint, const ulong) Helper print functions. |
template <class T > void | template_print_vec(std::vector< T > const & value, const std::string & label, const int IDcode, const uint, const ulong) Template for print functions of vectors of “simple” types. |
asciiPrinter(const Options & options, BasePrinter *const primary =NULL) TODO: proper gambit error. | |
void | common_constructor(const Options & options) Tasks common to the various constructors. |
~asciiPrinter() Destructor. | |
void | erase_buffer() Asciiprinter-specific functions. |
void | endline() |
void | addtobuffer(const std::vector< double > & functor_data, const std::vector< std::string > & functor_labels, const int vID, const int rank, const int pointID) |
void | dump_buffer(bool force =false) |
std::string | get_output_filename() |
int | get_bufferlength() |
Additional inherited members
Public Functions inherited from Gambit::Printers::BasePrinter
Name | |
---|---|
BasePrinter() | |
BasePrinter(BasePrinter *const primary, bool is_aux_IN) | |
virtual | ~BasePrinter() Destructor. |
void | set_as_aux() Set this as an auxilliary printer. |
void | set_output_metadata(bool use_metadata) Set/Get whether to print the metadata. |
bool | get_output_metadata() |
virtual void | auxilliary_init() |
BasePrinter * | get_primary_printer() |
bool | is_auxilliary_printer() |
template <typename T > void | print(T const & in, const std::string & label, const int vertexID, const uint rank, const ulong pointID) |
template <typename T > void | print(T const & in, const std::string & label, const uint rank, const ulong pointID) |
Public Functions inherited from Gambit::Printers::BaseBasePrinter
Name | |
---|---|
BaseBasePrinter() | |
virtual | ~BaseBasePrinter() |
int | getRank() Retrieve/Set MPI rank (setting is useful for e.g. the postprocessor to re-print points from other ranks) |
void | setRank(int r) |
bool & | get_printUnitcube() |
void | set_printUnitcube(const bool & rflag) |
std::set< std::string > | getPrintList() |
void | setPrintList(const std::set< std::string > & in) |
void | addToPrintList(const std::string & in) |
bool | get_resume() |
void | set_resume(bool rflag) |
void | disable(int n =-1) |
void | enable() |
template <typename T > void | print(T const & in, const std::string & label, const int vertexID, const uint rank, const ulong pointID) |
template <typename T > void | print(T const & in, const std::string & label, const uint rank, const ulong pointID) |
void | print_metadata(map_str_str datasets) |
Protected Attributes inherited from Gambit::Printers::BaseBasePrinter
Name | |
---|---|
bool | printer_enabled Flag to check if print functions are enabled or disabled. |
int | printer_cooldown Counter for printer cooldown. If non-zero printer can be disabled for a fixed number of print calls. |
Public Functions Documentation
function initialise
virtual void initialise(
const std::vector< int > &
)
Initialisation function.
Reimplements: Gambit::Printers::BasePrinter::initialise
Virtual function overloads:
function reset
virtual void reset(
bool force =false
)
Delete contents of output file (to be replaced/updated) and erase everything in the buffer.
Reimplements: Gambit::Printers::BaseBasePrinter::reset
function finalise
virtual void finalise(
bool abnormal =false
)
Do final buffer dumps.
Reimplements: Gambit::Printers::BaseBasePrinter::finalise
function flush
virtual void flush()
Reimplements: Gambit::Printers::BasePrinter::flush
Signal printer to flush data in buffers to disk Printers should do this automatically as needed, but this is useful if a scanner is printing a bunch of data as a batch, to make sure it is all on disk after the batch is done.
function resume_reader_options
virtual Options resume_reader_options()
Reimplements: Gambit::Printers::BasePrinter::resume_reader_options
function _print_metadata
virtual void _print_metadata(
map_str_str metadata
)
Reimplements: Gambit::Printers::BaseBasePrinter::_print_metadata
function _print
template <typename T >
inline void _print(
T const & ,
const std::string & label,
const int vertexID,
const uint,
const ulong
)
Print functions.
function _print
template <typename T >
inline void _print(
T const & in,
const std::string & label,
const uint rank,
const ulong pointID
)
Print functions.
function template_print
template <class T >
void template_print(
T const & value,
const std::string & label,
const int IDcode,
const uint,
const ulong
)
Helper print functions.
Template for print functions of “simple” types.
PRINT FUNCTIONS Need to define one of these for every type we want to print! Could use macros again to generate identical print functions for all types that have a « operator already defined.
function template_print_vec
template <class T >
void template_print_vec(
std::vector< T > const & value,
const std::string & label,
const int IDcode,
const uint,
const ulong
)
Template for print functions of vectors of “simple” types.
function asciiPrinter
asciiPrinter(
const Options & options,
BasePrinter *const primary =NULL
)
TODO: proper gambit error.
Constructor (for construction via inifile options)
function common_constructor
void common_constructor(
const Options & options
)
Tasks common to the various constructors.
function ~asciiPrinter
~asciiPrinter()
Destructor.
function erase_buffer
void erase_buffer()
Asciiprinter-specific functions.
Clear buffer.
Ask the printer for the highest ID number known for a given rank process (needed for resuming, so the scanner can resume assigning point ID from this value. TODO: This does not work yet! Needed for resuming, which is not yet implemented in the asciiprinter DEPRECATED!
function endline
void endline()
function addtobuffer
void addtobuffer(
const std::vector< double > & functor_data,
const std::vector< std::string > & functor_labels,
const int vID,
const int rank,
const int pointID
)
function dump_buffer
void dump_buffer(
bool force =false
)
function get_output_filename
std::string get_output_filename()
function get_bufferlength
int get_bufferlength()
Updated on 2024-07-18 at 13:53:31 +0000