libCZI
Reading and Writing CZI documents made easy
libCZI::StreamsFactory::StreamClassInfo Struct Reference

This structure gathers information about a stream class. More...

#include <libCZI_StreamsLib.h>

Public Attributes

std::string class_name
 Name of the class (this uniquely identifies the class).
 
std::string short_description
 A short and informal description of the class.
 
std::function< std::string()> get_build_info
 
std::function< Property(const char *property_name)> get_property
 

Detailed Description

This structure gathers information about a stream class.

Member Data Documentation

◆ get_build_info

std::function<std::string()> libCZI::StreamsFactory::StreamClassInfo::get_build_info

A function which returns a string with build information for the class (e.g. version information). Note that this field may be null, in which case no information is available.

◆ get_property

std::function<Property(const char* property_name)> libCZI::StreamsFactory::StreamClassInfo::get_property

A function which returns a class-specific property about the class. This is e.g. intended for providing information about build-time options for a specific class. Currently, it is used for the libcurl-based stream-class to provide information about the build-time configured paths for the CA certificates. Note that this field may be null, in which case no information is available.


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