#include <FakeObjects.h>

Inheritance diagram for ColumnTester:

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

void	remove (size_t) override
	Removes an item. More...

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

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

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

Protected Member Functions inherited from Mantid::API::Column
virtual void	insert (size_t index)=0
	Inserts an item. More...

bool	possibleToCompare (const Column &otherColumn) const

virtual void	remove (size_t index)=0
	Removes an item. More...

virtual void	resize (size_t count)=0
	Sets the new column size. More...

virtual const void *	void_pointer (size_t index) const =0
	Pointer to a data element. More...

virtual void *	void_pointer (size_t index)=0
	Pointer to a data element. More...

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

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

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

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

bool	isBool () const override
	Specialized type check. More...

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

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

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

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

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

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. More...

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

virtual Column *	clone () const =0
	Virtual constructor. Fully clone any column. More...

	Column ()

virtual bool	equals (const Column &, double) const

virtual bool	equalsRelErr (const Column &, double) const

virtual void	fromDouble (size_t index, double value)=0
	Assign an element from double if possible. More...

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

virtual const std::type_info &	get_type_info () const =0
	Returns typeid for the data in the column. More...

int	getLinkedYCol () const

int	getPlotType () const
	get plot type More...

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

virtual bool	isBool () const =0
	Specialized type check. More...

virtual bool	isNumber () const =0
	Are elements of the column interpretable as a number? More...

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

template<>
bool	isType () const

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

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. More...

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

virtual void	print (size_t index, std::ostream &s) const =0
	Prints out the value to a stream. More...

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

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

void	setLinkedYCol (const int yCol)

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

void	setPlotType (int t)
	Set plot type where. More...

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

virtual size_t	size () const =0
	Number of individual elements in the column. More...

virtual long int	sizeOfData () const =0
	Must return overall memory size taken by the column. More...

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. More...

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

virtual double	toDouble (size_t index) const =0
	Cast an element to double if possible. More...

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

virtual	~Column ()=default
	Virtual destructor. More...

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

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

std::string	m_name
	name More...

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 More...

std::string	m_type
	type More...

Detailed Description

Definition at line 335 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 352 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 356 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 340 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 338 of file FakeObjects.h.

◆ insert()

void ColumnTester::insert ( size_t index )

inlineoverrideprotectedvirtual

Inserts an item.

Implements Mantid::API::Column.

Definition at line 360 of file FakeObjects.h.

◆ isBool()

bool ColumnTester::isBool ( ) const

inlineoverrideprivatevirtual

Specialized type check.

Implements Mantid::API::Column.

Definition at line 346 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 348 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 344 of file FakeObjects.h.

◆ remove()

void ColumnTester::remove ( size_t index )

inlineoverrideprotectedvirtual

Removes an item.

Implements Mantid::API::Column.

Definition at line 361 of file FakeObjects.h.

◆ resize()

void ColumnTester::resize ( size_t count )

inlineoverrideprotectedvirtual

Sets the new column size.

Implements Mantid::API::Column.

Definition at line 359 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 336 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 350 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 354 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 363 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 362 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]