Mantid::Crystal::ModulationProperties Struct Reference

Tie together the names of the properties for the modulation vectors. More...

#include <PeakAlgorithmHelpers.h>

Static Public Member Functions
static void	appendTo (API::IAlgorithm *alg)
	Append the common set of properties that relate to modulation vectors to the given algorithm. More...
static ModulationProperties	create (const API::IAlgorithm &alg)
	Create a ModulationProperties object from an algorithm. More...

Public Attributes
bool	crossTerms
int	maxOrder
std::vector< MNPOffset >	offsets
bool	saveOnLattice

Static Public Attributes
static const std::string	CrossTerms {"CrossTerms"}
static const std::string	MaxOrder {"MaxOrder"}
static const std::string	ModVector1 {"ModVector1"}
static const std::string	ModVector2 {"ModVector2"}
static const std::string	ModVector3 {"ModVector3"}

Detailed Description

Tie together the names of the properties for the modulation vectors.

Definition at line 26 of file PeakAlgorithmHelpers.h.

Member Function Documentation

appendTo()

void Mantid::Crystal::ModulationProperties::appendTo ( API::IAlgorithm *  alg )

static

Append the common set of properties that relate to modulation vectors to the given algorithm.

Parameters

alg	A pointer to the algorithm that will receive the properties

Definition at line 43 of file PeakAlgorithmHelpers.cpp.

References CrossTerms, Mantid::Kernel::IPropertyManager::declareProperty(), Mantid::Kernel::Direction::Input, MaxOrder, ModVector1, ModVector2, and ModVector3.

Referenced by Mantid::Crystal::IndexPeaks::init(), Mantid::Crystal::PredictFractionalPeaks::init(), and Mantid::Crystal::PredictSatellitePeaks::init().

create()

ModulationProperties Mantid::Crystal::ModulationProperties::create ( const API::IAlgorithm &  alg )

static

Create a ModulationProperties object from an algorithm.

Parameters

alg	An algorithm containing the user input

Returns

A new ModulationProperties object

Definition at line 67 of file PeakAlgorithmHelpers.cpp.

References CrossTerms, crossTerms, Mantid::Crystal::generateOffsetVectors(), Mantid::Kernel::IPropertyManager::getProperty(), MaxOrder, maxOrder, ModVector1, ModVector2, ModVector3, offsets, saveOnLattice, and Mantid::Crystal::validModulationVectors().

Referenced by Mantid::Crystal::PredictFractionalPeaks::getModulationInfo().

Member Data Documentation

CrossTerms

const std::string Mantid::Crystal::ModulationProperties::CrossTerms {"CrossTerms"}

inlinestatic

Definition at line 31 of file PeakAlgorithmHelpers.h.

Referenced by appendTo(), create(), Mantid::Crystal::PredictSatellitePeaks::exec(), Mantid::Crystal::PredictSatellitePeaks::exec_peaks(), and Mantid::Crystal::PredictFractionalPeaks::init().

crossTerms

bool Mantid::Crystal::ModulationProperties::crossTerms

Definition at line 38 of file PeakAlgorithmHelpers.h.

Referenced by create().

MaxOrder

const std::string Mantid::Crystal::ModulationProperties::MaxOrder {"MaxOrder"}

inlinestatic

Definition at line 30 of file PeakAlgorithmHelpers.h.

Referenced by appendTo(), create(), Mantid::Crystal::PredictSatellitePeaks::exec(), Mantid::Crystal::PredictSatellitePeaks::exec_peaks(), Mantid::Crystal::PredictFractionalPeaks::getModulationInfo(), Mantid::Crystal::PredictFractionalPeaks::init(), and Mantid::Crystal::PredictFractionalPeaks::validateInputs().

maxOrder

int Mantid::Crystal::ModulationProperties::maxOrder

Definition at line 37 of file PeakAlgorithmHelpers.h.

Referenced by create().

ModVector1

const std::string Mantid::Crystal::ModulationProperties::ModVector1 {"ModVector1"}

inlinestatic

Definition at line 27 of file PeakAlgorithmHelpers.h.

Referenced by appendTo(), create(), Mantid::Crystal::PredictSatellitePeaks::exec(), Mantid::Crystal::PredictSatellitePeaks::exec_peaks(), Mantid::Crystal::PredictFractionalPeaks::init(), and Mantid::Crystal::PredictFractionalPeaks::validateInputs().

ModVector2

const std::string Mantid::Crystal::ModulationProperties::ModVector2 {"ModVector2"}

inlinestatic

Definition at line 28 of file PeakAlgorithmHelpers.h.

Referenced by appendTo(), create(), Mantid::Crystal::PredictSatellitePeaks::exec(), Mantid::Crystal::PredictSatellitePeaks::exec_peaks(), Mantid::Crystal::PredictFractionalPeaks::init(), and Mantid::Crystal::PredictFractionalPeaks::validateInputs().

ModVector3

const std::string Mantid::Crystal::ModulationProperties::ModVector3 {"ModVector3"}

inlinestatic

Definition at line 29 of file PeakAlgorithmHelpers.h.

Referenced by appendTo(), create(), Mantid::Crystal::PredictSatellitePeaks::exec(), Mantid::Crystal::PredictSatellitePeaks::exec_peaks(), Mantid::Crystal::PredictFractionalPeaks::init(), and Mantid::Crystal::PredictFractionalPeaks::validateInputs().

offsets

std::vector<MNPOffset> Mantid::Crystal::ModulationProperties::offsets

Definition at line 36 of file PeakAlgorithmHelpers.h.

Referenced by create().

saveOnLattice

bool Mantid::Crystal::ModulationProperties::saveOnLattice

Definition at line 39 of file PeakAlgorithmHelpers.h.

Referenced by create().

---

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

• Framework/Crystal/inc/MantidCrystal/PeakAlgorithmHelpers.h
• Framework/Crystal/src/PeakAlgorithmHelpers.cpp