Class Dimension

• Defined in File Dimensions.hpp

Inheritance Relationships

Base Type

• public nix::base::ImplContainer< base::IDimension > (Template Class ImplContainer)

Class Documentation

class Dimension : public nix::base::ImplContainer<base::IDimension>

Instances of the Dimension subclasses are used to define the different dimensions of data in a DataArray.

The real dimension descriptor are defined in three subclasses: RangeDimension, SampledDimension and SetDimension

Public Functions

Dimension()

Constructor that creates an uninitialized Dimension.

Calling any method on an uninitialized dimension will throw a nix::UninitializedEntity exception. The following code illustrates how to check if a dimension is initialized:

Dimension e = ...;
if (e) {
    // e is initialised
} else {
    // e is uninitialized
}

Dimension(const std::shared_ptr<base::IDimension> &p_impl)

Constructor that creates a new dimension from a shared pointer to an implementation instance.

This constructor should only be used in the back-end.

Dimension(std::shared_ptr<base::IDimension> &&ptr)

Constructor with move semantics that creates a new dimension from a shared pointer to an implementation instance.

This constructor should only be used in the back-end.

Dimension(const Dimension &other)

Copy constructor.

Copying of all NIX front facing objects like Dimension is a rather cheap operation. Semantically this is equivalent to the creation of another reference to the original object.

Parameters

other – The dimension to copy.

Dimension(const SampledDimension &other)

Copy constructor that converts a SampledDimension to Dimension.

Copying of all NIX front facing objects like Dimension is a rather cheap operation. Semantically this is equivalent to the creation of another reference to the original object.

Parameters

other – The dimension to copy.

Dimension(const RangeDimension &other)

Copy constructor that converts a RangeDimension to Dimension.

Copying of all NIX front facing objects like Dimension is a rather cheap operation. Semantically this is equivalent to the creation of another reference to the original object.

Parameters

other – The dimension to copy.

Dimension(const SetDimension &other)

Copy constructor that converts a SetDimension to Dimension.

Copying of all NIX front facing objects like Dimension is a rather cheap operation. Semantically this is equivalent to the creation of another reference to the original object.

Parameters

other – The dimension to copy.

Dimension(const DataFrameDimension &other)

Copy constructor that converts a DataFrameDimension to Dimension.

Copying of all NIX front facing objects like Dimension is a rather cheap operation. Semantically this is equivalent to the creation of another reference to the original object.

Parameters

other – The dimension to copy.

inline ndsize_t index() const

The actual dimension that is described by the dimension descriptor.

The index of the dimension entity representing the dimension of the actual data that is defined by this descriptor.

Returns

The dimension index of the dimension.

inline DimensionType dimensionType() const

The type of the dimension.

This field indicates whether the dimension is a SampledDimension, SetDimension, RangeDimension, or DataFrameDimension..

Returns

The dimension type.

SetDimension asSetDimension() const

SampledDimension asSampledDimension() const

RangeDimension asRangeDimension() const

DataFrameDimension asDataFrameDimension() const

Dimension &operator=(const SampledDimension &other)

Assignment operator that converts a SampledDimension to Dimension.

Parameters

other – The dimension to assign.

Dimension &operator=(const RangeDimension &other)

Assignment operator that converts a RangeDimension to Dimension.

Parameters

other – The dimension to assign.

Dimension &operator=(const SetDimension &other)

Assignment operator that converts a SetDimension to Dimension.

Parameters

other – The dimension to assign.

Dimension &operator=(const DataFrameDimension &other)

Assignment operator that converts a DataFrameDimension to Dimension.

Parameters

other – The dimension to assign.

inline Dimension &operator=(const Dimension &other)

Assignment operator.

inline Dimension &operator=(const none_t &t)

Assignment operator for none.