libCZI
Reading and Writing CZI documents made easy
Loading...
Searching...
No Matches
libCZI::PrepareMetadataInfo Struct Reference

Information which is used to construct the metadata-preparation. More...

#include <libCZI_Write.h>

Public Attributes

std::function< std::tuple< std::string, std::tuple< bool, std::string > >(int)> funcGenerateIdAndNameForChannel
 

Detailed Description

Information which is used to construct the metadata-preparation.

Member Data Documentation

◆ funcGenerateIdAndNameForChannel

std::function<std::tuple<std::string, std::tuple<bool, std::string> >(int)> libCZI::PrepareMetadataInfo::funcGenerateIdAndNameForChannel

This function is called to generate the values for the attributes "Id" and "Name" for the channels. The argument is the channel-Index, and the return-value is a tuple with the Id-value as first item, and the Name-value as second item. The Id is mandatory (and it must be unique), the Name is optional. The boolean in the tuple of the second item indicates whether the "Name"-attribute is to be written. If no function is given, a default Id is constructed as "Channel:<channel-index>". The strings are expected in UTF-8 encoding.


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