libCZI::IDimensionInfo Class Reference

Base class for information about the dimension. More...

#include <libCZI_Metadata.h>

Public Member Functions
virtual DimensionIndex	GetDimension () const =0
virtual void	GetInterval (int *start, int *end) const =0
virtual void	GetIntervalIsExplicitlyStated (bool *startExplicitlyStated, bool *endExplicitlyStated) const =0

Detailed Description

Base class for information about the dimension.

Member Function Documentation

GetDimension()

virtual DimensionIndex libCZI::IDimensionInfo::GetDimension ( ) const

pure virtual

Gets the dimension index.

Returns

The dimension index.

GetInterval()

virtual void libCZI::IDimensionInfo::GetInterval ( int *  start, int *  end  ) const

pure virtual

Gets the interval.

Parameters

[out]	start	If non-null, it will receive the start index.
[out]	end	If non-null, it will receive the end index.

GetIntervalIsExplicitlyStated()

virtual void libCZI::IDimensionInfo::GetIntervalIsExplicitlyStated ( bool *  startExplicitlyStated, bool *  endExplicitlyStated  ) const

pure virtual

Gets information whether the start or end was explicit stated in the XML-metadata. If not explicitly stated, then default values are reported - i.e. 0 for start, and 1 for size.

Parameters

[out]	startExplicitlyStated	If non-null, a flag indicating whether 'start' is explicitly stated is put here.
[out]	endExplicitlyStated	If non-null, a flag indicating whether 'end' is explicitly stated is put here.

---

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

• libCZI/libCZI_Metadata.h