libCZI::IDimBounds Class Reference

Interface used to represent an interval (for several dimensions). More...

#include <libCZI_DimCoordinate.h>

Inheritance diagram for libCZI::IDimBounds:

Public Member Functions
virtual bool	TryGetInterval (DimensionIndex dim, int *startIndex, int *size) const =0
bool	IsValid (DimensionIndex dim) const

Detailed Description

Interface used to represent an interval (for several dimensions).

Member Function Documentation

IsValid()

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

inline

Query if the specified dimension is valid.

Parameters

dim	The dimension.

Returns

True if valid, false otherwise.

TryGetInterval()

virtual bool libCZI::IDimBounds::TryGetInterval ( DimensionIndex  dim, int *  startIndex, int *  size  ) const

pure virtual

Attempts to get the interval for the specified dimension.

Parameters

	dim	The dimension.
[in,out]	startIndex	If non-null, it will receive the start index.
[in,out]	size	If non-null, it will receive the size.

Returns

True if the dimension is valid and the data was succeessfully retrieved, false if it fails.

Implemented in libCZI::CDimBounds.

---

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

• libCZI/libCZI_DimCoordinate.h