Mantid
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
Mantid::API::IMaskWorkspace Class Referenceabstract

This class provides an interface to a MaskWorkspace. More...

#include <IMaskWorkspace.h>

Inheritance diagram for Mantid::API::IMaskWorkspace:
Mantid::DataObjects::MaskWorkspace

Public Member Functions

std::unique_ptr< IMaskWorkspaceclone () const
 Returns a clone of the workspace. More...
 
virtual std::size_t getNumberMasked () const =0
 Total number of masked pixels. More...
 
virtual const std::string id () const
 Return the workspace typeID. More...
 
 IMaskWorkspace ()=default
 
virtual bool isMasked (const detid_t detectorID) const =0
 Check if a detector is masked. More...
 
virtual bool isMasked (const std::set< detid_t > &detectorIDs) const =0
 Check if all detectors in a set are masked. More...
 
IMaskWorkspaceoperator= (const IMaskWorkspace &)=delete
 
virtual void setMasked (const detid_t detectorID, const bool mask=true)=0
 Set / remove mask of a detector. More...
 
virtual void setMasked (const std::set< detid_t > &detectorIDs, const bool mask=true)=0
 Set / remove masks of all detectors in a set. More...
 
virtual ~IMaskWorkspace ()=default
 

Protected Member Functions

virtual IMaskWorkspacedoInterfaceClone () const =0
 returns a clone of the workspace as the interface More...
 
 IMaskWorkspace (const IMaskWorkspace &other)
 Protected copy constructor. May be used by childs for cloning. More...
 

Detailed Description

This class provides an interface to a MaskWorkspace.

Definition at line 21 of file IMaskWorkspace.h.

Constructor & Destructor Documentation

◆ IMaskWorkspace() [1/2]

Mantid::API::IMaskWorkspace::IMaskWorkspace ( )
default

◆ ~IMaskWorkspace()

virtual Mantid::API::IMaskWorkspace::~IMaskWorkspace ( )
virtualdefault

◆ IMaskWorkspace() [2/2]

Mantid::API::IMaskWorkspace::IMaskWorkspace ( const IMaskWorkspace other)
inlineprotected

Protected copy constructor. May be used by childs for cloning.

Definition at line 43 of file IMaskWorkspace.h.

Member Function Documentation

◆ clone()

std::unique_ptr< IMaskWorkspace > Mantid::API::IMaskWorkspace::clone ( ) const
inline

Returns a clone of the workspace.

Definition at line 39 of file IMaskWorkspace.h.

◆ doInterfaceClone()

virtual IMaskWorkspace * Mantid::API::IMaskWorkspace::doInterfaceClone ( ) const
protectedpure virtual

returns a clone of the workspace as the interface

Implemented in Mantid::DataObjects::MaskWorkspace.

◆ getNumberMasked()

virtual std::size_t Mantid::API::IMaskWorkspace::getNumberMasked ( ) const
pure virtual

Total number of masked pixels.

Implemented in Mantid::DataObjects::MaskWorkspace.

Referenced by export_IMaskWorkspace().

◆ id()

virtual const std::string Mantid::API::IMaskWorkspace::id ( ) const
inlinevirtual

Return the workspace typeID.

Reimplemented in Mantid::DataObjects::MaskWorkspace.

Definition at line 27 of file IMaskWorkspace.h.

◆ isMasked() [1/2]

virtual bool Mantid::API::IMaskWorkspace::isMasked ( const detid_t  detectorID) const
pure virtual

Check if a detector is masked.

Referenced by export_IMaskWorkspace().

◆ isMasked() [2/2]

virtual bool Mantid::API::IMaskWorkspace::isMasked ( const std::set< detid_t > &  detectorIDs) const
pure virtual

Check if all detectors in a set are masked.

◆ operator=()

IMaskWorkspace & Mantid::API::IMaskWorkspace::operator= ( const IMaskWorkspace )
delete

◆ setMasked() [1/2]

virtual void Mantid::API::IMaskWorkspace::setMasked ( const detid_t  detectorID,
const bool  mask = true 
)
pure virtual

Set / remove mask of a detector.

◆ setMasked() [2/2]

virtual void Mantid::API::IMaskWorkspace::setMasked ( const std::set< detid_t > &  detectorIDs,
const bool  mask = true 
)
pure virtual

Set / remove masks of all detectors in a set.


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