bioformats  5.1.2
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | Static Private Attributes | List of all members
ome::xml::model::enums::Compression Class Reference

Compression enumeration. More...

#include <ome/xml/model/enums/Compression.h>

+ Collaboration diagram for ome::xml::model::enums::Compression:

Public Types

enum  enum_value { ZLIB, BZIP2, NONE }
 Enumeration values. More...
 
typedef std::map< std::string, Compression::enum_valuestring_map_type
 String map type.
 
typedef std::map< Compression::enum_value, std::string > value_map_type
 Value map type.
 

Public Member Functions

 Compression (enum_value value)
 Construct a Compression enumeration by an enumeration value. More...
 
 Compression (const std::string &name, bool strict=true)
 Construct a Compression enumeration by an enumeration name. More...
 
 Compression (const Compression &original)
 Copy constructor. More...
 
Compressionoperator= (const Compression &rhs)
 Assignment operator.
 
 operator enum_value () const
 Cast the enumeration to its value. More...
 
 operator const std::string & () const
 Cast the enumeration to its name. More...
 

Static Public Member Functions

static const string_map_typestrings ()
 Get a map of valid string names and enum values. More...
 
static const value_map_typevalues ()
 Get a map of valid enum values and string names. More...
 

Private Attributes

enum_value value
 Enumeration value.
 
const std::string * name
 Enumeration name.
 

Static Private Attributes

static const string_map_type string_map
 Mapping of enumeration name to value.
 
static const string_map_type lowercase_string_map
 Mapping of lowercase enumeration name to value.
 
static const value_map_type value_map
 Mapping of enumeration value to name.
 

Detailed Description

Compression enumeration.

Member Enumeration Documentation

Enumeration values.

Enumerator
ZLIB 

zlib

BZIP2 

bzip2

NONE 

none

Constructor & Destructor Documentation

ome::xml::model::enums::Compression::Compression ( enum_value  value)

Construct a Compression enumeration by an enumeration value.

Parameters
valuethe value of the enumeration.

References name, and value_map.

ome::xml::model::enums::Compression::Compression ( const std::string &  name,
bool  strict = true 
)

Construct a Compression enumeration by an enumeration name.

Exact matching of the name will require the name to match one of the valid enumeration names. Inexact matching will strip leading and trailing whitespace and perform a case-insensitive match. Exact matching is recommended for use in program code which does not process user input; inexact matching is recommended when processing potentially malformed user input.

Parameters
namethe name of the enumeration.
stricttrue to require an exact name, false to allow an inexact match.

References lowercase_string_map, string_map, ome::common::trim(), value, and value_map.

ome::xml::model::enums::Compression::Compression ( const Compression original)

Copy constructor.

Parameters
originalthe instance to copy.

Member Function Documentation

ome::xml::model::enums::Compression::operator const std::string & ( ) const
inline

Cast the enumeration to its name.

Returns
the enumeration value.

References name.

ome::xml::model::enums::Compression::operator enum_value ( ) const
inline

Cast the enumeration to its value.

Returns
the enumeration value.

References value.

const Compression::string_map_type & ome::xml::model::enums::Compression::strings ( )
static

Get a map of valid string names and enum values.

Returns
a map of string names to enum values.

References string_map.

const Compression::value_map_type & ome::xml::model::enums::Compression::values ( )
static

Get a map of valid enum values and string names.

Returns
a map of enum values to string names.

References value_map.


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