Mantid
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Mantid::API::CompositeDomainMD Class Reference

A composite domain for MD functions. More...

#include <CompositeDomainMD.h>

Inheritance diagram for Mantid::API::CompositeDomainMD:
Mantid::API::CompositeDomain Mantid::API::FunctionDomain

Public Member Functions

 CompositeDomainMD (const IMDWorkspace_const_sptr &ws, size_t maxDomainSize)
 Create a composite domain from a IMDWorkspace. More...
 
const FunctionDomaingetDomain (size_t i) const override
 Return i-th domain. More...
 
size_t getNParts () const override
 Return the number of parts in the domain. More...
 
size_t size () const override
 Return the total number of arguments in the domain. More...
 
 ~CompositeDomainMD () override
 Destructor. More...
 
virtual const FunctionDomaingetDomain (size_t i) const =0
 Return i-th domain. More...
 
virtual size_t getNParts () const =0
 Return the number of parts in the domain. More...
 
- Public Member Functions inherited from Mantid::API::FunctionDomain
virtual void reset () const
 Reset the the domain so it can be reused. More...
 
virtual size_t size () const =0
 Return the number of points in the domain. More...
 
virtual ~FunctionDomain ()=default
 Virtual destructor. More...
 

Protected Attributes

std::vector< std::unique_ptr< FunctionDomainMD > > m_domains
 smaller parts of the domain More...
 
std::unique_ptr< IMDIteratorm_iterator
 IMDIterator. More...
 
size_t m_totalSize
 The total size of the domain. More...
 

Detailed Description

A composite domain for MD functions.

Author
Roman Tolchenov, Tessella plc
Date
15/11/2011

Definition at line 28 of file CompositeDomainMD.h.

Constructor & Destructor Documentation

◆ CompositeDomainMD()

Mantid::API::CompositeDomainMD::CompositeDomainMD ( const IMDWorkspace_const_sptr ws,
size_t  maxDomainSize 
)

Create a composite domain from a IMDWorkspace.

Parameters
ws:: Pointer to a workspace.
maxDomainSize:: The maximum size each domain can have.

Definition at line 23 of file CompositeDomainMD.cpp.

References m_domains, m_iterator, and m_totalSize.

◆ ~CompositeDomainMD()

Mantid::API::CompositeDomainMD::~CompositeDomainMD ( )
overridedefault

Destructor.

Member Function Documentation

◆ getDomain()

const FunctionDomain & Mantid::API::CompositeDomainMD::getDomain ( size_t  i) const
overridevirtual

Return i-th domain.

Return i-th domain reset to its start.

Implements Mantid::API::CompositeDomain.

Definition at line 45 of file CompositeDomainMD.cpp.

References m_domains.

◆ getNParts()

size_t Mantid::API::CompositeDomainMD::getNParts ( ) const
inlineoverridevirtual

Return the number of parts in the domain.

Implements Mantid::API::CompositeDomain.

Definition at line 35 of file CompositeDomainMD.h.

◆ size()

size_t Mantid::API::CompositeDomainMD::size ( ) const
inlineoverridevirtual

Return the total number of arguments in the domain.

Implements Mantid::API::FunctionDomain.

Definition at line 33 of file CompositeDomainMD.h.

Member Data Documentation

◆ m_domains

std::vector<std::unique_ptr<FunctionDomainMD> > Mantid::API::CompositeDomainMD::m_domains
mutableprotected

smaller parts of the domain

Definition at line 42 of file CompositeDomainMD.h.

Referenced by CompositeDomainMD(), and getDomain().

◆ m_iterator

std::unique_ptr<IMDIterator> Mantid::API::CompositeDomainMD::m_iterator
mutableprotected

IMDIterator.

Definition at line 40 of file CompositeDomainMD.h.

Referenced by CompositeDomainMD().

◆ m_totalSize

size_t Mantid::API::CompositeDomainMD::m_totalSize
protected

The total size of the domain.

Definition at line 41 of file CompositeDomainMD.h.

Referenced by CompositeDomainMD().


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