AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
axom::slic::LogStreamStatusMonitor Class Reference

Monitor log streams to see if there are any pending messages. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/slic/core/LogStreamStatusMonitor.hpp>

Public Member Functions

 LogStreamStatusMonitor ()
 
void addStream (LogStream *ls)
 Add LogStream pointer to vector stored in LogStreamStatusMonitor. More...
 
bool hasPendingMessages () const
 Checks to see if any pending messages exist on the current MPI communicator. More...
 
void finalize ()
 Finalize/clear member data. More...
 

Protected Attributes

std::vector< LogStream * > m_streamVec
 

Detailed Description

Monitor log streams to see if there are any pending messages.

Constructor & Destructor Documentation

◆ LogStreamStatusMonitor()

axom::slic::LogStreamStatusMonitor::LogStreamStatusMonitor ( )

Member Function Documentation

◆ addStream()

void axom::slic::LogStreamStatusMonitor::addStream ( LogStream ls)

Add LogStream pointer to vector stored in LogStreamStatusMonitor.

Parameters
[in]lspointer to the user-supplied LogStream object.
Note
All ranks must call this function with the same set of MPI communicators in the same order.

◆ hasPendingMessages()

bool axom::slic::LogStreamStatusMonitor::hasPendingMessages ( ) const

Checks to see if any pending messages exist on the current MPI communicator.

Note
This call is collective. All ranks in m_mpiComm must call this function.

◆ finalize()

void axom::slic::LogStreamStatusMonitor::finalize ( )

Finalize/clear member data.

Member Data Documentation

◆ m_streamVec

std::vector<LogStream*> axom::slic::LogStreamStatusMonitor::m_streamVec
protected

The documentation for this class was generated from the following file: