ArrayNdDimensionLabels Class Reference

Represents a set of dimension labels in an ArrayNd. More...

#include <DataAnalysis/DataStructures/arraynddimensionlabels.h>

Public Member Functions
	ArrayNdDimensionLabels ()
	ArrayNdDimensionLabels (const ArrayNdDimensionLabels &)
	ArrayNdDimensionLabels (const QString &dimName)
	~ArrayNdDimensionLabels ()
ArrayNd &	getLabelData ()
const ArrayNd &	getLabelData () const
ArrayNdDimensionLabels	getSubset (int first, int last)
int	numLabels () const
bool	operator!= (const ArrayNdDimensionLabels &rhs) const
ArrayNdDimensionLabels &	operator= (const ArrayNdDimensionLabels &)
bool	operator== (const ArrayNdDimensionLabels &rhs) const
QVariant	operator[] (int index) const
bool	setLabelData (ArrayNd &labelData)
bool	setLabelData (const QStringList &strings)
QStringList	toStringList () const
QVariantList	toVariantList () const

Detailed Description

Internally, the data is represented as an ArrayNd itself containing either one or two dimensions (two dimensions in the case of char data representing strings).

Constructor & Destructor Documentation

ArrayNdDimensionLabels() [1/3]

ArrayNdDimensionLabels

(

)

ArrayNdDimensionLabels() [2/3]

ArrayNdDimensionLabels

(

const QString &

dimName

)

ArrayNdDimensionLabels() [3/3]

ArrayNdDimensionLabels

(

const ArrayNdDimensionLabels &

other

)

~ArrayNdDimensionLabels()

~ArrayNdDimensionLabels

(

)

Member Function Documentation

getLabelData() [1/2]

ArrayNd & getLabelData

(

)

getLabelData() [2/2]

const ArrayNd & getLabelData

(

)

const

getSubset()

ArrayNdDimensionLabels getSubset	(	int	first,
		int	last
	)

Parameters

first	The index of the first label to include in the subset
last	The index of the last label to include in the subset

Returns

An ArrayNdDimensionLabels object containing the subset of the label data that was requested.

numLabels()

int numLabels

(

)

const

operator!=()

bool operator!= ( const ArrayNdDimensionLabels &  rhs ) const

inline

operator=()

ArrayNdDimensionLabels & operator=

(

const ArrayNdDimensionLabels &

rhs

)

operator==()

bool operator==

(

const ArrayNdDimensionLabels &

rhs

)

const

operator[]()

QVariant operator[]

(

int

index

)

const

Parameters

index

The index of the label to retrieve

Note

Indices are not bounds checked at run time.

setLabelData() [1/2]

bool setLabelData

(

ArrayNd &

data

)

Parameters

data	The data from which labels are to be sourced. The data must take the form of an ArrayNd of a single dimension only, or an ArrayNd of type char with two dimensions; the number of strings, and the length. The ArrayNdDimensionLabels object will take ownership of this data.

Returns

true if the data was set successfully, false otherwise.

setLabelData() [2/2]

bool setLabelData

(

const QStringList &

strings

)

toStringList()

QStringList toStringList

(

)

const

toVariantList()

QVariantList toVariantList

(

)

const