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.
 
WorkspacedoCloneEmpty () const override
 Virtual cloneEmpty method.
 
size_t getMemorySize () const override
 Get the footprint in memory in bytes.
 
const std::string id () const override
 A string ID for the class.
 
const std::string toString () const override
 Serializes the object to a string.
 
- 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.
 
Workspace_uptr cloneEmpty () const
 Returns a default-initialized clone of the workspace.
 
const std::string & getComment () const
 Get the workspace comment.
 
const WorkspaceHistorygetHistory () const
 Returns a reference to the WorkspaceHistory const.
 
std::string getMemorySizeAsStr () const
 Returns the memory footprint in sensible units.
 
const std::string & getName () const override
 Get the workspace name.
 
const std::string & getPythonVariableName () const
 
virtual const std::string getTitle () const
 Get the workspace title.
 
WorkspaceHistoryhistory ()
 Returns a reference to the WorkspaceHistory.
 
bool isDirty (const int n=1) const
 Check whether other algorithms have been applied to the workspace by checking the history length.
 
virtual bool isGroup () const
 
Workspaceoperator= (const Workspace &other)=delete
 
void setComment (const std::string &)
 Set the comment field of the workspace.
 
void setPythonVariableName (const std::string &)
 
virtual void setTitle (const std::string &)
 Set the title of the workspace.
 
bool threadSafe () const override
 Marks the workspace as safe for multiple threads to edit data simutaneously.
 
 Workspace ()
 
 ~Workspace ()
 
- Public Member Functions inherited from Mantid::Kernel::DataItem
 DataItem ()
 Default constructor.
 
 DataItem (const DataItem &other)
 Copy constructor Always makes a unique lock.
 
virtual ~DataItem ()
 Destructor.
 
void readLock ()
 Acquires a read lock.
 
void unlock ()
 

Additional Inherited Members

- Protected Member Functions inherited from Mantid::API::Workspace
 Workspace (const Workspace &)
 Protected copy constructor. May be used by childs for cloning.
 
- Protected Member Functions inherited from Mantid::Kernel::DataItem
Poco::RWLock * getLock () const
 Private method to access the RWLock object.
 

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: