ITableWorkspace is an implementation of Workspace in which the data are organised in columns of same size. More...

#include <ITableWorkspace.h>

Inheritance diagram for Mantid::API::ITableWorkspace:

Public Member Functions
virtual Column_sptr	addColumn (const std::string &type, const std::string &name)=0
	Creates a new column.

virtual bool	addColumns (const std::string &type, const std::string &name, size_t n)
	Creates n new columns of the same type.

TableRowHelper	appendRow ()
	Appends a row.

Boolean &	Bool (size_t row, size_t col)
	Get the reference to the element in row `row` and column `col` if its type is `bool`.

template<class T >
T &	cell (size_t row, size_t col)
	Get the reference to the element in row `row` and column `col`.

ITableWorkspace_uptr	clone () const
	Returns a clone of the workspace.

ITableWorkspace_uptr	cloneColumns (const std::vector< std::string > &colNames) const
	Returns a clone of the workspace.

ITableWorkspace_uptr	cloneEmpty () const
	Returns a default-initialized clone of the workspace.

virtual size_t	columnCount () const =0
	Number of columns in the workspace.

virtual bool	customSort () const
	Does this type of TableWorkspace need a custom sorting call (e.g.

double &	Double (size_t row, size_t col)
	Get the reference to the element in row `row` and column `col` if its type is `double`.

virtual void	find (API::Boolean value, size_t &row, size_t col)=0
	find method to get the index of API::Boolean value cell in a table workspace

virtual void	find (const Mantid::Kernel::V3D &value, size_t &row, size_t col)=0
	find method to get the index of Mantid::Kernel::V3D cell value in a table workspace

virtual void	find (const std::string &value, size_t &row, size_t col)=0
	find method to get the index of cellstd::string value in a table workspace

virtual void	find (double value, size_t &row, size_t col)=0
	find method to get the index of double cell value in a table workspace

virtual void	find (float value, size_t &row, size_t col)=0
	find method to get the index of float cell value in a table workspace

virtual void	find (size_t value, size_t &row, size_t col)=0
	find method to get the index of integer cell value in a table workspace

virtual Column_const_sptr	getColumn (const std::string &name) const =0
	Gets the shared pointer to a column by name.

virtual Column_sptr	getColumn (const std::string &name)=0
	Gets the shared pointer to a column by name.

virtual Column_const_sptr	getColumn (size_t index) const =0
	Gets the shared pointer to a column by index - return none-modifyable column.

virtual Column_sptr	getColumn (size_t index)=0
	Gets the shared pointer to a column by index.

virtual std::vector< std::string >	getColumnNames () const =0
	Returns a vector of all column names.

TableRowHelper	getFirstRow ()
	Creates a TableRow object for the first row (`row` == 0).

virtual API::LogManager_const_sptr	getLogs () const =0
	Get constant access to shared pointer containing workspace properties.

template<class T >
T &	getRef (const std::string &name, size_t index)
	Get a reference to a data element.

TableRowHelper	getRow (size_t row)
	Creates a TableRow object for row row.

TableColumnHelper	getVector (const std::string &name)
	Access the column with name `name` trough a ColumnVector object.

TableConstColumnHelper	getVector (const std::string &name) const
	Access the column with name `name` trough a ColumnVector object.

const std::string	id () const override
	Return the workspace typeID.

virtual size_t	insertRow (size_t index)=0
	Inserts a row before row pointed to by index and fills it with default vales.

int &	Int (size_t row, size_t col)
	Get the reference to the element in row `row` and column `col` if its type is `int`.

	ITableWorkspace ()
	Constructor.

virtual API::LogManager_sptr	logs ()=0
	Get access to shared pointer containing workspace properties.

void	modified ()
	If the workspace is the AnalysisDataService sends AfterReplaceNotification.

ITableWorkspace &	operator= (const ITableWorkspace &)=delete

virtual void	removeColumn (const std::string &name)=0
	Removes a column.

virtual void	removeRow (size_t index)=0
	Delets a row if it exists.

virtual size_t	rowCount () const =0
	Number of rows in the workspace.

virtual void	setRowCount (size_t count)=0
	Resizes the workspace.

virtual void	sort (std::vector< std::pair< std::string, bool > > &criteria)
	Overridable method to custom-sort the workspace.

std::string &	String (size_t row, size_t col)
	Get the reference to the element in row row and column col if its type is `std::string`.

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 WorkspaceHistory &	getHistory () const
	Returns a reference to the WorkspaceHistory const.

virtual size_t	getMemorySize () const =0
	Get the footprint in memory in bytes.

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.

WorkspaceHistory &	history ()
	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

Workspace &	operator= (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 () override

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 ()

Protected Member Functions
void	insertInColumn (Column *c, size_t index)
	Insert a new element into a column.

	ITableWorkspace (const ITableWorkspace &)=default
	Protected copy constructor. May be used by childs for cloning.

void	removeFromColumn (Column *c, size_t index)
	Remove an element from a column.

void	resizeColumn (Column *c, size_t size)
	Resize a column.

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.

Private Member Functions
ITableWorkspace *	doClone () const override
	Virtual clone method. Not implemented to force implementation in children.

virtual ITableWorkspace *	doCloneColumns (const std::vector< std::string > &colNames) const =0

ITableWorkspace *	doCloneEmpty () const override=0
	Virtual cloneEmpty method.

Detailed Description

ITableWorkspace is an implementation of Workspace in which the data are organised in columns of same size.

Elements of a column have the same data type. Columns can be added to the TableWorkspace with ctreateColumn(type,name). name is a name given to the column. type is a symbolic name for the data type of the column. Predefined types are:

"int" for int
"float" for float
"double" for double
"bool" for bool
"str" for std::string
"V3D" for Mantid::Kernel::V3D

User defined types can be used after declaring them with DECLARE_TABLECOLUMN macro: DECLARE_TABLECOLUMN(typeName, UserDefinedType)

Ways to access the data:

Using templated cell method. E.g. SomeType var = table.cell<SomeType>(i,j); where j is the column number, i is the position of the element in the column or the row number. The type of var must match the column's type, otherwise a runtime_error exception will be thrown. The columns are kept in the order of their creation.
Using specialized access methods for the predefined types. E.g. int var = table.Int(i,j);. If j-th column is of the wrong type a runtime_error exception will be thrown.
Getting the pointer to a column and working with it.
Using ColumnVector returned by getVector()
Creating a TableRow object and working with it.

Author: Roman Tolchenov

Date: 31/10/2008

Definition at line 101 of file ITableWorkspace.h.

Constructor & Destructor Documentation

◆ ITableWorkspace() [1/2]

Mantid::API::ITableWorkspace::ITableWorkspace ( )

inline

Constructor.

Definition at line 104 of file ITableWorkspace.h.

◆ ITableWorkspace() [2/2]

Mantid::API::ITableWorkspace::ITableWorkspace ( const ITableWorkspace & )

protecteddefault

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

Member Function Documentation

◆ addColumn()

virtual Column_sptr Mantid::API::ITableWorkspace::addColumn	(	const std::string &	type,
		const std::string &	name
	)

pure virtual

Creates a new column.

Parameters

type	:: The datatype of the column
name	:: The name to assign to the column

Returns: True if the column was successfully added

Implemented in Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, TableWorkspaceTester, and Mantid::DataObjects::TableWorkspace.

Referenced by addColumns(), and ITableWorkspacePickleSuite::readMetaData().

◆ addColumns()

bool Mantid::API::ITableWorkspace::addColumns	(	const std::string &	type,
		const std::string &	name,
		size_t	n
	)

virtual

Creates n new columns of the same type.

Parameters

type	:: The datatype of the column
name	:: The name to assign to the column
n	:: The number of columns to create

Returns: True if the column was successfully added

Reimplemented in Mantid::DataObjects::LeanElasticPeaksWorkspace, and Mantid::DataObjects::PeaksWorkspace.

Definition at line 35 of file ITableWorkspace.cpp.

References addColumn(), n, name, and ok.

◆ appendRow()

TableRowHelper Mantid::API::ITableWorkspace::appendRow ( )

Appends a row.

Definition at line 46 of file ITableWorkspace.cpp.

References getRow(), insertRow(), and rowCount().

Referenced by Mantid::DataObjects::SplittersWorkspace::addSplitter(), Mantid::CurveFitting::Algorithms::LeBailFit::exportInstrumentParameterToTable(), and ITableWorkspacePickleSuite::readData().

◆ Bool()

Boolean & Mantid::API::ITableWorkspace::Bool	(	size_t	row,
		size_t	col
	)

inline

Get the reference to the element in row row and column col if its type is bool.

If it doesn't match the actual type of the column a runtime_error exception is thrown.

Parameters

row	:: Row number
col	:: Column number

Returns: the reference of a requested cell if it's a boolean

Definition at line 248 of file ITableWorkspace.h.

◆ cell()

template<class T >

T & Mantid::API::ITableWorkspace::cell	(	size_t	row,
		size_t	col
	)

inline

Get the reference to the element in row row and column col.

Parameters

row	:: Row number
col	:: Column number

Template Parameters

T	Type of the data in the column. If it doesn't match the actual type a runtime_error exception is thrown.

Returns: the reference to the requested cell

Definition at line 209 of file ITableWorkspace.h.

References name, and std::to_string().

Referenced by Mantid::Crystal::SCDCalibratePanels::exec().

◆ clone()

ITableWorkspace_uptr Mantid::API::ITableWorkspace::clone ( ) const

inline

Returns a clone of the workspace.

Definition at line 107 of file ITableWorkspace.h.

◆ cloneColumns()

ITableWorkspace_uptr Mantid::API::ITableWorkspace::cloneColumns ( const std::vector< std::string > & colNames ) const

Returns a clone of the workspace.

Parameters

colNames :: Names of the column to clone. If empty clone all columns.

Definition at line 16 of file ITableWorkspace.cpp.

References doCloneColumns().

◆ cloneEmpty()

ITableWorkspace_uptr Mantid::API::ITableWorkspace::cloneEmpty ( ) const

inline

Returns a default-initialized clone of the workspace.

Definition at line 110 of file ITableWorkspace.h.

◆ columnCount()

virtual size_t Mantid::API::ITableWorkspace::columnCount ( ) const

pure virtual

Number of columns in the workspace.

Implemented in Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, Mantid::DataObjects::TableWorkspace, and TableWorkspaceTester.

Referenced by export_ITableWorkspace(), Mantid::DataObjects::MementoTableWorkspace::isMementoWorkspace(), Mantid::API::Projection::Projection(), Mantid::API::TableRow::TableRow(), and toString().

◆ customSort()

virtual bool Mantid::API::ITableWorkspace::customSort ( ) const

inlinevirtual

Does this type of TableWorkspace need a custom sorting call (e.g.

PeaksWorkspace)

Returns: true if the workspace needs custom sorting calls

Reimplemented in Mantid::DataObjects::LeanElasticPeaksWorkspace, and Mantid::DataObjects::PeaksWorkspace.

Definition at line 172 of file ITableWorkspace.h.

◆ doClone()

ITableWorkspace * Mantid::API::ITableWorkspace::doClone ( ) const

inlineoverrideprivatevirtual

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

Implements Mantid::API::Workspace.

Reimplemented in Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::MementoTableWorkspace, Mantid::DataObjects::PeaksWorkspace, Mantid::DataObjects::SplittersWorkspace, Mantid::DataObjects::TableWorkspace, and TableWorkspaceTester.

Definition at line 310 of file ITableWorkspace.h.

◆ doCloneColumns()

virtual ITableWorkspace * Mantid::API::ITableWorkspace::doCloneColumns ( const std::vector< std::string > & colNames ) const

privatepure virtual

Implemented in TableWorkspaceTester, Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, and Mantid::DataObjects::TableWorkspace.

Referenced by cloneColumns().

◆ doCloneEmpty()

ITableWorkspace * Mantid::API::ITableWorkspace::doCloneEmpty ( ) const

overrideprivatepure virtual

Virtual cloneEmpty method.

Not implemented to force implementation in children.

Implements Mantid::API::Workspace.

Implemented in Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::MementoTableWorkspace, Mantid::DataObjects::PeaksWorkspace, Mantid::DataObjects::SplittersWorkspace, Mantid::DataObjects::TableWorkspace, and TableWorkspaceTester.

◆ Double()

double & Mantid::API::ITableWorkspace::Double	(	size_t	row,
		size_t	col
	)

inline

Get the reference to the element in row row and column col if its type is double.

If it doesn't match the actual type of the column a runtime_error exception is thrown.

Parameters

row	:: Row number
col	:: Column number

Returns: the reference of a requested cell if it's a double

Definition at line 239 of file ITableWorkspace.h.

◆ find() [1/6]

virtual void Mantid::API::ITableWorkspace::find	(	API::Boolean	value,
		size_t &	row,
		size_t	col
	)

pure virtual

find method to get the index of API::Boolean value cell in a table workspace

Implemented in Mantid::DataObjects::TableWorkspace, Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, and TableWorkspaceTester.

◆ find() [2/6]

virtual void Mantid::API::ITableWorkspace::find	(	const Mantid::Kernel::V3D &	value,
		size_t &	row,
		size_t	col
	)

pure virtual

find method to get the index of Mantid::Kernel::V3D cell value in a table workspace

Implemented in Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, TableWorkspaceTester, and Mantid::DataObjects::TableWorkspace.

◆ find() [3/6]

virtual void Mantid::API::ITableWorkspace::find	(	const std::string &	value,
		size_t &	row,
		size_t	col
	)

pure virtual

find method to get the index of cellstd::string value in a table workspace

Implemented in Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, TableWorkspaceTester, and Mantid::DataObjects::TableWorkspace.

◆ find() [4/6]

virtual void Mantid::API::ITableWorkspace::find	(	double	value,
		size_t &	row,
		size_t	col
	)

pure virtual

find method to get the index of double cell value in a table workspace

Implemented in Mantid::DataObjects::TableWorkspace, Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, and TableWorkspaceTester.

◆ find() [5/6]

virtual void Mantid::API::ITableWorkspace::find	(	float	value,
		size_t &	row,
		size_t	col
	)

pure virtual

find method to get the index of float cell value in a table workspace

Implemented in Mantid::DataObjects::TableWorkspace, Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, and TableWorkspaceTester.

◆ find() [6/6]

virtual void Mantid::API::ITableWorkspace::find	(	size_t	value,
		size_t &	row,
		size_t	col
	)

pure virtual

find method to get the index of integer cell value in a table workspace

Implemented in Mantid::DataObjects::TableWorkspace, Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, and TableWorkspaceTester.

◆ getColumn() [1/4]

virtual Column_const_sptr Mantid::API::ITableWorkspace::getColumn ( const std::string & name ) const

pure virtual

Gets the shared pointer to a column by name.

Implemented in TableWorkspaceTester, Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, and Mantid::DataObjects::TableWorkspace.

◆ getColumn() [2/4]

virtual Column_sptr Mantid::API::ITableWorkspace::getColumn ( const std::string & name )

pure virtual

Gets the shared pointer to a column by name.

Implemented in TableWorkspaceTester, Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, and Mantid::DataObjects::TableWorkspace.

Referenced by Mantid::DataObjects::MementoTableWorkspace::isMementoWorkspace(), Mantid::API::Projection::Projection(), ITableWorkspacePickleSuite::readData(), Mantid::API::TableRow::TableRow(), MantidQt::MantidWidgets::FunctionBrowser::updateMultiDatasetParameters(), MantidQt::MantidWidgets::FunctionModel::updateMultiDatasetParameters(), and ITableWorkspacePickleSuite::writeMetaData().

◆ getColumn() [3/4]

virtual Column_const_sptr Mantid::API::ITableWorkspace::getColumn ( size_t index ) const

pure virtual

Gets the shared pointer to a column by index - return none-modifyable column.

Implemented in Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, Mantid::DataObjects::TableWorkspace, and TableWorkspaceTester.

◆ getColumn() [4/4]

virtual Column_sptr Mantid::API::ITableWorkspace::getColumn ( size_t index )

pure virtual

Gets the shared pointer to a column by index.

Implemented in Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, Mantid::DataObjects::TableWorkspace, and TableWorkspaceTester.

◆ getColumnNames()

virtual std::vector< std::string > Mantid::API::ITableWorkspace::getColumnNames ( ) const

pure virtual

Returns a vector of all column names.

Implemented in Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, Mantid::DataObjects::TableWorkspace, and TableWorkspaceTester.

Referenced by export_ITableWorkspace(), ITableWorkspacePickleSuite::readData(), toDict(), MantidQt::CustomDialogs::SortTableWorkspaceDialog::workspaceChanged(), and ITableWorkspacePickleSuite::writeMetaData().

◆ getFirstRow()

TableRowHelper Mantid::API::ITableWorkspace::getFirstRow ( )

inline

Creates a TableRow object for the first row (row == 0).

Definition at line 266 of file ITableWorkspace.h.

◆ getLogs()

virtual API::LogManager_const_sptr Mantid::API::ITableWorkspace::getLogs ( ) const

pure virtual

Get constant access to shared pointer containing workspace properties.

Implemented in Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, Mantid::DataObjects::TableWorkspace, and TableWorkspaceTester.

◆ getRef()

template<class T >

T & Mantid::API::ITableWorkspace::getRef	(	const std::string &	name,
		size_t	index
	)

inline

Get a reference to a data element.

Parameters

name	:: Column name.
index	:: Element's opsition in the column.

Template Parameters

T	Type of the data in the column. If it doesn't match the actual type a runtime_error exception is thrown.

Returns: the reference to the data element

Definition at line 191 of file ITableWorkspace.h.

References index, and name.

◆ getRow()

TableRowHelper Mantid::API::ITableWorkspace::getRow ( size_t row )

inline

Creates a TableRow object for row row.

Parameters

row	:: Row number

Returns: the requested row

Definition at line 263 of file ITableWorkspace.h.

Referenced by appendRow(), and Mantid::DataObjects::SplittersWorkspace::getSplitter().

◆ getVector() [1/2]

TableColumnHelper Mantid::API::ITableWorkspace::getVector ( const std::string & name )

Access the column with name name trough a ColumnVector object.

Parameters

name	:: The name of the column

Returns: The named column

Definition at line 56 of file ITableWorkspace.cpp.

References name.

◆ getVector() [2/2]

TableConstColumnHelper Mantid::API::ITableWorkspace::getVector ( const std::string & name ) const

Access the column with name name trough a ColumnVector object.

Access the column with name name trough a ColumnVector object (const)

Parameters

name	:: The name of the column

Returns: The named column

Definition at line 63 of file ITableWorkspace.cpp.

References name.

◆ id()

const std::string Mantid::API::ITableWorkspace::id ( ) const

inlineoverridevirtual

Return the workspace typeID.

Implements Mantid::Kernel::DataItem.

Reimplemented in Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, Mantid::DataObjects::SplittersWorkspace, Mantid::DataObjects::TableWorkspace, and TableWorkspaceTester.

Definition at line 116 of file ITableWorkspace.h.

Referenced by toString().

◆ insertInColumn()

void Mantid::API::ITableWorkspace::insertInColumn	(	Column *	c,
		size_t	index
	)

inlineprotected

Insert a new element into a column.

Parameters

c	:: Pointer to the column
index	:: Index in the column before which a new element wil be inserted.

Definition at line 301 of file ITableWorkspace.h.

References index, and Mantid::API::Column::insert().

Referenced by Mantid::DataObjects::TableWorkspace::insertRow().

◆ insertRow()

virtual size_t Mantid::API::ITableWorkspace::insertRow ( size_t index )

pure virtual

Inserts a row before row pointed to by index and fills it with default vales.

Implemented in Mantid::DataObjects::TableWorkspace, Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, and TableWorkspaceTester.

Referenced by appendRow().

◆ Int()

int & Mantid::API::ITableWorkspace::Int	(	size_t	row,
		size_t	col
	)

inline

Get the reference to the element in row row and column col if its type is int.

If it doesn't match the actual type of the column a runtime_error exception is thrown.

Parameters

row	:: Row number
col	:: Column number

Returns: the reference of a requested cell if it's an integer

Definition at line 230 of file ITableWorkspace.h.

◆ logs()

virtual API::LogManager_sptr Mantid::API::ITableWorkspace::logs ( )

pure virtual

Get access to shared pointer containing workspace properties.

Implemented in Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, Mantid::DataObjects::TableWorkspace, and TableWorkspaceTester.

◆ modified()

void Mantid::API::ITableWorkspace::modified ( )

If the workspace is the AnalysisDataService sends AfterReplaceNotification.

Definition at line 70 of file ITableWorkspace.cpp.

References Mantid::API::Workspace::getName().

Referenced by Mantid::DataObjects::TableWorkspace::addColumn(), Mantid::DataObjects::TableWorkspace::addColumn(), Mantid::DataObjects::TableWorkspace::insertRow(), Mantid::DataObjects::TableWorkspace::removeColumn(), Mantid::DataObjects::TableWorkspace::removeRow(), and Mantid::DataObjects::TableWorkspace::sort().

◆ operator=()

ITableWorkspace & Mantid::API::ITableWorkspace::operator= ( const ITableWorkspace & )

delete

◆ removeColumn()

virtual void Mantid::API::ITableWorkspace::removeColumn ( const std::string & name )

pure virtual

Removes a column.

Implemented in Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, TableWorkspaceTester, and Mantid::DataObjects::TableWorkspace.

Referenced by export_ITableWorkspace().

◆ removeFromColumn()

void Mantid::API::ITableWorkspace::removeFromColumn	(	Column *	c,
		size_t	index
	)

inlineprotected

Remove an element from a column.

Parameters

c	:: Pointer to the column
index	:: Index of the element to be removed.

Definition at line 307 of file ITableWorkspace.h.

References index, and Mantid::API::Column::remove().

Referenced by Mantid::DataObjects::TableWorkspace::removeRow().

◆ removeRow()

virtual void Mantid::API::ITableWorkspace::removeRow ( size_t index )

pure virtual

Delets a row if it exists.

Implemented in Mantid::DataObjects::TableWorkspace, Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, and TableWorkspaceTester.

◆ resizeColumn()

void Mantid::API::ITableWorkspace::resizeColumn	(	Column *	c,
		size_t	size
	)

inlineprotected

Resize a column.

Parameters

c	:: Pointer to the column
size	:: New column size

Definition at line 294 of file ITableWorkspace.h.

References Mantid::API::Column::resize().

Referenced by Mantid::DataObjects::TableWorkspace::addColumn(), and Mantid::DataObjects::TableWorkspace::setRowCount().

◆ rowCount()

virtual size_t Mantid::API::ITableWorkspace::rowCount ( ) const

pure virtual

Number of rows in the workspace.

Implemented in Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, Mantid::DataObjects::TableWorkspace, and TableWorkspaceTester.

Referenced by appendRow(), export_ITableWorkspace(), Mantid::API::Projection::Projection(), toString(), MantidQt::MantidWidgets::FunctionBrowser::updateMultiDatasetParameters(), and MantidQt::MantidWidgets::FunctionModel::updateMultiDatasetParameters().

◆ setRowCount()

virtual void Mantid::API::ITableWorkspace::setRowCount ( size_t count )

pure virtual

Resizes the workspace.

Implemented in Mantid::DataObjects::TableWorkspace, Mantid::DataObjects::LeanElasticPeaksWorkspace, Mantid::DataObjects::PeaksWorkspace, and TableWorkspaceTester.

Referenced by export_ITableWorkspace().

◆ sort()

void Mantid::API::ITableWorkspace::sort ( std::vector< std::pair< std::string, bool > > & criteria )

virtual

Overridable method to custom-sort the workspace.

Parameters

criteria : a vector with a list of pairs: column name, bool; where bool = true for ascending, false for descending sort. The peaks are sorted by the first criterion first, then the 2nd if equal, etc.

Exceptions

std::runtime_error unless overridden

Reimplemented in Mantid::DataObjects::TableWorkspace.

Definition at line 91 of file ITableWorkspace.cpp.

References UNUSED_ARG.

◆ String()

std::string & Mantid::API::ITableWorkspace::String	(	size_t	row,
		size_t	col
	)

inline

Get the reference to the element in row row and column col if its type is std::string.

If it doesn't match the actual type of the column a runtime_error exception is thrown.

Parameters

row	:: Row number
col	:: Column number

Returns: the reference of a requested cell if it's a string

Definition at line 257 of file ITableWorkspace.h.

◆ toString()

const std::string Mantid::API::ITableWorkspace::toString ( ) const

overridevirtual

Serializes the object to a string.

Implements Mantid::Kernel::DataItem.

Definition at line 20 of file ITableWorkspace.cpp.

References columnCount(), Mantid::API::Workspace::getMemorySizeAsStr(), id(), rowCount(), and std::to_string().

Referenced by Mantid::API::IPeaksWorkspace::toString().

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

Framework/API/inc/MantidAPI/ITableWorkspace.h
Framework/API/src/ITableWorkspace.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ITableWorkspace() [1/2]

◆ ITableWorkspace() [2/2]

Member Function Documentation

◆ addColumn()

◆ addColumns()

◆ appendRow()

◆ Bool()

◆ cell()

◆ clone()

◆ cloneColumns()

◆ cloneEmpty()

◆ columnCount()

◆ customSort()

◆ doClone()

◆ doCloneColumns()

◆ doCloneEmpty()

◆ Double()

◆ find() [1/6]

◆ find() [2/6]

◆ find() [3/6]

◆ find() [4/6]

◆ find() [5/6]

◆ find() [6/6]

◆ getColumn() [1/4]

◆ getColumn() [2/4]

◆ getColumn() [3/4]

◆ getColumn() [4/4]

◆ getColumnNames()

◆ getFirstRow()

◆ getLogs()

◆ getRef()

◆ getRow()

◆ getVector() [1/2]

◆ getVector() [2/2]

◆ id()

◆ insertInColumn()

◆ insertRow()

◆ Int()

◆ logs()

◆ modified()

◆ operator=()

◆ removeColumn()

◆ removeFromColumn()

◆ removeRow()

◆ resizeColumn()

◆ rowCount()

◆ setRowCount()

◆ sort()

◆ String()

◆ toString()