High-level interface for setting sample metadata on a workspace. More...

#include <SetSample.h>

Inheritance diagram for Mantid::DataHandling::SetSample:

Public Member Functions
const std::string	category () const override final
	Algorithm's category for identification. More...

const std::string	name () const override final
	Algorithms name for identification. More...

const std::vector< std::string >	seeAlso () const override
	Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm.A default implementation is provided. More...

const std::string	summary () const override final
	Algorithm's summary for use in the GUI and help. More...

int	version () const override final
	Algorithm's version for identification. More...

Public Member Functions inherited from Mantid::API::Algorithm
	Algorithm ()
	Constructor. More...

	Algorithm (const Algorithm &)=delete

Algorithm &	operator= (const Algorithm &)=delete

	~Algorithm () override
	Virtual destructor. More...

void	initialize () override
	Initialization method invoked by the framework. More...

bool	execute () override final
	The actions to be performed by the algorithm on a dataset. More...

void	addTimer (const std::string &name, const Kernel::time_point_ns &begin, const Kernel::time_point_ns &end)

void	executeAsChildAlg () override
	Execute as a Child Algorithm. More...

ExecutionState	executionState () const override
	Gets the current execution state. More...

ResultState	resultState () const override
	Gets the current result State. More...

bool	isInitialized () const override
	Has the Algorithm already been initialized. More...

bool	isExecuted () const override
	Has the Algorithm already been executed successfully. More...

bool	isRunning () const override
	True if the algorithm is running. More...

bool	isReadyForGarbageCollection () const override
	True if the algorithm is ready for garbage collection. More...

bool	isChild () const override
	To query whether algorithm is a child. More...

void	setChild (const bool isChild) override
	To set whether algorithm is a child. More...

void	enableHistoryRecordingForChild (const bool on) override
	Change the state of the history recording flag. More...

bool	isRecordingHistoryForChild ()

void	setAlwaysStoreInADS (const bool doStore) override
	Do we ALWAYS store in the AnalysisDataService? This is set to true for python algorithms' child algorithms. More...

bool	getAlwaysStoreInADS () const override
	Returns true if we always store in the AnalysisDataService. More...

void	setRethrows (const bool rethrow) override
	Set whether the algorithm will rethrow exceptions. More...

Poco::ActiveResult< bool >	executeAsync () override
	Asynchronous execution. More...

void	addObserver (const Poco::AbstractObserver &observer) const override
	Add an observer for a notification. More...

void	removeObserver (const Poco::AbstractObserver &observer) const override
	Remove an observer. More...

void	cancel () override
	Raises the cancel flag. More...

bool	getCancel () const
	Returns the cancellation state. More...

Kernel::Logger &	getLogger () const
	Returns a reference to the logger. More...

void	setLogging (const bool value) override
	Logging can be disabled by passing a value of false. More...

bool	isLogging () const override
	returns the status of logging, True = enabled More...

void	setLoggingOffset (const int value) override
	gets the logging priority offset More...

int	getLoggingOffset () const override
	returns the logging priority offset More...

void	setAlgStartupLogging (const bool enabled) override
	disable Logging of start and end messages More...

bool	getAlgStartupLogging () const override
	get the state of Logging of start and end messages More...

void	setChildStartProgress (const double startProgress) const override
	setting the child start progress More...

void	setChildEndProgress (const double endProgress) const override
	setting the child end progress More...

std::string	toString () const override
	Serialize an object to a string. More...

::Json::Value	toJson () const override
	Serialize an object to a json object. More...

virtual std::shared_ptr< Algorithm >	createChildAlgorithm (const std::string &name, const double startProgress=-1., const double endProgress=-1., const bool enableLogging=true, const int &version=-1)
	Create a Child Algorithm. More...

void	setupAsChildAlgorithm (const Algorithm_sptr &algorithm, const double startProgress=-1., const double endProgress=-1., const bool enableLogging=true)
	Setup algorithm as child algorithm. More...

void	trackAlgorithmHistory (std::shared_ptr< AlgorithmHistory > parentHist)
	set whether we wish to track the child algorithm's history and pass it the parent object to fill. More...

void	findWorkspaces (WorkspaceVector &workspaces, unsigned int direction, bool checkADS=false) const
	Populate lists of the workspace properties for a given direction (InOut workspaces are included in both input/output) More...

virtual bool	checkGroups ()
	Check the input workspace properties for groups. More...

virtual bool	processGroups ()
	Process WorkspaceGroup inputs. More...

void	copyNonWorkspaceProperties (IAlgorithm *alg, int periodNum)
	Copy all the non-workspace properties from this to alg. More...

const Parallel::Communicator &	communicator () const
	Returns a const reference to the (MPI) communicator of the algorithm. More...

void	setCommunicator (const Parallel::Communicator &communicator)
	Sets the (MPI) communicator of the algorithm. More...

void	declareProperty (std::unique_ptr< Kernel::Property > p, const std::string &doc="") override
	Add a property to the list of managed properties. More...

void	declareOrReplaceProperty (std::unique_ptr< Kernel::Property > p, const std::string &doc="") override
	Add or replace property in the list of managed properties. More...

void	resetProperties () override
	Reset property values back to initial values (blank or default values) More...

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

void	setProperties (const ::Json::Value &jsonValue, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false) override
	Sets all the declared properties from a json object. More...

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

void	setPropertyValue (const std::string &name, const std::string &value) override
	Set the value of a property by string N.B. More...

void	setPropertyValueFromJson (const std::string &name, const Json::Value &value) override
	Set the value of a property by Json::Value object. More...

void	setPropertyOrdinal (const int &index, const std::string &value) override
	Set the value of a property by an index N.B. More...

virtual void	copyPropertiesFrom (const Algorithm &alg)
	Make m_properties point to the same PropertyManager as alg.m_properties. More...

bool	existsProperty (const std::string &name) const override
	Checks whether the named property is already in the list of managed property. More...

bool	validateProperties () const override
	Validates all the properties in the collection. More...

size_t	propertyCount () const override
	Count the number of properties under management. More...

std::string	getPropertyValue (const std::string &name) const override
	Get the value of a property as a string. More...

const std::vector< Kernel::Property * > &	getProperties () const override
	Get the list of managed properties. More...

std::vector< std::string >	getDeclaredPropertyNames () const noexcept override
	Return the list of declared property names. More...

TypedValue	getProperty (const std::string &name) const override
	Get the value of a property. More...

std::string	asString (bool withDefaultValues=false) const override
	Return the property manager serialized as a string. More...

::Json::Value	asJson (bool withDefaultValues=false) const override
	Return the property manager serialized as a json object. More...

bool	isDefault (const std::string &name) const

void	removeProperty (const std::string &name, const bool delproperty=true) override
	Removes the property from management. More...

std::unique_ptr< Kernel::Property >	takeProperty (const size_t index) override
	Removes the property from management and returns a pointer to it. More...

void	clear () override
	Clears all properties under management. More...

void	afterPropertySet (const std::string &) override
	Override this method to perform a custom action right after a property was set. More...

void	filterByTime (const Types::Core::DateAndTime &, const Types::Core::DateAndTime &) override

void	splitByTime (std::vector< Kernel::SplittingInterval > &, std::vector< Kernel::PropertyManager * >) const override

void	filterByProperty (const Kernel::TimeSeriesProperty< bool > &, const std::vector< std::string > &) override

Kernel::Property *	getPointerToProperty (const std::string &name) const override
	Get a property by name. More...

Kernel::Property *	getPointerToPropertyOrdinal (const int &index) const override
	Get a property by an index. More...

virtual void	declareProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
	Function to declare properties (i.e. store them) More...

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

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

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

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). More...

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). More...

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

const std::vector< std::string >	categories () const override
	Function to return all of the categories that contain this algorithm. More...

const std::string	categorySeparator () const override
	Function to return the separator token for the category string. More...

const std::string	alias () const override
	function to return any aliases to the algorithm; A default implementation is provided More...

const std::string	aliasDeprecated () const override
	Expiration date (in ISO8601 format) for the algorithm aliases; default implementation for no expiration date. More...

const std::string	helpURL () const override
	function to return URL for algorithm documentation; A default implementation is provided. More...

template<typename T , typename = typename std::enable_if<std::is_convertible<T , MatrixWorkspace >::value>::type>
std::tuple< std::shared_ptr< T >, Indexing::SpectrumIndexSet >	getWorkspaceAndIndices (const std::string &name) const

template<typename T1 , typename T2 , typename = typename std::enable_if<std::is_convertible<T1 , MatrixWorkspace >::value>::type, typename = typename std::enable_if<std::is_convertible<T2 , std::string >::value \|\| std::is_convertible<T2 , std::vector<int64_t> >::value>::type>
void	setWorkspaceInputProperties (const std::string &name, const std::shared_ptr< T1 > &wksp, IndexType type, const T2 &list)

template<typename T1 , typename T2 , typename = typename std::enable_if<std::is_convertible<T1 , MatrixWorkspace >::value>::type, typename = typename std::enable_if<std::is_convertible<T2 , std::string >::value \|\| std::is_convertible<T2 , std::vector<int64_t> >::value>::type>
void	setWorkspaceInputProperties (const std::string &name, const std::string &wsName, IndexType type, const T2 &list)

const std::string	workspaceMethodName () const override

const std::vector< std::string >	workspaceMethodOn () const override

const std::string	workspaceMethodInputProperty () const override

AlgorithmID	getAlgorithmID () const override
	Algorithm ID. More...

virtual void	addObserver (const Poco::AbstractObserver &observer) const =0
	Add an observer for a notification. More...

virtual const std::string	alias () const =0
	function to return any aliases of the algorithm. More...

virtual const std::string	aliasDeprecated () const =0
	Expiration date (in ISO8601 format) for the algorithm aliases. Empty if no expiration date. More...

virtual void	cancel ()=0
	Raises the cancel flag. More...

virtual const std::vector< std::string >	categories () const =0
	Function to return all of the categories that contain this algorithm. More...

virtual const std::string	category () const =0
	function to return a category of the algorithm. More...

virtual const std::string	categorySeparator () const =0
	Function to return the separator token for the category string. More...

virtual void	enableHistoryRecordingForChild (const bool on)=0
	If true history will be recorded for a child. More...

virtual bool	execute ()=0
	System execution. More...

virtual void	executeAsChildAlg ()=0
	Execute as a Child Algorithm, with try/catch. More...

virtual Poco::ActiveResult< bool >	executeAsync ()=0
	Asynchronous execution of the algorithm. More...

virtual ExecutionState	executionState () const =0
	Gets the current execution state. More...

virtual AlgorithmID	getAlgorithmID () const =0
	Algorithm ID. More...

virtual bool	getAlgStartupLogging () const =0
	get the state of Logging of start and end messages More...

virtual bool	getAlwaysStoreInADS () const =0
	To query whether the output is stored in the analysis data service. More...

virtual int	getLoggingOffset () const =0
	returns the logging priority offset More...

virtual const std::string	helpURL () const =0
	function to return an optional URL for documentation. More...

virtual void	initialize ()=0
	Initialization method invoked by the framework. More...

virtual bool	isChild () const =0
	To query whether algorithm is a child. Default to false. More...

virtual bool	isExecuted () const =0
	Check whether the algorithm has been executed sucessfully. More...

virtual bool	isInitialized () const =0
	Check whether the algorithm is initialized properly. More...

virtual bool	isLogging () const =0
	returns the status of logging, True = enabled More...

virtual bool	isReadyForGarbageCollection () const =0
	True if the algorithm is ready for garbage collection. More...

virtual bool	isRunning () const =0
	True if the algorithm is running. More...

virtual const std::string	name () const =0
	function to return a name of the algorithm, must be overridden in all algorithms More...

virtual void	removeObserver (const Poco::AbstractObserver &observer) const =0
	Remove an observer. More...

virtual ResultState	resultState () const =0
	Gets the currnet result State. More...

virtual const std::vector< std::string >	seeAlso () const =0
	Function to return all of the seeAlso algorithms related to this algorithm. More...

virtual void	setAlgStartupLogging (const bool enabled)=0
	disable Logging of start and end messages More...

virtual void	setAlwaysStoreInADS (const bool doStore)=0
	Set whether we always store the output in the analysis data service. More...

virtual void	setChild (const bool isChild)=0
	To set whether algorithm is a child. More...

virtual void	setChildEndProgress (const double endProgress) const =0
	setting the child end progress More...

virtual void	setChildStartProgress (const double startProgress) const =0
	setting the child start progress More...

virtual void	setLogging (const bool value)=0
	Logging can be disabled by passing a value of false. More...

virtual void	setLoggingOffset (const int value)=0
	gets the logging priority offset More...

virtual void	setRethrows (const bool rethrow)=0
	To query whether an algorithm should rethrow exceptions when executing. More...

virtual const std::string	summary () const =0
	function returns a summary message that will be displayed in the default GUI, and in the help. More...

virtual ::Json::Value	toJson () const =0
	Serialize an algorithm as Json. More...

virtual std::string	toString () const =0
	Serialize an algorithm. More...

virtual std::map< std::string, std::string >	validateInputs ()=0
	Method checking errors on ALL the inputs, before execution. More...

virtual int	version () const =0
	function to return a version of the algorithm, must be overridden in all algorithms More...

Algorithms As Methods
Public Member Functions inherited from Mantid::Kernel::IPropertyManager
virtual ::Json::Value	asJson (bool withDefaultValues=false) const =0
	Return the property manager serialized as a json object. More...

virtual std::string	asString (bool withDefaultValues=false) const =0
	Return the property manager serialized as a string. More...

virtual void	declareOrReplaceProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
	Function to declare properties (i.e. store them) More...

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). More...

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

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). More...

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

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

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

virtual void	declareProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
	Function to declare properties (i.e. store them) More...

virtual bool	existsProperty (const std::string &name) const =0
	Checks whether the named property is already in the list of managed property. More...

virtual void	filterByProperty (const TimeSeriesProperty< bool > &, const std::vector< std::string > &)=0

virtual void	filterByTime (const Types::Core::DateAndTime &, const Types::Core::DateAndTime &)=0

virtual std::vector< std::string >	getDeclaredPropertyNames () const noexcept=0
	Get the list of managed property names. More...

virtual Property *	getPointerToProperty (const std::string &name) const =0
	Get a pointer to property by name. More...

virtual const std::vector< Property * > &	getProperties () const =0
	Get the list of managed properties. More...

std::vector< Property * >	getPropertiesInGroup (const std::string &group) const
	Get the list of managed properties in a given group. More...

virtual TypedValue	getProperty (const std::string &name) const =0
	Get the value of a property. More...

virtual std::string	getPropertyValue (const std::string &name) const =0
	Get the value of a property as a string. More...

virtual size_t	propertyCount () const =0
	Returns the number of properties under management. More...

virtual void	removeProperty (const std::string &name, const bool delproperty=true)=0
	Removes the property from management. More...

virtual void	resetProperties ()=0

virtual void	setProperties (const ::Json::Value &jsonValue, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)=0
	Sets all the properties from a json object. More...

virtual void	setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)=0
	Sets all properties from a string. More...

virtual void	setPropertiesWithString (const std::string &propertiesString, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >())=0
	Sets all the declared properties from a string. More...

IPropertyManager *	setProperty (const std::string &name, const char *value)
	Specialised version of setProperty template method to handle const char *. More...

IPropertyManager *	setProperty (const std::string &name, const std::string &value)
	Specialised version of setProperty template method to handle std::string. More...

template<typename T >
IPropertyManager *	setProperty (const std::string &name, const T &value)
	Templated method to set the value of a PropertyWithValue. More...

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

void	setPropertyGroup (const std::string &name, const std::string &group)
	Set the group for a given property. More...

virtual void	setPropertyOrdinal (const int &index, const std::string &value)=0
	Set the value of a property by an index. More...

void	setPropertySettings (const std::string &name, std::unique_ptr< IPropertySettings > settings)

virtual void	setPropertyValue (const std::string &name, const std::string &value)=0
	Sets property value from a string. More...

virtual void	setPropertyValueFromJson (const std::string &name, const Json::Value &value)=0
	Sets property value from a Json::Value. More...

virtual void	splitByTime (std::vector< SplittingInterval > &, std::vector< PropertyManager * >) const =0

virtual std::unique_ptr< Property >	takeProperty (const size_t index)=0
	Removes the property from management and returns a pointer to it. More...

void	updatePropertyValues (const IPropertyManager &other)
	Update values of the existing properties. More...

virtual bool	validateProperties () const =0
	Validates all the properties in the collection. More...

virtual	~IPropertyManager ()=default

Private Member Functions
void	assertNonNegative (std::map< std::string, std::string > &errors, const Kernel::PropertyManager &args, const std::string &flavour, const std::vector< const std::string * > &keys)
	Ensures there is no specified property with negative value. More...

std::string	createCylinderLikeXML (const Kernel::PropertyManager &args, const Geometry::ReferenceFrame &refFrame, bool hollow, const std::string &id="sample-shape") const
	Create the XML required to define a cylinder from the given args. More...

std::string	createFlatPlateHolderXML (const Kernel::PropertyManager &args, const Geometry::ReferenceFrame &refFrame) const
	Create the XML required to define a flat plate holder from the given args Flate plate holder is a CSG union of 2 flat plates one on each side of the sample The front and back holders are supposed to have the same width and height and angle as the sample Only the centre needs to be calculated taking into account the thichkness of the sample in between. More...

std::string	createFlatPlateXML (const Kernel::PropertyManager &args, const Geometry::ReferenceFrame &refFrame, const std::string &id="sample-shape") const
	Create the XML required to define a flat plate from the given args. More...

std::string	createHollowCylinderHolderXML (const Kernel::PropertyManager &args, const Geometry::ReferenceFrame &refFrame) const
	Create the XML required to define a hollow cylinder holder from the given args Hollow cylinder holder is a CSG union of 2 hollow cylinders one inside, one outside the sample The centre, the axis and the height are assumed to be the same as for the sample Only the inner and outer radii need to be manipulated. More...

std::string	createSphereXML (const Kernel::PropertyManager &args) const
	Create the XML required to define a sphere from the given args. More...

void	exec () override final
	Execute the algorithm. More...

void	init () override final
	Initialize the algorithm's properties. More...

bool	isDictionaryPopulated (const Kernel::PropertyManager_const_sptr &dict) const
	Checks if a json dictionary parameter is populated or not. More...

Kernel::PropertyManager	materialSettingsEnsureLegacyCompatibility (const Kernel::PropertyManager &materialArgs)
	Ensures the backwards compatibility of material arguments. More...

void	setMaterial (ReadMaterial::MaterialParameters &materialParams, const Kernel::PropertyManager &materialArgs)
	SetSample::setMaterial Configures a material from the parameters. More...

const Geometry::SampleEnvironment *	setSampleEnvironmentFromFile (API::ExperimentInfo &experiment, const Kernel::PropertyManager_const_sptr &args)
	Set the requested sample environment on the workspace from the environment file. More...

const Geometry::SampleEnvironment *	setSampleEnvironmentFromXML (API::ExperimentInfo &experiment, const Kernel::PropertyManager_const_sptr &canGeometryArgs, const Kernel::PropertyManager_const_sptr &canMaterialArgs)
	Set the requested sample environment from shape XML string. More...

void	setSampleShape (API::ExperimentInfo &experiment, const Kernel::PropertyManager_const_sptr &args, const Geometry::SampleEnvironment *sampleEnv)

std::string	tryCreateXMLFromArgsOnly (const Kernel::PropertyManager &args, const Geometry::ReferenceFrame &refFrame)
	Create the required XML for a given shape type plus its arguments. More...

void	validateGeometry (std::map< std::string, std::string > &errors, const Kernel::PropertyManager &args, const std::string &flavour)
	Validates the geometry. More...

std::map< std::string, std::string >	validateInputs () override final
	Validate the inputs against each other. More...

void	validateMaterial (std::map< std::string, std::string > &errors, const Kernel::PropertyManager &inputArgs, const std::string &flavour)
	Validates the material. More...

Additional Inherited Members
Public Types inherited from Mantid::API::Algorithm
using	WorkspaceVector = std::vector< std::shared_ptr< Workspace > >

Static Public Member Functions inherited from Mantid::API::Algorithm
static IAlgorithm_sptr	fromString (const std::string &input)
	De-serialize an object from a string. More...

static IAlgorithm_sptr	fromJson (const Json::Value &input)
	De-serialize an object from a Json. More...

static IAlgorithm_sptr	fromHistory (const AlgorithmHistory &history)
	Construct an object from a history entry. More...

Public Attributes inherited from Mantid::API::Algorithm
bool	calledByAlias = false
	Flag to indicate if the algorithm is called by its alias. More...

Protected Member Functions inherited from Mantid::API::Algorithm
void	exec (Parallel::ExecutionMode executionMode)
	Runs the algorithm with the specified execution mode. More...

virtual void	execDistributed ()
	Runs the algorithm in `distributed` execution mode. More...

virtual void	execMasterOnly ()
	Runs the algorithm in `master-only` execution mode. More...

virtual Parallel::ExecutionMode	getParallelExecutionMode (const std::map< std::string, Parallel::StorageMode > &storageModes) const
	Get correct execution mode based on input storage modes for an MPI run. More...

virtual const std::string	workspaceMethodOnTypes () const
	Returns a semi-colon separated list of workspace types to attach this algorithm. More...

void	cacheWorkspaceProperties ()
	Go through the properties and cache the input/output workspace properties for later use. More...

void	cacheInputWorkspaceHistories ()
	Cache the histories of any input workspaces so they can be copied over after algorithm completion. More...

void	setExecutionState (const ExecutionState state)
	Sets the current execution state. More...

void	setResultState (const ResultState state)
	Sets the result execution state. More...

void	store ()
	Stores any output workspaces into the AnalysisDataService. More...

void	progress (double p, const std::string &msg="", double estimatedTime=0.0, int progressPrecision=0)
	Sends ProgressNotification. More...

void	interruption_point ()
	This is called during long-running operations, and check if the algorithm has requested that it be cancelled. More...

Poco::NotificationCenter &	notificationCenter () const
	Return a reference to the algorithm's notification dispatcher. More...

void	handleChildProgressNotification (const Poco::AutoPtr< ProgressNotification > &pNf)
	Observation slot for child algorithm progress notification messages, these are scaled and then signalled for this algorithm. More...

const Poco::AbstractObserver &	progressObserver () const
	Return a reference to the algorithm's object that is reporting progress. More...

bool	isWorkspaceProperty (const Kernel::Property *const prop) const
	checks the property is a workspace property More...

bool	trackingHistory ()
	get whether we are tracking the history for this algorithm, More...

virtual void	fillHistory ()
	Copy workspace history for input workspaces to output workspaces and record the history for ths algorithm. More...

virtual void	setOtherProperties (IAlgorithm *alg, const std::string &propertyName, const std::string &propertyValue, int periodNum)
	Virtual method to set the non workspace properties for this algorithm. More...

template<typename T , const int AllowedIndexTypes = static_cast<int>(IndexType::WorkspaceIndex), typename... WSPropArgs, typename = typename std::enable_if<std::is_convertible<T , MatrixWorkspace >::value>::type>
void	declareWorkspaceInputProperties (const std::string &propertyName, const std::string &doc, WSPropArgs &&...wsPropArgs)

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

virtual void	clear ()=0
	Clears all properties under management. More...

virtual Property *	getPointerToPropertyOrdinal (const int &index) const =0
	Get a property by an index. More...

template<typename T >
T	getValue (const std::string &name) const
	Templated method to get the value of a property. More...

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

Static Protected Member Functions inherited from Mantid::API::Algorithm
template<typename NumT >
static bool	isEmpty (const NumT toCheck)
	checks that the value was not set by users, uses the value in empty double/int. More...

Protected Attributes inherited from Mantid::API::Algorithm
std::atomic< bool >	m_cancel
	Set to true to stop execution. More...

std::atomic< bool >	m_parallelException
	Set if an exception is thrown, and not caught, within a parallel region. More...

std::vector< IWorkspaceProperty * >	m_inputWorkspaceProps
	All the WorkspaceProperties that are Input or InOut. Set in execute() More...

std::shared_ptr< AlgorithmHistory >	m_history
	Pointer to the history for the algorithm being executed. More...

Kernel::Logger	m_log
	Logger for this algorithm. More...

Kernel::Logger &	g_log

std::shared_ptr< AlgorithmHistory >	m_parentHistory
	Pointer to the parent history object (if set) More...

std::vector< WorkspaceVector >	m_unrolledInputWorkspaces
	One vector of workspaces for each input workspace property. More...

size_t	m_groupSize
	Size of the group(s) being processed. More...

bool	m_usingBaseProcessGroups = false
	distinguish between base processGroups() and overriden/algorithm specific versions More...

Static Protected Attributes inherited from Mantid::API::Algorithm
static size_t	g_execCount = 0
	Counter to keep track of algorithm execution order. More...

Detailed Description

High-level interface for setting sample metadata on a workspace.

Definition at line 27 of file SetSample.h.

Member Function Documentation

◆ assertNonNegative()

void Mantid::DataHandling::SetSample::assertNonNegative	(	std::map< std::string, std::string > &	errors,
		const Kernel::PropertyManager &	geomArgs,
		const std::string &	flavour,
		const std::vector< const std::string * > &	keys
	)

private

Ensures there is no specified property with negative value.

Parameters

errors	map
geomArgs	geometry arguments
flavour	sample or container
keys	the vector of property names to check

Definition at line 395 of file SetSample.cpp.

Referenced by validateInputs().

◆ category()

const std::string Mantid::DataHandling::SetSample::category ( ) const

finaloverridevirtual

Algorithm's category for identification.

See also: Algorithm::category

Reimplemented from Mantid::API::Algorithm.

Definition at line 270 of file SetSample.cpp.

◆ createCylinderLikeXML()

std::string Mantid::DataHandling::SetSample::createCylinderLikeXML	(	const Kernel::PropertyManager &	args,
		const Geometry::ReferenceFrame &	refFrame,
		bool	hollow,
		const std::string &	id = `"sample-shape"`
	)		const

private

Create the XML required to define a cylinder from the given args.

Parameters

args	A user-supplied dict of args
refFrame	Defines the reference frame for the shape
hollow	True if an annulus is to be created
id	A generic id for the shape element

Returns: The XML definition string

Definition at line 1002 of file SetSample.cpp.

References Mantid::Kernel::PropertyManager::existsProperty(), Mantid::Kernel::PropertyManager::getPropertyValue(), height, innerRadius, Mantid::Geometry::ReferenceFrame::pointingUp(), Mantid::Kernel::V3D::X(), Mantid::Kernel::V3D::Y(), and Mantid::Kernel::V3D::Z().

Referenced by createHollowCylinderHolderXML(), and tryCreateXMLFromArgsOnly().

◆ createFlatPlateHolderXML()

std::string Mantid::DataHandling::SetSample::createFlatPlateHolderXML	(	const Kernel::PropertyManager &	args,
		const Geometry::ReferenceFrame &	refFrame
	)		const

private

Create the XML required to define a flat plate holder from the given args Flate plate holder is a CSG union of 2 flat plates one on each side of the sample The front and back holders are supposed to have the same width and height and angle as the sample Only the centre needs to be calculated taking into account the thichkness of the sample in between.

Parameters

args	A user-supplied dict of args
refFrame	Defines the reference frame for the shape

Returns: The XML definition string

Definition at line 924 of file SetSample.cpp.

References createFlatPlateXML(), Mantid::Kernel::PropertyManager::existsProperty(), Mantid::Geometry::ReferenceFrame::getHandedness(), Mantid::Geometry::ReferenceFrame::pointingAlongBeam(), Mantid::Geometry::ReferenceFrame::pointingHorizontal(), Mantid::Geometry::Right, and Mantid::Kernel::IPropertyManager::setProperty().

Referenced by tryCreateXMLFromArgsOnly().

◆ createFlatPlateXML()

std::string Mantid::DataHandling::SetSample::createFlatPlateXML	(	const Kernel::PropertyManager &	args,
		const Geometry::ReferenceFrame &	refFrame,
		const std::string &	id = `"sample-shape"`
	)		const

private

Create the XML required to define a flat plate from the given args.

Parameters

args	A user-supplied dict of args
refFrame	Defines the reference frame for the shape
id	A generic id for the shape element

Returns: The XML definition string

Definition at line 853 of file SetSample.cpp.

References Mantid::Geometry::angDegrees, Mantid::Geometry::CCW, Mantid::Kernel::PropertyManager::existsProperty(), Mantid::Geometry::Goniometer::getR(), Mantid::Geometry::ReferenceFrame::pointingAlongBeam(), Mantid::Geometry::ReferenceFrame::pointingHorizontal(), Mantid::Geometry::ReferenceFrame::pointingUp(), Mantid::Geometry::Goniometer::pushAxis(), Mantid::Kernel::Matrix< T >::rotate(), rotation, Mantid::Geometry::x, Mantid::Kernel::V3D::X(), Mantid::Geometry::y, and Mantid::Geometry::z.

Referenced by createFlatPlateHolderXML(), and tryCreateXMLFromArgsOnly().

◆ createHollowCylinderHolderXML()

std::string Mantid::DataHandling::SetSample::createHollowCylinderHolderXML	(	const Kernel::PropertyManager &	args,
		const Geometry::ReferenceFrame &	refFrame
	)		const

private

Create the XML required to define a hollow cylinder holder from the given args Hollow cylinder holder is a CSG union of 2 hollow cylinders one inside, one outside the sample The centre, the axis and the height are assumed to be the same as for the sample Only the inner and outer radii need to be manipulated.

Parameters

args	A user-supplied dict of args
refFrame	Defines the reference frame for the shape

Returns: The XML definition string

Definition at line 981 of file SetSample.cpp.

References createCylinderLikeXML().

Referenced by tryCreateXMLFromArgsOnly().

◆ createSphereXML()

std::string Mantid::DataHandling::SetSample::createSphereXML ( const Kernel::PropertyManager & args ) const

private

Create the XML required to define a sphere from the given args.

Parameters

args	A user-supplied dict of args

Returns: The XML definition string

Definition at line 1059 of file SetSample.cpp.

References Mantid::Kernel::PropertyManager::getProperty(), and radius.

Referenced by tryCreateXMLFromArgsOnly().

◆ exec()

void Mantid::DataHandling::SetSample::exec ( )

finaloverrideprivatevirtual

Execute the algorithm.

Implements Mantid::API::Algorithm.

Definition at line 512 of file SetSample.cpp.

References Mantid::DataHandling::ReadMaterial::buildMaterial(), Mantid::Kernel::PropertyManager::declareProperty(), Mantid::Kernel::PropertyManager::existsProperty(), Mantid::API::Algorithm::getProperty(), isDictionaryPopulated(), materialSettingsEnsureLegacyCompatibility(), setMaterial(), Mantid::DataHandling::ReadMaterial::setMaterialParameters(), setSampleEnvironmentFromFile(), setSampleEnvironmentFromXML(), setSampleShape(), and workspace.

◆ init()

void Mantid::DataHandling::SetSample::init ( )

finaloverrideprivatevirtual

Initialize the algorithm's properties.

Implements Mantid::API::Algorithm.

Definition at line 487 of file SetSample.cpp.

References Mantid::API::Algorithm::declareProperty(), Mantid::Kernel::Direction::InOut, and Mantid::Kernel::Direction::Input.

◆ isDictionaryPopulated()

bool Mantid::DataHandling::SetSample::isDictionaryPopulated ( const Kernel::PropertyManager_const_sptr & dict ) const

private

Checks if a json dictionary parameter is populated or not.

Parameters

dict map

Definition at line 410 of file SetSample.cpp.

Referenced by exec(), setSampleShape(), and validateInputs().

◆ materialSettingsEnsureLegacyCompatibility()

PropertyManager Mantid::DataHandling::SetSample::materialSettingsEnsureLegacyCompatibility ( const Kernel::PropertyManager & materialArgs )

private

Ensures the backwards compatibility of material arguments.

Parameters

materialArgs const input material arguments

Returns: copy of material arguments without Sample prefix (see the comment)

Definition at line 1079 of file SetSample.cpp.

References Mantid::Kernel::PropertyManager::declareProperty(), Mantid::Kernel::PropertyManager::existsProperty(), Mantid::Kernel::PropertyManager::getProperty(), and Mantid::Kernel::IPropertyManager::setProperty().

Referenced by exec(), setSampleEnvironmentFromXML(), and validateMaterial().

◆ name()

const std::string Mantid::DataHandling::SetSample::name ( ) const

finaloverridevirtual

Algorithms name for identification.

See also: Algorithm::name

Implements Mantid::API::Algorithm.

Definition at line 264 of file SetSample.cpp.

◆ seeAlso()

const std::vector< std::string > Mantid::DataHandling::SetSample::seeAlso ( ) const

inlineoverridevirtual

Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm.A default implementation is provided.

Reimplemented from Mantid::API::Algorithm.

Definition at line 31 of file SetSample.h.

◆ setMaterial()

void Mantid::DataHandling::SetSample::setMaterial	(	ReadMaterial::MaterialParameters &	materialParams,
		const Kernel::PropertyManager &	materialArgs
	)

private

SetSample::setMaterial Configures a material from the parameters.

Parameters

materialParams	: output material parameters object
materialArgs	: input material arguments, can be altered (see comment inside)

Definition at line 660 of file SetSample.cpp.

Referenced by exec(), setSampleEnvironmentFromXML(), and validateMaterial().

◆ setSampleEnvironmentFromFile()

const Geometry::SampleEnvironment * Mantid::DataHandling::SetSample::setSampleEnvironmentFromFile	(	API::ExperimentInfo &	exptInfo,
		const Kernel::PropertyManager_const_sptr &	args
	)

private

Set the requested sample environment on the workspace from the environment file.

Parameters

exptInfo	A reference to the ExperimentInfo to receive the environment
args	The dictionary of flags for the environment

Returns: A pointer to the new sample environment

Definition at line 574 of file SetSample.cpp.

References Mantid::DataHandling::SampleEnvironmentFactory::create(), Mantid::API::Sample::getEnvironment(), Mantid::API::ExperimentInfo::getInstrument(), Mantid::Kernel::SingletonHolder< T >::Instance(), Mantid::API::ExperimentInfo::mutableSample(), Mantid::DataHandling::SampleEnvironmentFactory::parseSpec(), Mantid::API::ExperimentInfo::sample(), and Mantid::API::Sample::setEnvironment().

Referenced by exec().

◆ setSampleEnvironmentFromXML()

const Geometry::SampleEnvironment * Mantid::DataHandling::SetSample::setSampleEnvironmentFromXML	(	API::ExperimentInfo &	exptInfo,
		const Kernel::PropertyManager_const_sptr &	canGeomArgs,
		const Kernel::PropertyManager_const_sptr &	canMaterialArgs
	)

private

Set the requested sample environment from shape XML string.

Parameters

exptInfo	A reference to the ExperimentInfo to receive the environment
canGeomArgs	The dictionary of flags for the environment
canMaterialArgs	The dictionary of material parameters

Returns: A pointer to the new sample environment

Definition at line 625 of file SetSample.cpp.

References Mantid::DataHandling::ReadMaterial::buildMaterial(), Mantid::Geometry::ShapeFactory::createShape(), Mantid::API::Sample::getEnvironment(), Mantid::API::ExperimentInfo::getInstrument(), materialSettingsEnsureLegacyCompatibility(), Mantid::API::ExperimentInfo::mutableSample(), Mantid::API::ExperimentInfo::sample(), Mantid::API::Sample::setEnvironment(), setMaterial(), Mantid::DataHandling::ReadMaterial::setMaterialParameters(), tryCreateXMLFromArgsOnly(), and Mantid::DataHandling::ReadMaterial::MaterialParameters::volume.

Referenced by exec().

◆ setSampleShape()

void Mantid::DataHandling::SetSample::setSampleShape	(	API::ExperimentInfo &	experiment,
		const Kernel::PropertyManager_const_sptr &	args,
		const Geometry::SampleEnvironment *	sampleEnv
	)

private

Parameters

experiment	A reference to the experiment to be affected
args	The user-supplied dictionary of flags
sampleEnv	A pointer to the sample environment if one exists, otherwise null

Returns: A string containing the XML definition of the shape

Definition at line 724 of file SetSample.cpp.

References Mantid::Geometry::ShapeFactory::addGoniometerTag(), Mantid::Geometry::SampleEnvironment::getContainer(), Mantid::API::Run::getGoniometer(), Mantid::API::ExperimentInfo::getInstrument(), Mantid::API::Sample::getMaterial(), Mantid::Geometry::Goniometer::getR(), Mantid::Geometry::Container::hasCustomizableSampleShape(), Mantid::Geometry::Container::hasFixedSampleShape(), isDictionaryPopulated(), Mantid::API::ExperimentInfo::mutableSample(), Mantid::Kernel::Matrix< T >::rotate(), Mantid::API::ExperimentInfo::run(), Mantid::API::ExperimentInfo::sample(), Mantid::DataHandling::CreateSampleShape::setSampleShape(), Mantid::API::Sample::setShape(), and tryCreateXMLFromArgsOnly().

Referenced by exec().

◆ summary()

const std::string Mantid::DataHandling::SetSample::summary ( ) const

finaloverridevirtual

Algorithm's summary for use in the GUI and help.

See also: Algorithm::summary

Implements Mantid::API::Algorithm.

Definition at line 273 of file SetSample.cpp.

◆ tryCreateXMLFromArgsOnly()

std::string Mantid::DataHandling::SetSample::tryCreateXMLFromArgsOnly	(	const Kernel::PropertyManager &	args,
		const Geometry::ReferenceFrame &	refFrame
	)

private

Create the required XML for a given shape type plus its arguments.

Parameters

args	A dict of flags defining the shape
refFrame	Defines the reference frame for the shape

Returns: A string containing the XML if possible or an empty string

Definition at line 812 of file SetSample.cpp.

References createCylinderLikeXML(), createFlatPlateHolderXML(), createFlatPlateXML(), createHollowCylinderHolderXML(), createSphereXML(), Mantid::Kernel::Logger::debug(), Mantid::Kernel::PropertyManager::existsProperty(), Mantid::API::Algorithm::g_log, Mantid::Kernel::PropertyManager::getPropertyValue(), and Mantid::Kernel::Logger::is().

Referenced by setSampleEnvironmentFromXML(), and setSampleShape().

◆ validateGeometry()

void Mantid::DataHandling::SetSample::validateGeometry	(	std::map< std::string, std::string > &	errors,
		const Kernel::PropertyManager &	geomArgs,
		const std::string &	flavour
	)

private

Validates the geometry.

Parameters

errors	map
geomArgs	geometry arguments
flavour	sample or container

Definition at line 283 of file SetSample.cpp.

References Mantid::Geometry::ShapeFactory::createShape(), and Mantid::Kernel::PropertyManager::getPropertyValue().

Referenced by validateInputs().

◆ validateInputs()

std::map< std::string, std::string > Mantid::DataHandling::SetSample::validateInputs ( void )

finaloverrideprivatevirtual

Validate the inputs against each other.

See also: Algorithm::validateInputs

Reimplemented from Mantid::API::Algorithm.

Definition at line 419 of file SetSample.cpp.

References assertNonNegative(), Mantid::API::Algorithm::getProperty(), isDictionaryPopulated(), validateGeometry(), and validateMaterial().

◆ validateMaterial()

void Mantid::DataHandling::SetSample::validateMaterial	(	std::map< std::string, std::string > &	errors,
		const Kernel::PropertyManager &	inputArgs,
		const std::string &	flavour
	)

private

Validates the material.

Parameters

errors	map
inputArgs	material arguments
flavour	sample or container

Definition at line 373 of file SetSample.cpp.

References error, materialSettingsEnsureLegacyCompatibility(), setMaterial(), and Mantid::DataHandling::ReadMaterial::validateInputs().

Referenced by validateInputs().

◆ version()

int Mantid::DataHandling::SetSample::version ( ) const

finaloverridevirtual

Algorithm's version for identification.

See also: Algorithm::version

Implements Mantid::API::Algorithm.

Definition at line 267 of file SetSample.cpp.

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

Framework/DataHandling/inc/MantidDataHandling/SetSample.h
Framework/DataHandling/src/SetSample.cpp

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ assertNonNegative()

◆ category()

◆ createCylinderLikeXML()

◆ createFlatPlateHolderXML()

◆ createFlatPlateXML()

◆ createHollowCylinderHolderXML()

◆ createSphereXML()

◆ exec()

◆ init()

◆ isDictionaryPopulated()

◆ materialSettingsEnsureLegacyCompatibility()

◆ name()

◆ seeAlso()

◆ setMaterial()

◆ setSampleEnvironmentFromFile()

◆ setSampleEnvironmentFromXML()

◆ setSampleShape()

◆ summary()

◆ tryCreateXMLFromArgsOnly()

◆ validateGeometry()

◆ validateInputs()

◆ validateMaterial()

◆ version()