LUPI::StatusMessageReporting Class Reference

#include <LUPI.hpp>

Public Types
enum class	Status { ok , info , warning , error }

Public Member Functions
	StatusMessageReporting ()
	~StatusMessageReporting ()
statusMessageReporting *	smr ()
bool	isOk ()
bool	isInfo ()
bool	isWarning ()
bool	isError ()
void	clear ()
std::string	constructMessage (std::string a_prefix, int a_reports=1, bool a_clear=false)
std::string	constructFullMessage (std::string const &a_prefix, int a_reports=1, bool a_clear=false)

Detailed Description

Definition at line 100 of file LUPI.hpp.

Member Enumeration Documentation

Status

enum class LUPI::StatusMessageReporting::Status

strong

Enumerator
ok
info
warning
error

Definition at line 103 of file LUPI.hpp.

{ ok, info, warning, error };

Constructor & Destructor Documentation

StatusMessageReporting()

LUPI::StatusMessageReporting::StatusMessageReporting

(

)

Constructor for a StatusMessageReporting instance.

Definition at line 25 of file LUPI_statusMessageReporting.cc.

                                                {
 
    int status = smr_initialize( &m_smr, smr_status_Ok );
 
    if( status != 0 ) throw( "StatusMessageReporting::StatusMessageReporting: Oops." ); // Currently, this should never happend.
}

~StatusMessageReporting()

LUPI::StatusMessageReporting::~StatusMessageReporting

(

)

Destructor for a StatusMessageReporting instance.

Definition at line 36 of file LUPI_statusMessageReporting.cc.

                                                 {
 
    smr_release( &m_smr );
}

Member Function Documentation

clear()

void LUPI::StatusMessageReporting::clear ( )

inline

Definition at line 117 of file LUPI.hpp.

{ smr_release( &m_smr ); }

Referenced by constructFullMessage(), and constructMessage().

constructFullMessage()

std::string LUPI::StatusMessageReporting::constructFullMessage	(	std::string const &	a_prefix,
		int	a_reports = 1,
		bool	a_clear = false )

Returns the first a_reports reports from m_smr with a_prefix appended to the beginning of the returned string.

Parameters

a_prefix	[in] A string added to the beginning of the message.
a_report	[in] The maximum number of reports to include in the message.
a_clear	[in] If true, calls the clear() method after the message is constructed.

Definition at line 81 of file LUPI_statusMessageReporting.cc.

                                                                                                               {
 
    std::string message( a_prefix );
    statusMessageReport const *report;
 
    for( report = smr_firstReport( &m_smr ); report != NULL; report = smr_nextReport( report ), --a_reports ) {
        if( a_reports == 0 ) break;
 
        char *reportMessage = smr_copyFullMessage( report );
        if( reportMessage != nullptr ) {
            message += '\n';
            message += reportMessage;
            free( reportMessage );
        }
    }
    if( a_clear ) clear( );
 
    return( message );
}

constructMessage()

std::string LUPI::StatusMessageReporting::constructMessage	(	std::string	a_prefix,
		int	a_reports = 1,
		bool	a_clear = false )

Returns the first a_reports reports from m_smr with a_prefix appended to the beginning of the returned string.

Parameters

a_prefix	[in] A string added to the beginning of the message.
a_report	[in] The maximum number of reports to include in the message.
a_clear	[in] If true, calls the clear() method after the message is constructed.

Definition at line 49 of file LUPI_statusMessageReporting.cc.

                                                                                                    {
 
    std::string sep( "" );
    std::string message( a_prefix );
    statusMessageReport const *report;
 
    if( a_prefix == "" ) sep = "\n";
 
    for( report = smr_firstReport( &m_smr ); report != NULL; report = smr_nextReport( report ), --a_reports ) {
        if( a_reports == 0 ) break;
 
        char *reportMessage = smr_copyMessage( report );
        if( reportMessage != nullptr ) {
            message += sep;
            message += reportMessage;
            free( reportMessage );
            sep = "\n";
        }
    }
    if( a_clear ) clear( );
 
    return( message );
}

Referenced by GIDI::Functions::XYs1d::domainSlice(), GIDI::Functions::XYs1d::integrate(), GIDI::Functions::XYs1d::mapToXsAndAdd(), GIDI::Functions::XYs1d::normalize(), GIDI::Functions::XYs1d::operator*=(), GIDI::Functions::XYs1d::operator*=(), GIDI::Functions::XYs1d::operator+=(), GIDI::Functions::XYs1d::operator-=(), GIDI::Functions::XYs1d::operator=(), and GIDI::Functions::XYs1d::toXs_pdf_cdf1d().

isError()

bool LUPI::StatusMessageReporting::isError ( )

inline

Definition at line 116 of file LUPI.hpp.

{ return( smr_isError( &m_smr ) ); }

isInfo()

bool LUPI::StatusMessageReporting::isInfo ( )

inline

Definition at line 114 of file LUPI.hpp.

{ return( smr_isInfo( &m_smr ) ); }

isOk()

bool LUPI::StatusMessageReporting::isOk ( )

inline

Definition at line 113 of file LUPI.hpp.

{ return( smr_isOk( &m_smr ) ); }

isWarning()

bool LUPI::StatusMessageReporting::isWarning ( )

inline

Definition at line 115 of file LUPI.hpp.

{ return( smr_isWarning( &m_smr ) ); }

smr()

statusMessageReporting * LUPI::StatusMessageReporting::smr ( )

inline

Definition at line 112 of file LUPI.hpp.

{ return( &m_smr ); }

Referenced by GIDI::Functions::XYs1d::domainSlice(), GIDI::Transporting::MG::form(), GIDI::Functions::XYs1d::integrate(), GIDI::Functions::XYs1d::mapToXsAndAdd(), GIDI::Functions::XYs1d::normalize(), GIDI::Functions::XYs1d::operator*=(), GIDI::Functions::XYs1d::operator*=(), GIDI::Functions::XYs1d::operator+=(), GIDI::Functions::XYs1d::operator-=(), GIDI::Functions::XYs1d::operator=(), and GIDI::Functions::XYs1d::toXs_pdf_cdf1d().

---

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

• LUPI.hpp
• LUPI_statusMessageReporting.cc