Mantid::API::LiveListener Class Reference

Base implementation for common behaviour of all live listener classes. More...

#include <LiveListener.h>

Inheritance diagram for Mantid::API::LiveListener:

Public Member Functions
bool	dataReset () override
	Indicates that a reset (or period change?) signal has been received from the DAS.
void	setAlgorithm (const class IAlgorithm &callingAlgorithm) override
	Default behaviour updates property values on Listener using those on calling algorithm.
void	setSpectra (const std::vector< specnum_t > &specList) override
	Default behaviour reads all spectrum numbers.
Public Member Functions inherited from Mantid::API::ILiveListener
virtual bool	buffersEvents () const =0
	Does this listener buffer events (true) or histogram data (false)
virtual bool	connect (const Poco::Net::SocketAddress &address)=0
	Connect to the specified address and start listening/buffering.
virtual std::shared_ptr< Workspace >	extractData ()=0
	Get the data that's been buffered since the last call to this method (or since start() was called).
virtual bool	isConnected ()=0
	Has the connection to the DAS been established? Could also be used to check for a continued connection.
virtual std::string	name () const =0
	The name of this listener.
virtual int	runNumber () const =0
	Returns the run number of the current run.
virtual ILiveListener::RunStatus	runStatus ()=0
	Gets the current run status of the listened-to data stream.
virtual void	start (Types::Core::DateAndTime startTime=Types::Core::DateAndTime())=0
	Commence the collection of data from the DAS.
virtual bool	supportsHistory () const =0
	Does this listener support requests for (recent) past data.
Public Member Functions inherited from Mantid::Kernel::PropertyManager
::Json::Value	asJson (bool withDefaultValues=false) const override
	Return the property manager serialized as a json object.
std::string	asString (bool withDefaultValues=false) const override
	Return the property manager serialized as a string.
void	clear () override final
	Clears the whole property map.
PropertyManager *	cloneInTimeROI (const Kernel::TimeROI &timeROI)
	Create a partial copy of this object such that every time series property is cloned according to the input TimeROI.
void	declareOrReplaceProperty (std::unique_ptr< Property > p, const std::string &doc="") override
	Add or replace a property in the list of managed properties.
void	declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).
void	declareProperty (const std::string &name, const char *value, const unsigned int direction)
	Add a property of string type to the list of managed properties.
void	declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).
template<typename T >
void	declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input)
	Add a property to the list of managed properties with no validator.
template<typename T >
void	declareProperty (const std::string &name, T value, const unsigned int direction)
	Add a property of the template type to the list of managed properties.
template<typename T >
void	declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input)
	Add a property of the template type to the list of managed properties.
void	declareProperty (std::unique_ptr< Property > p, const std::string &doc="") override
	Add a property to the list of managed properties.
virtual void	declareProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
	Function to declare properties (i.e. store them)
bool	existsProperty (const std::string &name) const override
	Checks whether the named property is already in the list of managed property.
void	filterByProperty (Mantid::Kernel::LogFilter *logFilter, const std::vector< std::string > &excludedFromFiltering=std::vector< std::string >()) override
	Filter the managed properties by the given boolean property mask.
std::vector< std::string >	getDeclaredPropertyNames () const noexcept override
	Return the list of declared property names.
Property *	getPointerToProperty (const std::string &name) const override
	Get a property by name.
const std::vector< Property * > &	getProperties () const override
	Get the list of managed properties.
TypedValue	getProperty (const std::string &name) const override
	Get the value of a property.
std::string	getPropertyValue (const std::string &name) const override
	Get the value of a property as a string.
bool	operator!= (const PropertyManager &other) const
PropertyManager &	operator+= (const PropertyManager &rhs)
	Addition operator.
PropertyManager &	operator= (const PropertyManager &)
	Assignment operator - performs a deep copy.
bool	operator== (const PropertyManager &other) const
size_t	propertyCount () const override
	Count the number of properties under management.
	PropertyManager ()
	Default constructor.
	PropertyManager (const PropertyManager &)
	copy constructor
void	removeDataOutsideTimeROI (const Kernel::TimeROI &timeROI)
	For time series properties, remove time values outside of TimeROI regions, each defined as [roi_begin,roi_end].
void	removeProperty (const std::string &name, const bool delproperty=true) override
	removes the property from properties map
void	resetProperties () override
	Reset property values back to initial values (blank or default values)
void	setProperties (const ::Json::Value &jsonValue, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false) override
	Set the ordered list of properties by a json value collection.
void	setProperties (const ::Json::Value &jsonValue, IPropertyManager *targetPropertyManager, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)
	Set the ordered list of properties by a json value collection.
void	setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false) override
	Set the ordered list of properties by one string of values, separated by semicolons.
void	setProperties (const std::string &propertiesJson, IPropertyManager *targetPropertyManager, const std::unordered_set< std::string > &ignoreProperties, bool createMissing=false)
	Set the ordered list of properties by one string of values, separated by semicolons.
void	setPropertiesWithString (const std::string &propertiesString, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >()) override
	Sets all the declared properties from a string.
void	setPropertyOrdinal (const int &index, const std::string &value) override
	Set the value of a property by an index N.B.
void	setPropertyValue (const std::string &name, const std::string &value) override
	Set the value of a property by string N.B.
void	setPropertyValueFromJson (const std::string &name, const Json::Value &value) override
	Set the value of a property by Json::Value.
std::unique_ptr< Property >	takeProperty (const size_t index) override
	removes the property from the properties map and returns a pointer to it
bool	validateProperties () const override
	Validates all the properties in the collection.
virtual	~PropertyManager () override
	Virtual destructor.
Public Member Functions inherited from Mantid::Kernel::IPropertyManager
void	declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).
void	declareProperty (const std::string &name, const char *value, const unsigned int direction)
	Add a property of string type to the list of managed properties.
void	declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).
template<typename T >
void	declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input)
	Add a property to the list of managed properties with no validator.
template<typename T >
void	declareProperty (const std::string &name, T value, const unsigned int direction)
	Add a property of the template type to the list of managed properties.
template<typename T >
void	declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input)
	Add a property of the template type to the list of managed properties.
std::vector< Property * >	getPropertiesInGroup (const std::string &group) const
	Get the list of managed properties in a given group.
IPropertyManager *	setProperty (const std::string &name, const char *value)
	Specialised version of setProperty template method to handle const char *.
IPropertyManager *	setProperty (const std::string &name, const std::string &value)
	Specialised version of setProperty template method to handle std::string.
template<typename T >
IPropertyManager *	setProperty (const std::string &name, const T &value)
	Templated method to set the value of a PropertyWithValue.
template<typename T >
IPropertyManager *	setProperty (const std::string &name, std::unique_ptr< T > value)
	Templated method to set the value of a PropertyWithValue from a std::unique_ptr.
void	setPropertyGroup (const std::string &name, const std::string &group)
	Set the group for a given property.
void	setPropertySettings (const std::string &name, std::unique_ptr< IPropertySettings > settings)
void	updatePropertyValues (const IPropertyManager &other)
	Update values of the existing properties.
virtual	~IPropertyManager ()=default

Protected Attributes
bool	m_dataReset = false
	Indicates receipt of a reset signal from the DAS.

Additional Inherited Members
Public Types inherited from Mantid::API::ILiveListener
enum	RunStatus { NoRun = 0 , BeginRun = 1 , Running = 2 , EndRun = 4 }
	The possible run statuses (initial list taken from SNS SMS protocol) None : No current run Begin : A new run has begun since the last call to extractData Running : We are in a run End : The run has ended since the last call to extractData. More...
Static Public Member Functions inherited from Mantid::Kernel::PropertyManager
static std::string	getInvalidValuesFilterLogName (const std::string &logName)
	Gets the correct log name for the matching invalid values log for a given log name.
static std::string	getLogNameFromInvalidValuesFilter (const std::string &logName)
static bool	isAnInvalidValuesFilterLog (const std::string &logName)
	Determine if the log's name has a substring indicating it should not be filtered.
Static Public Attributes inherited from Mantid::Kernel::PropertyManager
static const std::string	INVALID_VALUES_SUFFIX = "_invalid_values"
Protected Member Functions inherited from Mantid::Kernel::PropertyManager
Property *	getPointerToPropertyOrdinal (const int &index) const override
	Get a property by an index.
Property *	getPointerToPropertyOrNull (const std::string &name) const
	Get a property by name.
Protected Member Functions inherited from Mantid::Kernel::IPropertyManager
virtual void	afterPropertySet (const std::string &)
	Override this method to perform a custom action right after a property was set.
template<typename T >
T	getValue (const std::string &name) const
	Templated method to get the value of a property.
template<>
MANTID_KERNEL_DLL PropertyManager_sptr	getValue (const std::string &name) const
template<>
MANTID_KERNEL_DLL PropertyManager_const_sptr	getValue (const std::string &name) const

Detailed Description

Base implementation for common behaviour of all live listener classes.

It implements the ILiveListener interface.

Definition at line 17 of file LiveListener.h.

Member Function Documentation

dataReset()

bool Mantid::API::LiveListener::dataReset ( )

overridevirtual

Indicates that a reset (or period change?) signal has been received from the DAS.

An example is the SNS SMS (!) statistics reset packet. A concrete listener should discard any buffered events on receipt of such a signal. It is the client's responsibility to call this method, if necessary, prior to extracting the data. Calling this method resets the flag.

Implements Mantid::API::ILiveListener.

Definition at line 13 of file LiveListener.cpp.

References m_dataReset.

setAlgorithm()

void Mantid::API::LiveListener::setAlgorithm ( const class IAlgorithm &  callingAlgorithm )

overridevirtual

Default behaviour updates property values on Listener using those on calling algorithm.

Implements Mantid::API::ILiveListener.

Definition at line 30 of file LiveListener.cpp.

References Mantid::Kernel::IPropertyManager::updatePropertyValues().

setSpectra()

void Mantid::API::LiveListener::setSpectra ( const std::vector< specnum_t > &  specList )

overridevirtual

Default behaviour reads all spectrum numbers.

Parameters

specList

:: A vector with spectra numbers (ignored)

Implements Mantid::API::ILiveListener.

Definition at line 24 of file LiveListener.cpp.

References UNUSED_ARG.

Member Data Documentation

m_dataReset

bool Mantid::API::LiveListener::m_dataReset = false

protected

Indicates receipt of a reset signal from the DAS.

Definition at line 25 of file LiveListener.h.

Referenced by dataReset().

---

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

• Framework/API/inc/MantidAPI/LiveListener.h
• Framework/API/src/LiveListener.cpp