casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
casa::PlotLogMethod Class Reference

Subclass of PlotLogMessage to unify messages for method entering/exiting. More...

#include <PlotLogger.h>

Inheritance diagram for casa::PlotLogMethod:
casa::PlotLogMessage casacore::LogMessage

Public Member Functions

 PlotLogMethod (const casacore::String &className, const casacore::String &methodName, bool entering, const casacore::String &message=casacore::String(), int eventType=DEFAULT_EVENT_TYPE)
 Constructor which takes the class and method names, a flag for whether the method is entering or exiting, and an optional additional message and priority. More...
 
 ~PlotLogMethod ()
 Destructor. More...
 
- Public Member Functions inherited from casa::PlotLogMessage
 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...
 
LogMessageoperator= (const LogMessage &other)
 
 ~LogMessage ()
 
const Stringmessage () const
 Get the message text. More...
 
LogMessagemessage (const String &message, Bool keepLastTime=False)
 Set the message text. More...
 
uInt line () const
 Get and set the line number in the LogOrigin. More...
 
LogMessageline (uInt which)
 
LogMessagesourceLocation (const SourceLocation *where)
 Set the source location - usually this will be called with the macro WHERE. More...
 
const LogOriginorigin () const
 Get and set the origin of this LogMessage. More...
 
LogMessageorigin (const LogOrigin &origin)
 
Priority priority () const
 Get or change the priority of this LogMessage. More...
 
LogMessagepriority (Priority which)
 
const TimemessageTime () const
 Returns the time at which the message text was created. More...
 
LogMessagemessageTime (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
 

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 StringtoString (Priority which)
 Map the given priority into a String - so, for example, it can be stored in a table. More...
 
- Static Public Attributes inherited from casa::PlotLogMessage
static const int DEFAULT_EVENT_TYPE
 Static //. More...
 
- Protected Attributes inherited from casa::PlotLogMessage
int m_eventType
 Event type, either a value from PlotLogger::Event, or a custom user-defined value. More...
 

Detailed Description

Subclass of PlotLogMessage to unify messages for method entering/exiting.

Definition at line 252 of file PlotLogger.h.

Constructor & Destructor Documentation

casa::PlotLogMethod::PlotLogMethod ( const casacore::String className,
const casacore::String methodName,
bool  entering,
const casacore::String message = casacore::String(),
int  eventType = DEFAULT_EVENT_TYPE 
)

Constructor which takes the class and method names, a flag for whether the method is entering or exiting, and an optional additional message and priority.

casa::PlotLogMethod::~PlotLogMethod ( )

Destructor.


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