#include <SaveCanSAS1D.h>

Inheritance diagram for Mantid::DataHandling::SaveCanSAS1D:

Public Member Functions
const std::string	category () const override
	function to return a category of the algorithm.

const std::string	name () const override
	function to return a name of the algorithm, must be overridden in all algorithms

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

int	version () const override
	function to return a version of the algorithm, must be overridden in all algorithms

	~SaveCanSAS1D () override=default

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

	Algorithm (const Algorithm &)=delete

Algorithm &	operator= (const Algorithm &)=delete

	~Algorithm () override
	Virtual destructor.

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

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

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.

std::map< std::string, std::string >	validateInputs () override
	Perform validation of ALL the input properties of the algorithm.

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

void	cancel () override
	Raises the cancel flag.

bool	getCancel () const
	Returns the cancellation state.

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

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

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

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

int	getLoggingOffset () const override
	returns the logging priority offset

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

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

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

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

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

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

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.

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

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.

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)

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

virtual bool	processGroups ()
	Process WorkspaceGroup inputs.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	clear () override
	Clears all properties under management.

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

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

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

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

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.

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.

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

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.

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

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

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.

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

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

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

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
	Mechanism for retriving the index property.

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)
	Mechanism for setting the index property with a workspace shared pointer.

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)
	Mechanism for setting the index property with a workspace shared pointer.

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.

Algorithms As Methods
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.

virtual void	filterByProperty (Mantid::Kernel::LogFilter *, const std::vector< std::string > &)

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 Member Functions
void	createSASDataElement (std::string &sasData, size_t workspaceIndex)
	this method creates a sasData element

void	createSASDetectorElement (std::string &sasDet)
	this method creates a sasDetector element

void	createSASInstrument (std::string &sasInstrument)
	this method creates a sasInstrument element

void	createSASProcessElement (std::string &sasProcess)
	this method creates a sasProcess element

virtual void	createSASRootElement (std::string &rootElem)
	sasroot element

void	createSASRunElement (std::string &sasRun)
	this method creates a sasRun Element

void	createSASSampleElement (std::string &sasSample)
	this method creates a sasSample element

void	createSASSourceElement (std::string &sasSource)
	this method creates a sasSource element

void	createSASTitleElement (std::string &sasTitle)
	this method creates a sasTitle element

void	exec () override
	Overwrites Algorithm method.

void	findEndofLastEntry ()
	Moves to the end of the last entry in the file.

void	init () override
	Overwrites Algorithm method.

bool	openForAppending (const std::string &filename)
	opens the named file if possible or returns false

void	prepareFileToWriteEntry (const std::string &fileName)
	Opens the output file and, as necessary blanks it, writes the file header and moves the file pointer.

void	replacewithEntityReference (std::string &input, const std::string::size_type &index)
	replaces the charcter at index in the input string with xml entity reference(eg.replace '&' with "&")

void	searchandreplaceSpecialChars (std::string &input)
	this method searches for xml special characters and replace with entity references

void	setOtherProperties (API::IAlgorithm *alg, const std::string &propertyName, const std::string &propertyValue, int perioidNum) override
	overriden method sets appending for workspace groups

virtual void	writeHeader (const std::string &fileName)
	Write xml header tags.

Protected Member Functions inherited from Mantid::API::Algorithm
virtual const std::string	workspaceMethodOnTypes () const
	Returns a semi-colon separated list of workspace types to attach this algorithm.

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

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

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

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

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

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

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

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

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

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

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

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

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

void	fillHistory (const std::vector< Workspace_sptr > &outputWorkspaces)
	Copy workspace history from input workspaces to provided vector of output workspaces.

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)
	Declare a property which defines the workspace and allowed index types, as well as a property for capturing the indices all at once.

Protected Member Functions inherited from Mantid::Kernel::IPropertyManager
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

Protected Attributes
std::fstream	m_outFile
	an fstream object is used to write the xml manually as the user requires a specific format with new line characters and this can't be done in using the stylesheet part in Poco or libXML

API::MatrixWorkspace_const_sptr	m_workspace
	points to the workspace that will be written to file

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

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

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

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

Kernel::Logger	m_log
	Logger for this algorithm.

Kernel::Logger &	g_log

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

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

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

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

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.

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

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

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

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.

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

Detailed Description

This algorithm saves  workspace into CanSAS1d format. This is an xml format
except
the <Idata>, </Idata> tags and all data in between must be one line, which
necesitates
the files be written iostream functions outside xml libraries.

The structure of CanSAS1d xml is:

<SASroot version="1.0" xmlns="" xmlns:xsi="" xsi:schemaLocation="">
<SASentry>
  <Title></Title>
  <Run></Run>
  <SASdata>
    <Idata><Q unit="1/A"></Q><I unit="a.u."></I><Idev unit="a.u."></Idev><Qdev
unit="1/A"></Qdev></Idata>
  </SASdata>
  <SASsample>
    <ID></ID>
  </SASsample>
  <SASinstrument>
    <name></name>
    <SASsource>
      <radiation></radiation>
      <wavelength unit="A"></wavelength>
    </SASsource>
    <SAScollimation/>
    <SASdetector>
      <name></name>
      <SDD></SDD>
    </SASdetector>
  </SASinstrument>
  <SASprocess>
    <name></name>
    <date></date>
    <term name="svn"></term>
    <term name="user_file"></term>
  </SASprocess>
  <SASnote>
  </SASnote>
</SASentry>
</SASroot>

Required properties:

InputWorkspace - The name workspace to save.
Filename - The path save the file

Author: Sofia Antony, Rutherford Appleton Laboratory

Date: 19/01/2010

Definition at line 82 of file SaveCanSAS1D.h.

Constructor & Destructor Documentation

◆ ~SaveCanSAS1D()

Mantid::DataHandling::SaveCanSAS1D::~SaveCanSAS1D ( )

overridedefault

Member Function Documentation

◆ category()

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

inlineoverridevirtual

function to return a category of the algorithm.

A default implementation is provided

Reimplemented from Mantid::API::Algorithm.

Definition at line 90 of file SaveCanSAS1D.h.

◆ createSASDataElement()

void Mantid::DataHandling::SaveCanSAS1D::createSASDataElement	(	std::string &	sasData,
		size_t	workspaceIndex
	)

protected

this method creates a sasData element

This method creates an XML element named "SASdata".

Parameters

sasData	:: string for sasdata element in the xml
workspaceIndex	:: workspace index to be exported in SASdata entry

Definition at line 415 of file SaveCanSAS1D.cpp.

References m_workspace, searchandreplaceSpecialChars(), Mantid::Geometry::x, and Mantid::Geometry::y.

Referenced by exec(), and Mantid::DataHandling::SaveCanSAS1D2::exec().

◆ createSASDetectorElement()

void Mantid::DataHandling::SaveCanSAS1D::createSASDetectorElement ( std::string & sasDet )

protected

this method creates a sasDetector element

This method creates XML elements named "SASdetector".

This method appends to sasDet.

Parameters

sasDet :: string for one or more sasdetector elements

Definition at line 521 of file SaveCanSAS1D.cpp.

References Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), m_workspace, and Mantid::Kernel::Logger::notice().

Referenced by createSASInstrument().

◆ createSASInstrument()

void Mantid::DataHandling::SaveCanSAS1D::createSASInstrument ( std::string & sasInstrument )

protected

this method creates a sasInstrument element

This method creates an XML element named "SASinstrument".

The structure for required(r) parts of the SASinstrument and the parts we want to add is:

SASinstrument name(r) SASsource(r) radiation(r) SAScollimation(r) aperature[name] size x[units] y[units] SASdetector name

Parameters

sasInstrument :: string for sasinstrument element in the xml

Definition at line 641 of file SaveCanSAS1D.cpp.

References createSASDetectorElement(), createSASSourceElement(), Mantid::API::Algorithm::getProperty(), m_workspace, searchandreplaceSpecialChars(), and std::to_string().

Referenced by exec(), and Mantid::DataHandling::SaveCanSAS1D2::exec().

◆ createSASProcessElement()

void Mantid::DataHandling::SaveCanSAS1D::createSASProcessElement ( std::string & sasProcess )

protected

this method creates a sasProcess element

This method creates an XML element named "SASprocess".

Parameters

sasProcess :: string for sasprocess element in the xml

Definition at line 569 of file SaveCanSAS1D.cpp.

References Mantid::API::LogManager::getLogData(), Mantid::API::Algorithm::getProperty(), Mantid::API::LogManager::hasProperty(), m_workspace, Mantid::Kernel::Property::value(), and Mantid::Kernel::MantidVersion::version().

Referenced by exec().

◆ createSASRootElement()

void Mantid::DataHandling::SaveCanSAS1D::createSASRootElement ( std::string & rootElem )

protectedvirtual

sasroot element

This method creates an XML element named "SASroot".

Parameters

rootElem :: xml root element string

Reimplemented in Mantid::DataHandling::SaveCanSAS1D2.

Definition at line 368 of file SaveCanSAS1D.cpp.

Referenced by writeHeader().

◆ createSASRunElement()

void Mantid::DataHandling::SaveCanSAS1D::createSASRunElement ( std::string & sasRun )

protected

this method creates a sasRun Element

This method creates an XML element named "Run".

Parameters

sasRun :: string for run element in the xml

Definition at line 392 of file SaveCanSAS1D.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, m_workspace, searchandreplaceSpecialChars(), and Mantid::Kernel::Property::value().

Referenced by exec(), and Mantid::DataHandling::SaveCanSAS1D2::exec().

◆ createSASSampleElement()

void Mantid::DataHandling::SaveCanSAS1D::createSASSampleElement ( std::string & sasSample )

protected

this method creates a sasSample element

This method creates an XML element named "SASsample".

Parameters

sasSample :: string for sassample element in the xml

Definition at line 480 of file SaveCanSAS1D.cpp.

References Mantid::API::Algorithm::getProperty(), m_workspace, searchandreplaceSpecialChars(), and std::to_string().

Referenced by exec(), and Mantid::DataHandling::SaveCanSAS1D2::exec().

◆ createSASSourceElement()

void Mantid::DataHandling::SaveCanSAS1D::createSASSourceElement ( std::string & sasSource )

protected

this method creates a sasSource element

This method creates an XML element named "SASsource".

Parameters

sasSource :: string for sassource element in the xml

Definition at line 505 of file SaveCanSAS1D.cpp.

References Mantid::API::Algorithm::getPropertyValue().

Referenced by createSASInstrument().

◆ createSASTitleElement()

void Mantid::DataHandling::SaveCanSAS1D::createSASTitleElement ( std::string & sasTitle )

protected

this method creates a sasTitle element

This method creates an XML element named "Title".

Parameters

sasTitle :: string for title element in the xml

Definition at line 380 of file SaveCanSAS1D.cpp.

References m_workspace, and searchandreplaceSpecialChars().

Referenced by exec(), and Mantid::DataHandling::SaveCanSAS1D2::exec().

◆ exec()

void Mantid::DataHandling::SaveCanSAS1D::exec ( )

overrideprotectedvirtual

Overwrites Algorithm method.

Implements Mantid::API::Algorithm.

Reimplemented in Mantid::DataHandling::SaveCanSAS1D2.

Definition at line 138 of file SaveCanSAS1D.cpp.

References createSASDataElement(), createSASInstrument(), createSASProcessElement(), createSASRunElement(), createSASSampleElement(), createSASTitleElement(), Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::getPropertyValue(), m_outFile, m_workspace, prepareFileToWriteEntry(), and searchandreplaceSpecialChars().

◆ findEndofLastEntry()

void Mantid::DataHandling::SaveCanSAS1D::findEndofLastEntry ( )

protected

Moves to the end of the last entry in the file.

Moves to the end of the last entry in the file, after &ltSASentry&gt before &lt/SASroot&gt.

Exceptions

fstream::failure	if the read or write commands couldn't complete
logic_error	if the tag at the end of the last entry couldn't be found

Definition at line 253 of file SaveCanSAS1D.cpp.

References m_outFile.

Referenced by prepareFileToWriteEntry().

◆ init()

void Mantid::DataHandling::SaveCanSAS1D::init ( )

overrideprotectedvirtual

Overwrites Algorithm method.

Implements Mantid::API::Algorithm.

Reimplemented in Mantid::DataHandling::SaveCanSAS1D2.

Definition at line 68 of file SaveCanSAS1D.cpp.

References Mantid::Kernel::Direction::Input, and Mantid::API::FileProperty::Save.

Referenced by Mantid::DataHandling::SaveCanSAS1D2::init().

◆ name()

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

inlineoverridevirtual

function to return a name of the algorithm, must be overridden in all algorithms

Implements Mantid::API::Algorithm.

Definition at line 85 of file SaveCanSAS1D.h.

Referenced by Mantid::DataHandling::SaveCanSAS1D2::createSASTransElement().

◆ openForAppending()

bool Mantid::DataHandling::SaveCanSAS1D::openForAppending ( const std::string & filename )

protected

opens the named file if possible or returns false

Parameters

filename :: *

Returns: true if the file was opened successfully and isn't empty

Definition at line 229 of file SaveCanSAS1D.cpp.

References Mantid::API::Algorithm::g_log, Mantid::Kernel::Logger::information(), and m_outFile.

Referenced by prepareFileToWriteEntry().

◆ prepareFileToWriteEntry()

void Mantid::DataHandling::SaveCanSAS1D::prepareFileToWriteEntry ( const std::string & fileName )

protected

Opens the output file and, as necessary blanks it, writes the file header and moves the file pointer.

Opens the output file and either moves the file pointer to beyond the last entry or blanks the file and writes a header.

Parameters

fileName :: name of the output file

Exceptions

logic_error	if append was selected but end of an entry tag couldn't be found
FileError	if there was a problem writing to the file

Definition at line 206 of file SaveCanSAS1D.cpp.

References findEndofLastEntry(), Mantid::API::Algorithm::getProperty(), m_outFile, openForAppending(), and writeHeader().

Referenced by exec(), and Mantid::DataHandling::SaveCanSAS1D2::exec().

◆ replacewithEntityReference()

void Mantid::DataHandling::SaveCanSAS1D::replacewithEntityReference	(	std::string &	input,
		const std::string::size_type &	index
	)

protected

replaces the charcter at index in the input string with xml entity reference(eg.replace '&' with "&")

This method retrieves the character at index and if it's a xml special character replaces with XML entity reference.

Parameters

input	:: -input string
index	:: position of the special character in the input string

Definition at line 344 of file SaveCanSAS1D.cpp.

References index.

Referenced by searchandreplaceSpecialChars().

◆ searchandreplaceSpecialChars()

void Mantid::DataHandling::SaveCanSAS1D::searchandreplaceSpecialChars ( std::string & input )

protected

this method searches for xml special characters and replace with entity references

This method search for xml special characters in the input string and replaces this with xml entity reference.

Parameters

input :: -input string

Definition at line 319 of file SaveCanSAS1D.cpp.

References replacewithEntityReference().

Referenced by createSASDataElement(), createSASInstrument(), createSASRunElement(), createSASSampleElement(), createSASTitleElement(), exec(), and Mantid::DataHandling::SaveCanSAS1D2::exec().

◆ setOtherProperties()

void Mantid::DataHandling::SaveCanSAS1D::setOtherProperties	(	API::IAlgorithm *	alg,
		const std::string &	propertyName,
		const std::string &	propertyValue,
		int	perioidNum
	)

overrideprotectedvirtual

overriden method sets appending for workspace groups

Is called when the input workspace was actually a group, it sets the for all group members after the first so that the whole group is saved.

Parameters

alg	:: pointer to the algorithm
propertyName	:: name of the property
propertyValue	:: value of the property
perioidNum	:: period number

Reimplemented from Mantid::API::Algorithm.

Definition at line 128 of file SaveCanSAS1D.cpp.

References Mantid::API::Algorithm::setOtherProperties(), and Mantid::Kernel::IPropertyManager::setPropertyValue().

◆ summary()

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

inlineoverridevirtual

function returns a summary message that will be displayed in the default GUI, and in the help.

Implements Mantid::API::Algorithm.

Definition at line 86 of file SaveCanSAS1D.h.

◆ version()

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

inlineoverridevirtual

function to return a version of the algorithm, must be overridden in all algorithms

Implements Mantid::API::Algorithm.

Reimplemented in Mantid::DataHandling::SaveCanSAS1D2.

Definition at line 89 of file SaveCanSAS1D.h.

◆ writeHeader()

void Mantid::DataHandling::SaveCanSAS1D::writeHeader ( const std::string & fileName )

protectedvirtual

Write xml header tags.

Write xml header tags including the root element and starting the SASentry element.

Parameters

fileName :: the name of the file to write to

Exceptions

FileError if the file can't be opened or writen to

Reimplemented in Mantid::DataHandling::SaveCanSAS1D2.

Definition at line 301 of file SaveCanSAS1D.cpp.

References createSASRootElement(), and m_outFile.

Referenced by prepareFileToWriteEntry().

Member Data Documentation

◆ m_outFile

std::fstream Mantid::DataHandling::SaveCanSAS1D::m_outFile

protected

an fstream object is used to write the xml manually as the user requires a specific format with new line characters and this can't be done in using the stylesheet part in Poco or libXML

Definition at line 148 of file SaveCanSAS1D.h.

Referenced by exec(), Mantid::DataHandling::SaveCanSAS1D2::exec(), findEndofLastEntry(), openForAppending(), prepareFileToWriteEntry(), writeHeader(), and Mantid::DataHandling::SaveCanSAS1D2::writeHeader().

◆ m_workspace

API::MatrixWorkspace_const_sptr Mantid::DataHandling::SaveCanSAS1D::m_workspace

protected

points to the workspace that will be written to file

Definition at line 144 of file SaveCanSAS1D.h.

Referenced by createSASDataElement(), createSASDetectorElement(), createSASInstrument(), createSASProcessElement(), Mantid::DataHandling::SaveCanSAS1D2::createSASProcessElement(), createSASRunElement(), createSASSampleElement(), createSASTitleElement(), exec(), and Mantid::DataHandling::SaveCanSAS1D2::exec().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~SaveCanSAS1D()

Member Function Documentation

◆ category()

◆ createSASDataElement()

◆ createSASDetectorElement()

◆ createSASInstrument()

◆ createSASProcessElement()

◆ createSASRootElement()

◆ createSASRunElement()

◆ createSASSampleElement()

◆ createSASSourceElement()

◆ createSASTitleElement()

◆ exec()

◆ findEndofLastEntry()

◆ init()

◆ name()

◆ openForAppending()

◆ prepareFileToWriteEntry()

◆ replacewithEntityReference()

◆ searchandreplaceSpecialChars()

◆ setOtherProperties()

◆ summary()

◆ version()

◆ writeHeader()

Member Data Documentation

◆ m_outFile

◆ m_workspace