casa::PlotLogMessage Class Reference

Superclass for all messages going through the PlotLogger. More...

#include <PlotLogger.h>

Inheritance diagram for casa::PlotLogMessage:

Public Member Functions
	PlotLogMessage (int eventType=DEFAULT_EVENT_TYPE)
	Non-Static //. More...
	PlotLogMessage (const casacore::String &origin1, const casacore::String &origin2, int eventType=DEFAULT_EVENT_TYPE)
	Constructor which takes the origin(s) and an optional priority. More...
	PlotLogMessage (const casacore::String &origin1, const casacore::String &origin2, const casacore::String &message, int eventType=DEFAULT_EVENT_TYPE)
	Constructor which takes the origin(s), the message, and an optional priority. More...
	PlotLogMessage (const PlotLogMessage &copy)
	Copy constructor. More...
virtual	~PlotLogMessage ()
	Destructor. More...
virtual int	eventType () const
	Returns the event type of this message. More...
Public Member Functions inherited from casacore::LogMessage
	LogMessage (Priority priority=NORMAL)
	Create a message with the given priority and the current time, and an empty origin and message. More...
	LogMessage (const LogOrigin &sourceLocation, Priority priority=NORMAL)
	Create a message with the given location and priority, the current time and an empty message. More...
	LogMessage (const String &message, const LogOrigin &sourceLocation, Priority=NORMAL)
	Create a completely filled out LogMessage. More...
	LogMessage (const LogMessage &other)
	Make this LogMessage a copy of other. More...
LogMessage &	operator= (const LogMessage &other)
	~LogMessage ()
const String &	message () const
	Get the message text. More...
LogMessage &	message (const String &message, Bool keepLastTime=False)
	Set the message text. More...
uInt	line () const
	Get and set the line number in the LogOrigin. More...
LogMessage &	line (uInt which)
LogMessage &	sourceLocation (const SourceLocation *where)
	Set the source location - usually this will be called with the macro WHERE. More...
const LogOrigin &	origin () const
	Get and set the origin of this LogMessage. More...
LogMessage &	origin (const LogOrigin &origin)
Priority	priority () const
	Get or change the priority of this LogMessage. More...
LogMessage &	priority (Priority which)
const Time &	messageTime () const
	Returns the time at which the message text was created. More...
LogMessage &	messageTime (const Time &theTime)
	Normally you should not manually set the time, however there may be rare circumstances where it is useful - for example if you have a single static message that you want to send out at various times. More...
String	toString () const
	Turn this entire LogMessage into a String. More...
String	toTermString () const

Static Public Attributes
static const int	DEFAULT_EVENT_TYPE
	Static //. More...

Protected Attributes
int	m_eventType
	Event type, either a value from PlotLogger::Event, or a custom user-defined value. More...

Additional Inherited Members
Public Types inherited from casacore::LogMessage
enum	Priority {   DEBUGGING,   DEBUG2,   DEBUG1,   NORMAL5,   NORMAL4,   NORMAL3,   NORMAL2,   NORMAL1,   NORMAL,   WARN,   SEVERE }
	An "importance" which is assigned to each LogMessage. More...
Static Public Member Functions inherited from casacore::LogMessage
static const String &	toString (Priority which)
	Map the given priority into a String - so, for example, it can be stored in a table. More...

Detailed Description

Superclass for all messages going through the PlotLogger.

This class has been refactored to just be a thin layer on top of LogMessage.

Definition at line 48 of file PlotLogger.h.

Constructor & Destructor Documentation

casa::PlotLogMessage::PlotLogMessage

(

int

eventType = DEFAULT_EVENT_TYPE

)

Non-Static //.

Constructor which takes an optional priority.

casa::PlotLogMessage::PlotLogMessage	(	const casacore::String &	origin1,
		const casacore::String &	origin2,
		int	eventType = DEFAULT_EVENT_TYPE
	)

Constructor which takes the origin(s) and an optional priority.

casa::PlotLogMessage::PlotLogMessage	(	const casacore::String &	origin1,
		const casacore::String &	origin2,
		const casacore::String &	message,
		int	eventType = DEFAULT_EVENT_TYPE
	)

Constructor which takes the origin(s), the message, and an optional priority.

casa::PlotLogMessage::PlotLogMessage

(

const PlotLogMessage &

copy

)

Copy constructor.

virtual casa::PlotLogMessage::~PlotLogMessage ( )

virtual

Destructor.

Member Function Documentation

virtual int casa::PlotLogMessage::eventType ( ) const

virtual

Returns the event type of this message.

Member Data Documentation

const int casa::PlotLogMessage::DEFAULT_EVENT_TYPE

static

Static //.

Default event type.

Definition at line 53 of file PlotLogger.h.

int casa::PlotLogMessage::m_eventType

protected

Event type, either a value from PlotLogger::Event, or a custom user-defined value.

Definition at line 83 of file PlotLogger.h.

---

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

• casa/code/graphics/GenericPlotter/PlotLogger.h