bioformats  5.1.6
Public Types | Public Member Functions | Private Attributes | List of all members
ome::bioformats::MetadataOptions Class Reference

Metadata options. More...

#include <ome/bioformats/MetadataOptions.h>

Public Types

enum  MetadataLevel { METADATA_MINIMUM, METADATA_NO_OVERLAYS, METADATA_ALL }
 Amount of metadata to store. More...
 

Public Member Functions

 MetadataOptions ()
 Constructor. More...
 
 MetadataOptions (MetadataLevel level)
 Constructor. More...
 
virtual ~MetadataOptions ()
 Destructor.
 
MetadataLevel getMetadataLevel () const
 Get the metadata level. More...
 
void setMetadataLevel (MetadataLevel level)
 Set the metadata level. More...
 

Private Attributes

MetadataLevel level
 Amount of metadata to store.
 

Detailed Description

Metadata options.

Member Enumeration Documentation

Amount of metadata to store.

Enumerator
METADATA_MINIMUM 

Store a minimal amount of metadata.

METADATA_NO_OVERLAYS 

Store all metadata except overlays.

METADATA_ALL 

Store all metadata.

Constructor & Destructor Documentation

ome::bioformats::MetadataOptions::MetadataOptions ( )

Constructor.

Default to storing all metadata.

ome::bioformats::MetadataOptions::MetadataOptions ( MetadataLevel  level)

Constructor.

Parameters
levelthe amount of metadata to store.

Member Function Documentation

MetadataOptions::MetadataLevel ome::bioformats::MetadataOptions::getMetadataLevel ( ) const

Get the metadata level.

Returns
the metadata level.

References level.

void ome::bioformats::MetadataOptions::setMetadataLevel ( MetadataLevel  level)

Set the metadata level.

Parameters
levelthe metadata level to set.

References level.


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