Representation of an LSST CommandEvent. More...

#include <CommandEvent.h>

Inheritance diagram for lsst::ctrl::events::CommandEvent:

Public Member Functions
	CommandEvent ()
	Creates CommandEvent which contains a PropertySet consisting of an origination location ID and a destination location ID, plus additional properties. More...

	CommandEvent (LocationId const &originator, LocationId const &destination, boost::shared_ptr< PropertySet const > const &psp)
	Constructor for CommandEvent. More...

	CommandEvent (LocationId const &originator, LocationId const &destination, PropertySet const &ps)
	Constructor for CommandEvent. More...

	CommandEvent (LocationId const &originator, LocationId const &destination, PropertySet const &ps, PropertySet const &filterable)
	Constructor for CommandEvent. More...

	CommandEvent (std::string const &runid, LocationId const &originator, LocationId const &destination, boost::shared_ptr< PropertySet const > const &psp)
	Constructor for CommandEvent. More...

	CommandEvent (std::string const &runid, LocationId const &originator, LocationId const &destination, PropertySet const &ps)
	Constructor for CommandEvent. More...

	CommandEvent (std::string const &runid, LocationId const &originator, LocationId const &destination, PropertySet const &ps, PropertySet const &filterable)
	Constructor for CommandEvent. More...

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

virtual	~CommandEvent ()
	destructor More...

LocationId::Ptr	getOriginator () const
	retrieve an object containing the OriginatoDesination LocationId More...

LocationId::Ptr	getDestination () const
	retrieve an object containing the OriginatoDesination LocationId 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	ORIG_HOSTNAME = "ORIG_HOSTNAME"

static const std::string	ORIG_PROCESSID = "ORIG_PROCESSID"

static const std::string	ORIG_LOCALID = "ORIG_LOCALID"

static const std::string	DEST_HOSTNAME = "DEST_HOSTNAME"

static const std::string	DEST_PROCESSID = "DEST_PROCESSID"

static const std::string	DEST_LOCALID = "DEST_LOCALID"

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	_constructor (LocationId const &originator, LocationId const &destination)

virtual void	populateHeader (cms::TextMessage *msg) const
	populate a cms::TextMessage header with properties More...

void	_init ()

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 CommandEvent.

Definition at line 63 of file CommandEvent.h.

Constructor & Destructor Documentation

lsst::ctrl::events::CommandEvent::CommandEvent ( )

Creates CommandEvent which contains a PropertySet consisting of an origination location ID and a destination location ID, plus additional properties.

Definition at line 69 of file CommandEvent.cc.

                            : Event() {
     _init();
 }

lsst::ctrl::events::CommandEvent::CommandEvent	(	LocationId const &	originator,
		LocationId const &	destination,
		boost::shared_ptr< PropertySet const > const &	psp
	)

Constructor for CommandEvent.

Parameters

originator	originating location of this event
destination	destination location for this event
psp	PropertySet to pass in this event

Definition at line 100 of file CommandEvent.cc.

                                                                                                                           : Event(*psp) {
     _constructor(originator, destination);
 }

lsst::ctrl::events::CommandEvent::CommandEvent	(	LocationId const &	originator,
		LocationId const &	destination,
		PropertySet const &	ps
	)

Constructor for CommandEvent.

Parameters

originator	originating location of this event
destination	destination location for this event
ps	PropertySet to pass in this event

Definition at line 104 of file CommandEvent.cc.

                                                                                                               : Event(ps) {
     _constructor(originator, destination);
 }

lsst::ctrl::events::CommandEvent::CommandEvent	(	LocationId const &	originator,
		LocationId const &	destination,
		PropertySet const &	ps,
		PropertySet const &	filterable
	)

Constructor for CommandEvent.

Parameters

originator	originating location of this event
destination	destination location for this event
ps	PropertySet to pass in this event
filterable	additional, broker-filterable, PropertySet parameters

Definition at line 108 of file CommandEvent.cc.

                                                                                                                                               : Event(ps, filterable) {
     _constructor(originator, destination);
 }

lsst::ctrl::events::CommandEvent::CommandEvent	(	std::string const &	runid,
		LocationId const &	originator,
		LocationId const &	destination,
		boost::shared_ptr< PropertySet const > const &	psp
	)

Constructor for CommandEvent.

Parameters

runid	name of the run which this event is used in
originator	originating location of this event
destination	destination location for this event
psp	PropertySet to pass in this event

Definition at line 112 of file CommandEvent.cc.

                                                                                                                                                   : Event(runId, *psp) {
     _constructor(originator, destination);
 }

lsst::ctrl::events::CommandEvent::CommandEvent	(	std::string const &	runid,
		LocationId const &	originator,
		LocationId const &	destination,
		PropertySet const &	ps
	)

Constructor for CommandEvent.

Parameters

runid	name of the run which this event is used in
originator	originating location of this event
destination	destination location for this event
ps	PropertySet to pass in this event

Definition at line 116 of file CommandEvent.cc.

                                                                                                                                         : Event(runId, ps) {
     _constructor(originator, destination);
 }

lsst::ctrl::events::CommandEvent::CommandEvent	(	std::string const &	runid,
		LocationId const &	originator,
		LocationId const &	destination,
		PropertySet const &	ps,
		PropertySet const &	filterable
	)

Constructor for CommandEvent.

Parameters

runid	name of the run which this event is used in
originator	originating location of this event
destination	destination location for this event
ps	PropertySet to pass in this event
filterable	additional, broker-filterable, PropertySet parameters

Definition at line 120 of file CommandEvent.cc.

                                                                                                                                                                       : Event(runId, ps, filterable) {
     _constructor(originator, destination);
 }

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

Constructor for CommandEvent.

Parameters

msg	a cms::TextMessage to convert into a CommandEvent

Definition at line 86 of file CommandEvent.cc.

                                               : Event(msg) {
     _init();
 
 
     _psp->set(ORIG_HOSTNAME, (std::string)msg->getStringProperty(ORIG_HOSTNAME));
     _psp->set(ORIG_PROCESSID, (int)msg->getIntProperty(ORIG_PROCESSID));
     _psp->set(ORIG_LOCALID, (int)msg->getIntProperty(ORIG_LOCALID));
 
     _psp->set(DEST_HOSTNAME, (std::string)msg->getStringProperty(DEST_HOSTNAME));
     _psp->set(DEST_PROCESSID, (int)msg->getIntProperty(DEST_PROCESSID));
     _psp->set(DEST_LOCALID, (int)msg->getIntProperty(DEST_LOCALID));
 
 }

lsst::ctrl::events::CommandEvent::~CommandEvent ( )

virtual

destructor

Definition at line 169 of file CommandEvent.cc.

169 {

170 }

Member Function Documentation

void lsst::ctrl::events::CommandEvent::_constructor	(	LocationId const &	originator,
		LocationId const &	destination
	)

private

private method common to all constructors containing, originator, the originating location of this event, and destination, the destination location for this event.

Definition at line 128 of file CommandEvent.cc.

                                                                                              {
     _init();
 
     _psp->set(ORIG_HOSTNAME, originator.getHostName());
     _psp->set(ORIG_PROCESSID, originator.getProcessID());
     _psp->set(ORIG_LOCALID, originator.getLocalID());
 
     _psp->set(DEST_HOSTNAME, destination.getHostName());
     _psp->set(DEST_PROCESSID, destination.getProcessID());
     _psp->set(DEST_LOCALID, destination.getLocalID());
 
     _psp->set(TYPE, EventTypes::COMMAND);
 
 }

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

private

private method to initialize the CommandEvent

Definition at line 76 of file CommandEvent.cc.

                          {
     _keywords.insert(ORIG_HOSTNAME);
     _keywords.insert(ORIG_PROCESSID);
     _keywords.insert(ORIG_LOCALID);
 
     _keywords.insert(DEST_HOSTNAME);
     _keywords.insert(DEST_PROCESSID);
     _keywords.insert(DEST_LOCALID);
 }

LocationId::Ptr lsst::ctrl::events::CommandEvent::getDestination ( ) const

retrieve an object containing the OriginatoDesination LocationId

Definition at line 162 of file CommandEvent.cc.

                                                  { 
     std::string hostname = _psp->get<std::string>(DEST_HOSTNAME); 
     int pid = _psp->get<int>(DEST_PROCESSID); 
     int local = _psp->get<int>(DEST_LOCALID);
     return LocationId::Ptr(new LocationId(hostname, pid, local));
 }

LocationId::Ptr lsst::ctrl::events::CommandEvent::getOriginator ( ) const

retrieve an object containing the OriginatoDesination LocationId

Definition at line 155 of file CommandEvent.cc.

                                                 { 
     std::string hostname =  _psp->get<std::string>(ORIG_HOSTNAME);
     int pid =  _psp->get<int>(ORIG_PROCESSID);
     int local =  _psp->get<int>(ORIG_LOCALID);
     return LocationId::Ptr(new LocationId(hostname, pid, local));
 }

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

privatevirtual

populate a cms::TextMessage header with properties

Parameters

[in] msg a cms::TextMessage

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

Definition at line 143 of file CommandEvent.cc.

                                                            {
     Event::populateHeader(msg);
 
     msg->setStringProperty(ORIG_HOSTNAME, _psp->get<std::string>(ORIG_HOSTNAME));
     msg->setIntProperty(ORIG_PROCESSID, _psp->get<int>(ORIG_PROCESSID));
     msg->setIntProperty(ORIG_LOCALID, _psp->get<int>(ORIG_LOCALID));
 
     msg->setStringProperty(DEST_HOSTNAME, _psp->get<std::string>(DEST_HOSTNAME));
     msg->setIntProperty(DEST_PROCESSID, _psp->get<int>(DEST_PROCESSID));
     msg->setIntProperty(DEST_LOCALID, _psp->get<int>(DEST_LOCALID));
 }

Member Data Documentation

const std::string lsst::ctrl::events::CommandEvent::DEST_HOSTNAME = "DEST_HOSTNAME"

static

Definition at line 70 of file CommandEvent.h.

const std::string lsst::ctrl::events::CommandEvent::DEST_LOCALID = "DEST_LOCALID"

static

Definition at line 72 of file CommandEvent.h.

const std::string lsst::ctrl::events::CommandEvent::DEST_PROCESSID = "DEST_PROCESSID"

static

Definition at line 71 of file CommandEvent.h.

const std::string lsst::ctrl::events::CommandEvent::ORIG_HOSTNAME = "ORIG_HOSTNAME"

static

Definition at line 66 of file CommandEvent.h.

const std::string lsst::ctrl::events::CommandEvent::ORIG_LOCALID = "ORIG_LOCALID"

static

Definition at line 68 of file CommandEvent.h.

const std::string lsst::ctrl::events::CommandEvent::ORIG_PROCESSID = "ORIG_PROCESSID"

static

Definition at line 67 of file CommandEvent.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/CommandEvent.h
/home/lsstsw/stack/Linux64/ctrl_events/11.0-2-g68503cd/src/CommandEvent.cc

Public Member Functions

Static Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation