Mantid
Loading...
Searching...
No Matches
Public Member Functions | List of all members
FakeWorkspace Class Reference

#include <FakeObjects.h>

Inheritance diagram for FakeWorkspace:
Mantid::API::Workspace Mantid::Kernel::DataItem

Public Member Functions

WorkspacedoClone () const override
 Virtual clone method. Not implemented to force implementation in children. More...
 
WorkspacedoCloneEmpty () const override
 Virtual cloneEmpty method. More...
 
size_t getMemorySize () const override
 Get the footprint in memory in bytes. More...
 
const std::string id () const override
 A string ID for the class. More...
 
const std::string toString () const override
 Serializes the object to a string. More...
 
- Public Member Functions inherited from Mantid::API::Workspace
Workspace_uptr clone () const
 Returns a clone (copy) of the workspace with covariant return type in all derived classes. More...
 
Workspace_uptr cloneEmpty () const
 Returns a default-initialized clone of the workspace. More...
 
const std::string & getComment () const
 Get the workspace comment. More...
 
const WorkspaceHistorygetHistory () const
 Returns a reference to the WorkspaceHistory const. More...
 
virtual size_t getMemorySize () const =0
 Get the footprint in memory in bytes. More...
 
std::string getMemorySizeAsStr () const
 Returns the memory footprint in sensible units. More...
 
const std::string & getName () const override
 Get the workspace name. More...
 
virtual const std::string getTitle () const
 Get the workspace title. More...
 
WorkspaceHistoryhistory ()
 Returns a reference to the WorkspaceHistory. More...
 
bool isDirty (const int n=1) const
 Check whether other algorithms have been applied to the workspace by checking the history length. More...
 
virtual bool isGroup () const
 
Workspaceoperator= (const Workspace &other)=delete
 
void setComment (const std::string &)
 Set the comment field of the workspace. More...
 
virtual void setTitle (const std::string &)
 Set the title of the workspace. More...
 
Parallel::StorageMode storageMode () const
 Returns the storage mode (used for MPI runs) More...
 
bool threadSafe () const override
 Marks the workspace as safe for multiple threads to edit data simutaneously. More...
 
 Workspace (const Parallel::StorageMode storageMode=Parallel::StorageMode::Cloned)
 
 ~Workspace ()
 
- Public Member Functions inherited from Mantid::Kernel::DataItem
 DataItem ()
 Default constructor. More...
 
 DataItem (const DataItem &other)
 Copy constructor Always makes a unique lock. More...
 
virtual ~DataItem ()
 Destructor. More...
 
void readLock ()
 Acquires a read lock. More...
 
void unlock ()
 

Additional Inherited Members

- Protected Member Functions inherited from Mantid::API::Workspace
void setStorageMode (Parallel::StorageMode mode)
 Sets the storage mode (used for MPI runs) More...
 
 Workspace (const Workspace &)
 Protected copy constructor. May be used by childs for cloning. More...
 
- Protected Member Functions inherited from Mantid::Kernel::DataItem
Poco::RWLock * getLock () const
 Private method to access the RWLock object. More...
 

Detailed Description

Definition at line 111 of file FakeObjects.h.

Member Function Documentation

◆ doClone()

Workspace * FakeWorkspace::doClone ( ) const
inlineoverridevirtual

Virtual clone method. Not implemented to force implementation in children.

Implements Mantid::API::Workspace.

Definition at line 114 of file FakeObjects.h.

◆ doCloneEmpty()

Workspace * FakeWorkspace::doCloneEmpty ( ) const
inlineoverridevirtual

Virtual cloneEmpty method.

Not implemented to force implementation in children.

Implements Mantid::API::Workspace.

Definition at line 115 of file FakeObjects.h.

◆ getMemorySize()

size_t FakeWorkspace::getMemorySize ( ) const
inlineoverridevirtual

Get the footprint in memory in bytes.

Implements Mantid::API::Workspace.

Definition at line 117 of file FakeObjects.h.

◆ id()

const std::string FakeWorkspace::id ( ) const
inlineoverridevirtual

A string ID for the class.

Implements Mantid::Kernel::DataItem.

Definition at line 113 of file FakeObjects.h.

◆ toString()

const std::string FakeWorkspace::toString ( ) const
inlineoverridevirtual

Serializes the object to a string.

Implements Mantid::Kernel::DataItem.

Definition at line 116 of file FakeObjects.h.


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