Representation of an LSST Event. More...

#include <LogEvent.h>

Inheritance diagram for lsst::ctrl::events::LogEvent:

Public Member Functions
	LogEvent ()
	Creates LogEvent which contains a PropertySet. More...

	LogEvent (log4cxx::spi::LoggingEventPtr const &event, log4cxx::helpers::Pool &p)

	LogEvent (cms::TextMessage *msg)
	Constructor to take a JMS TextMessage and turn it into a LogEvent. More...

virtual	~LogEvent ()
	destructor More...

virtual void	populateHeader (cms::TextMessage *msg) const

int	getLevel ()
	retreive the log level More...

std::string	getLoggingTopic ()
	Retreive the log message. More...

std::string	getLogger ()
	Retreive the log message. More...

Public Member Functions inherited from lsst::ctrl::events::Event
	Event ()
	Constructor for Event with no properties. More...

	Event (PropertySet const &properties)
	Constructor for Event. More...

	Event (PropertySet const &properties, PropertySet const &filterable)
	Constructor for Event. More...

	Event (std::string const &runid, PropertySet::Ptr const properties)
	Constructor for Event. More...

	Event (std::string const &runid, PropertySet const &properties)
	Constructor for Event. More...

	Event (std::string const &runid, PropertySet const &properties, PropertySet const &filterable)
	Constructor for Event. More...

	Event (cms::TextMessage *msg)
	Constructor for Event. More...

virtual	~Event ()
	destructor More...

PropertySet::Ptr	getPropertySet () const
	retrieve the PropertySet for this Event More...

std::string	getPubDate ()
	get the publication date of this Event, in ASCII More...

long long	getPubTime ()
	get the publication time of this Event More...

void	setPubTime (long long t)
	set the publication time of this Event More...

long long	getEventTime ()
	get the event creation time More...

void	setEventTime (long long nsecs)
	set the event creation time More...

void	updateEventTime ()
	update the Event time to the current time More...

std::string	getEventDate ()
	get the Event Date More...

std::string	getRunId ()
	get the RunId for this Event More...

std::string	getType ()
	get the Event type More...

std::string	getStatus ()
	get the Event status More...

void	setStatus (std::string status)
	set the Event status More...

void	setTopic (std::string topic)
	set the Event topic More...

std::string	getTopic ()
	get the Event topic More...

vector< std::string >	getFilterablePropertyNames ()
	return all filterable property names More...

vector< std::string >	getCustomPropertyNames ()
	return all custom property names More...

PropertySet::Ptr	getCustomPropertySet () const
	return all custom property set More...

void	marshall (cms::TextMessage *msg)
	marshall values in this event into a cms::TextMessage More...

Static Public Attributes
static const std::string	LEVEL = "LEVEL"

static const std::string	LOGGER = "LOGGER"

static const std::string	MESSAGE = "MESSAGE"

static const std::string	TIMESTAMP = "TIMESTAMP"

static const std::string	THREADNAME = "THREADNAME"

static const std::string	FILENAME = "FILENAME"

static const std::string	CLASSNAME = "CLASSNAME"

static const std::string	METHODNAME = "METHODNAME"

static const std::string	LINENUMBER = "LINENUMBER"

static const std::string	LOCATION = "LOCATION"

static const std::string	LOGGING_TOPIC = "Logging"

Static Public Attributes inherited from lsst::ctrl::events::Event
static const std::string	TYPE = "TYPE"

static const std::string	EVENTTIME = "EVENTTIME"

static const std::string	RUNID = "RUNID"

static const std::string	STATUS = "STATUS"

static const std::string	TOPIC = "TOPIC"

static const std::string	PUBTIME = "PUBTIME"

static const std::string	UNINITIALIZED = "uninitialized"

Private Member Functions
void	_init ()

Static Private Attributes
static const std::string	DELIMITER

Additional Inherited Members
Protected Member Functions inherited from lsst::ctrl::events::Event
void	_init ()

void	_constructor (std::string const &runid, PropertySet const &properties, PropertySet const &filterable)

template<typename T >
void	add (std::string const &name, std::string const &tag, PropertySet const &properties, boost::property_tree::ptree &child)

Protected Attributes inherited from lsst::ctrl::events::Event
PropertySet::Ptr	_psp

PropertySet::Ptr	_filterable

set< std::string >	_keywords

Detailed Description

Representation of an LSST Event.

Definition at line 64 of file LogEvent.h.

Constructor & Destructor Documentation

lsst::ctrl::events::LogEvent::LogEvent ( )

Creates LogEvent which contains a PropertySet.

Definition at line 79 of file LogEvent.cc.

                    : Event() {
     _init();
 }

lsst::ctrl::events::LogEvent::LogEvent	(	log4cxx::spi::LoggingEventPtr const &	event,
		log4cxx::helpers::Pool &	p
	)

Definition at line 83 of file LogEvent.cc.

                                                                                 : Event() {
     _init();
 
     _psp->set(TYPE, EventTypes::LOG);
     _psp->set(LogEvent::LOGGER, event->getLoggerName());
     _psp->set(LogEvent::LEVEL, event->getLevel()->toInt());
 
     _psp->set(LogEvent::MESSAGE, event->getMessage());
     _psp->set(LogEvent::TIMESTAMP, event->getTimeStamp());
     _psp->set(LogEvent::THREADNAME, event->getThreadName());
 
     spi::LocationInfo location = event->getLocationInformation();
 
     PropertySet::Ptr loc(new PropertySet);
     loc->set(LogEvent::FILENAME, location.getFileName());
     loc->set(LogEvent::CLASSNAME, location.getClassName());
     loc->set(LogEvent::METHODNAME, location.getMethodName());
     loc->set(LogEvent::LINENUMBER, location.getLineNumber());
 
     _psp->set(LogEvent::LOCATION, loc);
 }

lsst::ctrl::events::LogEvent::LogEvent ( cms::TextMessage * msg )

Constructor to take a JMS TextMessage and turn it into a LogEvent.

Parameters

msg	a TextMessage

Definition at line 118 of file LogEvent.cc.

                                       : Event(msg) {
     _init();
 
     _psp->set(LogEvent::LEVEL, msg->getIntProperty(LogEvent::LEVEL));
     _psp->set(LogEvent::LOGGER, msg->getStringProperty(LogEvent::LOGGER));
 
 }

lsst::ctrl::events::LogEvent::~LogEvent ( )

virtual

destructor

Definition at line 164 of file LogEvent.cc.

164 {

165 }

Member Function Documentation

void lsst::ctrl::events::LogEvent::_init ( )

private

private method to add keywords used in LogEvent JMS headers

Definition at line 108 of file LogEvent.cc.

                      {
     _keywords.insert(LogEvent::LEVEL);
     _keywords.insert(LogEvent::LOGGER);
 }

int lsst::ctrl::events::LogEvent::getLevel ( )

retreive the log level

Returns: the logging level at which the LogRecord message was set

Definition at line 141 of file LogEvent.cc.

                        {
     return _psp->get<int>(LogEvent::LEVEL);
 }

std::string lsst::ctrl::events::LogEvent::getLogger ( )

Retreive the log message.

Returns: a string containing the log message itself

Definition at line 149 of file LogEvent.cc.

                               {
     return _psp->get<std::string>(LogEvent::LOGGER);
 }

std::string lsst::ctrl::events::LogEvent::getLoggingTopic ( )

Retreive the log message.

Returns: a string containing the log message itself

Definition at line 157 of file LogEvent.cc.

                                     {
     return LogEvent::LOGGING_TOPIC;
 }

void lsst::ctrl::events::LogEvent::populateHeader ( cms::TextMessage * msg ) const

virtual

private method used to populate the LogEvent

Reimplemented from lsst::ctrl::events::Event.

Definition at line 129 of file LogEvent.cc.

                                                        {
     Event::populateHeader(msg);
 
     msg->setIntProperty(LogEvent::LEVEL, _psp->get<int>(LogEvent::LEVEL));
     msg->setStringProperty(LogEvent::LOGGER, _psp->get<std::string>(LogEvent::LOGGER));
 
 }

Member Data Documentation

const std::string lsst::ctrl::events::LogEvent::CLASSNAME = "CLASSNAME"

static

Definition at line 74 of file LogEvent.h.

const std::string lsst::ctrl::events::LogEvent::DELIMITER

staticprivate

Definition at line 95 of file LogEvent.h.

const std::string lsst::ctrl::events::LogEvent::FILENAME = "FILENAME"

static

Definition at line 73 of file LogEvent.h.

const std::string lsst::ctrl::events::LogEvent::LEVEL = "LEVEL"

static

Definition at line 67 of file LogEvent.h.

const std::string lsst::ctrl::events::LogEvent::LINENUMBER = "LINENUMBER"

static

Definition at line 76 of file LogEvent.h.

const std::string lsst::ctrl::events::LogEvent::LOCATION = "LOCATION"

static

Definition at line 77 of file LogEvent.h.

const std::string lsst::ctrl::events::LogEvent::LOGGER = "LOGGER"

static

Definition at line 68 of file LogEvent.h.

const std::string lsst::ctrl::events::LogEvent::LOGGING_TOPIC = "Logging"

static

Definition at line 79 of file LogEvent.h.

const std::string lsst::ctrl::events::LogEvent::MESSAGE = "MESSAGE"

static

Definition at line 70 of file LogEvent.h.

const std::string lsst::ctrl::events::LogEvent::METHODNAME = "METHODNAME"

static

Definition at line 75 of file LogEvent.h.

const std::string lsst::ctrl::events::LogEvent::THREADNAME = "THREADNAME"

static

Definition at line 72 of file LogEvent.h.

const std::string lsst::ctrl::events::LogEvent::TIMESTAMP = "TIMESTAMP"

static

Definition at line 71 of file LogEvent.h.

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

/home/lsstsw/stack/Linux64/ctrl_events/11.0-2-g68503cd/include/lsst/ctrl/events/LogEvent.h
/home/lsstsw/stack/Linux64/ctrl_events/11.0-2-g68503cd/src/LogEvent.cc

Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation