class Gambit::Printers::coutPrinter
[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) Reset printer and output to clean state. |
| virtual void | finalise(bool abnormal =false) Do final buffer dumps. |
| virtual void | flush() |
| virtual Options | resume_reader_options() Permanently unavailable for this printer. |
| void | check_point(unsigned int mpirank, unsigned long pointID) coutPrinter specific functions |
| virtual void | _print_metadata(map_str_str ) |
| 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. |
| coutPrinter(const Options & options, BasePrinter *const primary =NULL) Constructor (for construction via inifile options) | |
| void | common_constructor(const Options & ) Tasks common to the various constructors. |
| template <class T > void | template_print(T const & value, const std::string & label, const int , const unsigned int mpirank, const unsigned long pointID) Helper print functions. |
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
)
Reset printer and output to clean state.
Reimplements: Gambit::Printers::BaseBasePrinter::reset
function finalise
virtual void finalise(
bool abnormal =false
)
Do final buffer dumps.
Reimplements: Gambit::Printers::BaseBasePrinter::finalise
function flush
inline 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()
Permanently unavailable for this printer.
Reimplements: Gambit::Printers::BasePrinter::resume_reader_options
function check_point
void check_point(
unsigned int mpirank,
unsigned long pointID
)
coutPrinter specific functions
Perform any point-specific logic.
Perform any point-specific logic
function _print_metadata
inline virtual void _print_metadata(
map_str_str
)
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 coutPrinter
coutPrinter(
const Options & options,
BasePrinter *const primary =NULL
)
Constructor (for construction via inifile options)
function common_constructor
void common_constructor(
const Options &
)
Tasks common to the various constructors.
function template_print
template <class T >
inline void template_print(
T const & value,
const std::string & label,
const int ,
const unsigned int mpirank,
const unsigned long pointID
)
Helper print functions.
Updated on 2024-07-18 at 13:53:32 +0000