#include <FakeObjects.h>

Inheritance diagram for ColumnTester:

Protected Member Functions
void	insert (size_t) override
	Inserts an item.

void	remove (size_t) override
	Removes an item.

void	resize (size_t) override
	Sets the new column size.

const void *	void_pointer (size_t) const override
	Pointer to a data element.

void *	void_pointer (size_t) override
	Pointer to a data element.

Protected Member Functions inherited from Mantid::API::Column
bool	possibleToCompare (const Column &otherColumn) const

Private Member Functions
Column *	clone () const override
	Virtual constructor. Fully clone any column.

void	fromDouble (size_t, double) override
	Assign an element from double if possible.

std::type_info &	get_pointer_type_info () const override
	Returns typeid for the pointer type to the data element in the column.

std::type_info &	get_type_info () const override
	Returns typeid for the data in the column.

bool	isBool () const override
	Specialized type check.

bool	isNumber () const override
	Are elements of the column interpretable as a number?

void	print (size_t, std::ostream &) const override
	Prints out the value to a stream.

size_t	size () const override
	Number of individual elements in the column.

long int	sizeOfData () const override
	Must return overall memory size taken by the column.

double	toDouble (size_t) const override
	Cast an element to double if possible.

Additional Inherited Members
Public Member Functions inherited from Mantid::API::Column
template<class T >
T &	cell (size_t index)
	Templated method for returning a value. No type checks are done.

template<class T >
const T &	cell (size_t index) const
	Templated method for returning a value (const version).

	Column ()

virtual bool	equals (const Column &, double, bool const =false) const

virtual bool	equalsRelErr (const Column &, double, bool const =false) const

int	getLinkedYCol () const

int	getPlotType () const
	get plot type

virtual bool	getReadOnly () const
	Returns column read-only flag.

template<class T >
bool	isType () const
	Type check.

template<>
bool	isType () const

const std::string &	name () const
	Name (caption) of the column.

template<class T = double>
std::vector< T >	numeric_fill (size_t maxSize=std::numeric_limits< size_t >::max()) const
	Fills a std vector with values from the column if the types are compatible.

virtual double	operator[] (size_t i) const
	return value casted to double (should be pure virtual)

virtual void	read (const size_t index, std::istringstream &in)
	Read in from stream and set the value at the given index.

virtual void	read (size_t index, const std::string &text)
	Read in a string and set the value at the given index.

void	setLinkedYCol (const int yCol)

void	setName (const std::string &str)
	Renames the column.

void	setPlotType (int t)
	Set plot type where.

void	setReadOnly (bool isReadOnly)
	Sets column read-only flag.

virtual void	sortIndex (bool ascending, size_t start, size_t end, std::vector< size_t > &indexVec, std::vector< std::pair< size_t, size_t > > &equalRanges) const
	Sort all or part of a vector of indices according to values in corresponding cells of this column.

virtual void	sortValues (const std::vector< size_t > &indexVec)
	Re-arrange values in this column according to indices in indexVec.

const std::string &	type () const
	Type of the column data.

virtual	~Column ()=default
	Virtual destructor.

Protected Attributes inherited from Mantid::API::Column
bool	m_isReadOnly
	Column read-only flag.

int	m_linkedYCol = -1
	For error columns - the index of the related data column.

std::string	m_name
	name

int	m_plotType
	plot type where None = 0 (means it has specifically been set to 'no plot type') NotSet = -1000 (this is the default and means plot style has not been set) X = 1, Y = 2, Z = 3, xErr = 4, yErr = 5, Label = 6

std::string	m_type
	type

Detailed Description

Definition at line 331 of file FakeObjects.h.

Member Function Documentation

◆ clone()

Column * ColumnTester::clone ( ) const

inlineoverrideprivatevirtual

Virtual constructor. Fully clone any column.

Implements Mantid::API::Column.

Definition at line 348 of file FakeObjects.h.

◆ fromDouble()

void ColumnTester::fromDouble	(	size_t	index,
		double	value
	)

inlineoverrideprivatevirtual

Assign an element from double if possible.

Implements Mantid::API::Column.

Definition at line 352 of file FakeObjects.h.

◆ get_pointer_type_info()

std::type_info & ColumnTester::get_pointer_type_info ( ) const

inlineoverrideprivatevirtual

Returns typeid for the pointer type to the data element in the column.

Implements Mantid::API::Column.

Definition at line 336 of file FakeObjects.h.

◆ get_type_info()

std::type_info & ColumnTester::get_type_info ( ) const

inlineoverrideprivatevirtual

Returns typeid for the data in the column.

Implements Mantid::API::Column.

Definition at line 334 of file FakeObjects.h.

◆ insert()

void ColumnTester::insert ( size_t index )

inlineoverrideprotectedvirtual

Inserts an item.

Implements Mantid::API::Column.

Definition at line 356 of file FakeObjects.h.

◆ isBool()

bool ColumnTester::isBool ( ) const

inlineoverrideprivatevirtual

Specialized type check.

Implements Mantid::API::Column.

Definition at line 342 of file FakeObjects.h.

◆ isNumber()

bool ColumnTester::isNumber ( ) const

inlineoverrideprivatevirtual

Are elements of the column interpretable as a number?

Implements Mantid::API::Column.

Definition at line 344 of file FakeObjects.h.

◆ print()

void ColumnTester::print	(	size_t	index,
		std::ostream &	s
	)		const

inlineoverrideprivatevirtual

Prints out the value to a stream.

Implements Mantid::API::Column.

Definition at line 340 of file FakeObjects.h.

◆ remove()

void ColumnTester::remove ( size_t index )

inlineoverrideprotectedvirtual

Removes an item.

Implements Mantid::API::Column.

Definition at line 357 of file FakeObjects.h.

◆ resize()

void ColumnTester::resize ( size_t count )

inlineoverrideprotectedvirtual

Sets the new column size.

Implements Mantid::API::Column.

Definition at line 355 of file FakeObjects.h.

◆ size()

size_t ColumnTester::size ( ) const

inlineoverrideprivatevirtual

Number of individual elements in the column.

Implements Mantid::API::Column.

Definition at line 332 of file FakeObjects.h.

◆ sizeOfData()

long int ColumnTester::sizeOfData ( ) const

inlineoverrideprivatevirtual

Must return overall memory size taken by the column.

Implements Mantid::API::Column.

Definition at line 346 of file FakeObjects.h.

◆ toDouble()

double ColumnTester::toDouble ( size_t index ) const

inlineoverrideprivatevirtual

Cast an element to double if possible.

Implements Mantid::API::Column.

Definition at line 350 of file FakeObjects.h.

◆ void_pointer() [1/2]

const void * ColumnTester::void_pointer ( size_t index ) const

inlineoverrideprotectedvirtual

Pointer to a data element.

Implements Mantid::API::Column.

Definition at line 359 of file FakeObjects.h.

◆ void_pointer() [2/2]

void * ColumnTester::void_pointer ( size_t index )

inlineoverrideprotectedvirtual

Pointer to a data element.

Implements Mantid::API::Column.

Definition at line 358 of file FakeObjects.h.

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

Framework/TestHelpers/inc/MantidFrameworkTestHelpers/FakeObjects.h

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ fromDouble()

◆ get_pointer_type_info()

◆ get_type_info()

◆ insert()

◆ isBool()

◆ isNumber()

◆ print()

◆ remove()

◆ resize()

◆ size()

◆ sizeOfData()

◆ toDouble()

◆ void_pointer() [1/2]

◆ void_pointer() [2/2]