ArchiveSupplier Class Reference

#include <archiveeventsArchiveSupplier.h>

Inheritance diagram for ArchiveSupplier:

Collaboration diagram for ArchiveSupplier:

List of all members.

Public Member Functions
	ArchiveSupplier ()
virtual	~ArchiveSupplier ()
template<class T >
void	sendEvent (CORBA::Short priority, ACS::Time timeStamp, const std::string &component, const std::string &property, T value, const std::string &container="")
void	send_event (CORBA::Short priority, ACS::Time timeStamp, const std::string &component, const std::string &property, CORBA::Any value, const std::string &container)
Protected Member Functions
virtual const char *	getNotificationFactoryName ()
virtual const char *	getChannelDomain ()
virtual const char *	getChannelKind ()
virtual const char *	getEventType ()

---

Detailed Description

Class designed to send structured events out which will eventually be stored in the ALMA archive. It's important to note a couple of issues about this class: 1. It should not be used directly. Use ArchiveSupplierSingleton instead. 2. Until the init method is invoked, all methods should be considered unusable.

---

Constructor & Destructor Documentation

ArchiveSupplier::ArchiveSupplier

(

)

Standard constructor.

virtual ArchiveSupplier::~ArchiveSupplier

(

)

[virtual]

Destructor

---

Member Function Documentation

virtual const char* ArchiveSupplier::getChannelDomain

(

)

[inline, protected, virtual]

Overridden.

Reimplemented from BaseHelper.

virtual const char* ArchiveSupplier::getChannelKind

(

)

[inline, protected, virtual]

Overridden.

Implements BaseHelper.

virtual const char* ArchiveSupplier::getEventType

(

)

[inline, protected, virtual]

Overridden.

Implements BaseSupplier.

virtual const char* ArchiveSupplier::getNotificationFactoryName

(

)

[inline, protected, virtual]

Overridden.

Reimplemented from BaseHelper.

void ArchiveSupplier::send_event	(	CORBA::Short	priority,
		ACS::Time	timeStamp,
		const std::string &	component,
		const std::string &	property,
		CORBA::Any	value,
		const std::string &	container
	)

Sends data to the archive.

Parameters:

	priority	Priority of the event. A higher number is equivalent to a greater priority.
	timeStamp	Timestamp in ACS format
	component	Name of the component sending this value
	property	Name of the property sending this value
	value	Value in CORBA any format
	container	Name of the container. There's a solid chance this param will be removed entirely in the future.

Exceptions:

acsncErrType::PublishEventFailureExImpl

Cannot publish the event in the Notification Channel

Referenced by sendEvent().

template<class T >

void ArchiveSupplier::sendEvent	(	CORBA::Short	priority,
		ACS::Time	timeStamp,
		const std::string &	component,
		const std::string &	property,
		T	value,
		const std::string &	container = ""
	)			[inline]

Sends data to the archive.

Parameters:

	priority	Priority of the event. A higher number is equivalent to a greater priority.
	timeStamp	Timestamp
	component	Name of the component sending this value
	property	Name of the property sending this value
	value	Value which must be some CORBA type.
	container	Name of the container. Optional and there's a solid chance this param will be removed entirely in the future.

Exceptions:

acsncErrType::PublishEventFailureExImpl

Cannot publish the event in the Notification Channel

References BaseHelper::channelName_mp, and send_event().

---

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

• archiveeventsArchiveSupplier.h