Mantid::API::Grouping Class Reference

Structure to represent grouping information. More...

#include <GroupingLoader.h>

Public Member Functions
	Grouping ()=default
	Default constructor. More...
	Grouping (const ITableWorkspace_sptr &table)
	Construct a Grouping from a table. More...
ITableWorkspace_sptr	toTable () const
	Convert to grouping table. More...
	~Grouping ()
	Destructor. More...

Public Attributes
std::string	defaultName
std::string	description
std::vector< std::string >	groupNames
std::vector< std::string >	groups
std::vector< double >	pairAlphas
std::vector< std::string >	pairNames
std::vector< std::pair< size_t, size_t > >	pairs

Detailed Description

Structure to represent grouping information.

Definition at line 17 of file GroupingLoader.h.

Constructor & Destructor Documentation

Grouping() [1/2]

Mantid::API::Grouping::Grouping ( )

default

Default constructor.

~Grouping()

Mantid::API::Grouping::~Grouping ( )

default

Destructor.

Define destructor here because the type is complete.

Grouping() [2/2]

Mantid::API::Grouping::Grouping

(

const ITableWorkspace_sptr &

table

)

Construct a Grouping from a table.

Parameters

table

:: [input] Table to construct from

Definition at line 224 of file GroupingLoader.cpp.

References groupNames, groups, pairAlphas, pairNames, pairs, std::to_string(), and Mantid::Kernel::Strings::toString().

Member Function Documentation

toTable()

ITableWorkspace_sptr Mantid::API::Grouping::toTable

(

)

const

Convert to grouping table.

Converts a grouping information to a grouping table.

Discard all the information not stored in a table - group names, pairing, description.

Returns

A grouping table as accepted by MuonGroupDetectors

Definition at line 252 of file GroupingLoader.cpp.

References groups, Mantid::Kernel::SingletonHolder< T >::Instance(), and Mantid::Kernel::Strings::parseRange().

Member Data Documentation

defaultName

std::string Mantid::API::Grouping::defaultName

Definition at line 27 of file GroupingLoader.h.

Referenced by MuonGroupingXMLHelper::groupingToXML(), and Mantid::API::GroupingLoader::loadGroupingFromXML().

description

std::string Mantid::API::Grouping::description

Definition at line 26 of file GroupingLoader.h.

Referenced by MuonGroupingXMLHelper::groupingToXML(), and Mantid::API::GroupingLoader::loadGroupingFromXML().

groupNames

std::vector<std::string> Mantid::API::Grouping::groupNames

Definition at line 19 of file GroupingLoader.h.

Referenced by MuonGroupingXMLHelper::createXMLwithPairsAndGroups(), Grouping(), MuonGroupingXMLHelper::groupingToXML(), and Mantid::API::GroupingLoader::loadGroupingFromXML().

groups

std::vector<std::string> Mantid::API::Grouping::groups

Definition at line 20 of file GroupingLoader.h.

Referenced by MuonGroupingXMLHelper::createXMLwithPairsAndGroups(), Grouping(), MuonGroupingXMLHelper::groupingToXML(), Mantid::API::GroupingLoader::loadGroupingFromXML(), and toTable().

pairAlphas

std::vector<double> Mantid::API::Grouping::pairAlphas

Definition at line 24 of file GroupingLoader.h.

Referenced by MuonGroupingXMLHelper::createXMLwithPairsAndGroups(), Grouping(), MuonGroupingXMLHelper::groupingToXML(), and Mantid::API::GroupingLoader::loadGroupingFromXML().

pairNames

std::vector<std::string> Mantid::API::Grouping::pairNames

Definition at line 22 of file GroupingLoader.h.

Referenced by MuonGroupingXMLHelper::createXMLwithPairsAndGroups(), Grouping(), MuonGroupingXMLHelper::groupingToXML(), and Mantid::API::GroupingLoader::loadGroupingFromXML().

pairs

std::vector<std::pair<size_t, size_t> > Mantid::API::Grouping::pairs

Definition at line 23 of file GroupingLoader.h.

Referenced by MuonGroupingXMLHelper::createXMLwithPairsAndGroups(), Grouping(), MuonGroupingXMLHelper::groupingToXML(), and Mantid::API::GroupingLoader::loadGroupingFromXML().

---

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

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