libCZI::IDimensionTInfo Class Reference

This structure defines the information for the "T-dimension". It resembles the ZEN-metadata-structure "Dimensions/T". More...

#include <libCZI_Metadata.h>

Public Member Functions
virtual bool	TryGetStartTime (XmlDateTime *dateTime)=0
virtual bool	TryGetIntervalDefinition (double *offset, double *increment)=0
virtual bool	TryGetOffsetsList (std::vector< double > *offsets)=0

Detailed Description

This structure defines the information for the "T-dimension". It resembles the ZEN-metadata-structure "Dimensions/T".

Member Function Documentation

TryGetIntervalDefinition()

virtual bool libCZI::IDimensionTInfo::TryGetIntervalDefinition ( double *  offset, double *  increment  )

pure virtual

Attempts to get interval definition which allows to associate a time span with a t-index.

Parameters

[in,out]	offset	If non-null, the offset will be put here (unit: second).
[in,out]	increment	If non-null, the increment will be put here (unit: second).

Returns

True if it succeeds, false if it fails.

TryGetOffsetsList()

virtual bool libCZI::IDimensionTInfo::TryGetOffsetsList ( std::vector< double > *  offsets )

pure virtual

Attempts to get the offset list.

Parameters

[in,out]

offsets

If non-null, the offsets will be put here (unit: second).

Returns

True if it succeeds, false if it fails.

TryGetStartTime()

virtual bool libCZI::IDimensionTInfo::TryGetStartTime ( XmlDateTime *  dateTime )

pure virtual

Attempts to get start time - an absolute point in time which gives the reference point (to which to relative time spans refer to).

Parameters

[in,out]

dateTime

If non-null, the reference date time.

Returns

True if it succeeds, false if it fails.

---

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

• libCZI/libCZI_Metadata.h