AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
|
Abstract base class defining the interface of all Combiner classes. More...
#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.3.3/src/axom/lumberjack/Combiner.hpp>
Public Member Functions | |
virtual | ~Combiner () |
Virtual destructor. More... | |
virtual const std::string | id ()=0 |
Returns the unique string identifier for this combiner. Used by Lumberjack to differentiate between other combiners. More... | |
virtual bool | shouldMessagesBeCombined (const Message &leftMessage, const Message &rightMessage)=0 |
Function used by Lumberjack to indicate whether two Message classes should be combined. They are not actually combined by this function. More... | |
virtual void | combine (Message &combined, const Message &combinee, const int ranksLimit)=0 |
Combines the combinee into the combined Message. More... | |
Abstract base class defining the interface of all Combiner classes.
Concrete instances need to inherit from this class and implement these functions. You will need to add your Combiner using Lumberjack::addCombiner
|
inlinevirtual |
Virtual destructor.
References combine(), id(), and shouldMessagesBeCombined().
|
pure virtual |
Returns the unique string identifier for this combiner. Used by Lumberjack to differentiate between other combiners.
Implemented in axom::lumberjack::TextEqualityCombiner.
Referenced by ~Combiner().
|
pure virtual |
Function used by Lumberjack to indicate whether two Message classes should be combined. They are not actually combined by this function.
[in] | leftMessage | The left Message to be compared. |
[in] | rightMessage | The right Message to be compared. |
Implemented in axom::lumberjack::TextEqualityCombiner.
Referenced by ~Combiner().
|
pure virtual |
Combines the combinee into the combined Message.
[in,out] | combined | the Message that will be modified. |
[in] | combinee | the Message that is combined into the other. |
[in] | ranksLimit | limit on how many individual ranks are tracked in combined Messages. Message::rankCount is always incremented. |
Implemented in axom::lumberjack::TextEqualityCombiner.
Referenced by ~Combiner().