libCZI::IDimCoordinate Class Reference

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

#include <libCZI_DimCoordinate.h>

Inheritance diagram for libCZI::IDimCoordinate:

Public Member Functions
virtual bool	TryGetPosition (DimensionIndex dim, int *coordinate) const =0
bool	IsValid (DimensionIndex dim) const
int	GetNumberOfValidDimensions () const

Detailed Description

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

Member Function Documentation

GetNumberOfValidDimensions()

int libCZI::IDimCoordinate::GetNumberOfValidDimensions ( ) const

inline

Gets the number of valid dimensions.

Returns

The number of valid dimensions.

IsValid()

bool libCZI::IDimCoordinate::IsValid ( DimensionIndex  dim ) const

inline

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.

TryGetPosition()

virtual bool libCZI::IDimCoordinate::TryGetPosition ( DimensionIndex  dim, int *  coordinate  ) const

pure virtual

Attempts to get position index in the specified dimension.

Parameters

	dim	The dimension.
[out]	coordinate	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.

Implemented in libCZI::CDimCoordinate.

---

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

• libCZI/libCZI_DimCoordinate.h