Class IDimCoordinate

• Defined in File libCZI_DimCoordinate.h

Inheritance Relationships

Derived Type

• public libCZI::CDimCoordinate (Class CDimCoordinate)

Class Documentation

class IDimCoordinate

Interface used to represent a coordinate (in the space of the dimensions identified by DimensionIndex).

Subclassed by libCZI::CDimCoordinate

Public Functions

virtual bool TryGetPosition(DimensionIndex dim, int *coordinate) const = 0

Attempts to get position index in the specified dimension.

Parameters:

• dim – The dimension.

• coordinate – [out] If non-null and the dimension is valid (in this coordinate), it will receive the value of the coordinate for the specified dimension.

Returns:

True if it succeeds (i. e. the specified dimension is given in this coordinate), false otherwise.

virtual ~IDimCoordinate() = default

inline bool IsValid(DimensionIndex dim) const

Query if the specified dimension is given (‘is valid’) in this coordinate.

Parameters:

dim – The dimension.

Returns:

True if the dimension is valid for this coordinate, false if not.

inline int GetNumberOfValidDimensions() const

Gets the number of valid dimensions.

Returns:

The number of valid dimensions.