libCZI
Reading CZI documents made easy
libCZI::ICziMultiDimensionDocumentInfo Class Referenceabstract

The top-level interface for the CZI-metadata object. More...

#include <libCZI_Metadata.h>

Public Member Functions

virtual GeneralDocumentInfo GetGeneralDocumentInfo () const =0
 
virtual libCZI::ScalingInfo GetScalingInfo () const =0
 
virtual void EnumDimensions (std::function< bool(DimensionIndex)> enumDimensions)=0
 
virtual std::shared_ptr< IDimensionInfoGetDimensionInfo (DimensionIndex dim)=0
 
virtual std::shared_ptr< IDisplaySettingsGetDisplaySettings () const =0
 
std::vector< DimensionIndexGetDimensions ()
 

Detailed Description

The top-level interface for the CZI-metadata object.

Member Function Documentation

◆ EnumDimensions()

virtual void libCZI::ICziMultiDimensionDocumentInfo::EnumDimensions ( std::function< bool(DimensionIndex)>  enumDimensions)
pure virtual

Enumerate the dimensions (defined in the metadata). /remark Not yet implemented.

Parameters
enumDimensionsThe functor which will be called for each dimension. If the functor returns false, the enumeration is cancelled.

◆ GetDimensionInfo()

virtual std::shared_ptr<IDimensionInfo> libCZI::ICziMultiDimensionDocumentInfo::GetDimensionInfo ( DimensionIndex  dim)
pure virtual

Gets the dimension information for the specified dimension. /remark Not yet implemented.

Parameters
dimThe dimension to retrieve the information for.
Returns
The dimension information if available.

◆ GetDimensions()

std::vector<DimensionIndex> libCZI::ICziMultiDimensionDocumentInfo::GetDimensions ( )
inline

Gets a vector with all dimensions (found in metadata).

Returns
The vector containing all dimensions.

◆ GetDisplaySettings()

virtual std::shared_ptr<IDisplaySettings> libCZI::ICziMultiDimensionDocumentInfo::GetDisplaySettings ( ) const
pure virtual

Gets the display settings.

Remarks
This method may return an empty shared_ptr in case that display-settings are not present in the metadata.
Returns
The display settings object.

◆ GetGeneralDocumentInfo()

virtual GeneralDocumentInfo libCZI::ICziMultiDimensionDocumentInfo::GetGeneralDocumentInfo ( ) const
pure virtual

Gets "general document information".

Returns
The "general document information".

◆ GetScalingInfo()

virtual libCZI::ScalingInfo libCZI::ICziMultiDimensionDocumentInfo::GetScalingInfo ( ) const
pure virtual

Gets "scaling information".

Returns
The "scaling information".

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