ome::common Namespace Reference

OME compatibility functions and classes. More...

Namespaces
	xml
	Xerces-C modern C++ wrapper.

Classes
class	boolean
	Boolean type with guaranteed size, alignment and storage values. More...

Typedefs
typedef logging::sources::severity_logger_mt< logging::trivial::severity_level >	Logger
	Message logger.
typedef boost::iostreams::basic_array_source< char >	mstream_source
	Character array stream source.
typedef boost::iostreams::stream< mstream_source >	imstream
	Input memory stream.

Functions
bool	operator== (const boolean &lhs, bool rhs)
	Compare boolean with bool for equality. More...
bool	operator== (bool lhs, const boolean &rhs)
	Compare bool with boolean for equality. More...
bool	operator== (const boolean &lhs, const boolean &rhs)
	Compare boolean with boolean for equality. More...
bool	operator!= (const boolean &lhs, bool rhs)
	Compare boolean with bool for inequality. More...
bool	operator!= (bool lhs, const boolean &rhs)
	Compare bool with boolean for inequality. More...
bool	operator!= (const boolean &lhs, const boolean &rhs)
	Compare bool with boolean for inequality. More...
template<class charT , class traits >
std::basic_ostream< charT, traits > &	operator<< (std::basic_ostream< charT, traits > &os, const boolean &rhs)
	Output boolean to output stream. More...
template<class charT , class traits >
std::basic_istream< charT, traits > &	operator>> (std::basic_istream< charT, traits > &is, boolean &rhs)
	Set boolean from input stream. More...
boost::filesystem::path	absolute (const boost::filesystem::path &p, const boost::filesystem::path &base=boost::filesystem::current_path())
	Get an absolute path. More...
boost::filesystem::path	canonical (const boost::filesystem::path &p, const boost::filesystem::path &base=boost::filesystem::current_path(), boost::system::error_code *ec=0)
	Get a canonical path. More...
boost::filesystem::path	make_relative (boost::filesystem::path from, boost::filesystem::path to)
	Make a relative path. More...
void	setLogLevel (logging::trivial::severity_level severity)
	Set global logging level. More...
logging::trivial::severity_level	getLogLevel ()
	Get global logging level. More...
Logger	createLogger (const std::string &className)
	Create a message logger for a class. More...
fs::path	module_runtime_path (const std::string &dtype)
	Get the runtime installation prefix path for this module. More...
std::string	ltrim (const std::string &str)
	Trim leading whitespace from a string. More...
std::string	rtrim (const std::string &str)
	Trim trailing whitespace from a string. More...
std::string	trim (const std::string &str)
	Trim leading and trailing whitespace from a string. More...

Detailed Description

OME compatibility functions and classes.

Function Documentation

boost::filesystem::path ome::common::absolute ( const boost::filesystem::path &  p, const boost::filesystem::path &  base = boost::filesystem::current_path()  )

inline

Get an absolute path.

Parameters

p	the path to make absolute.
base	the base directory, defaulting to the current path.

Returns

the absolute path.

Referenced by canonical(), and make_relative().

Here is the caller graph for this function:

boost::filesystem::path ome::common::canonical ( const boost::filesystem::path &  p, const boost::filesystem::path &  base = boost::filesystem::current_path(), boost::system::error_code *  ec = 0  )

inline

Get a canonical path.

Parameters

p	the path to make canonical.
base	the base directory, defaulting to the current path.
ec	pointer to storage for an error code (optional).

Returns

the canonical path.

References absolute().

Referenced by ome::bioformats::in::OMETIFFReader::findUsedFiles(), ome::bioformats::detail::FormatReader::getAdvancedSeriesUsedFiles(), ome::bioformats::detail::FormatReader::getAdvancedUsedFiles(), ome::bioformats::in::OMETIFFReader::initFile(), ome::bioformats::detail::FormatReader::isUsedFile(), module_runtime_path(), ome::common::xml::EntityResolver::registerCatalog(), ome::common::xml::EntityResolver::registerEntity(), ome::bioformats::out::OMETIFFWriter::setId(), ome::bioformats::detail::FormatWriter::setId(), and ome::bioformats::detail::FormatReader::setId().

Here is the caller graph for this function:

Logger ome::common::createLogger ( const std::string &  className )

inline

Create a message logger for a class.

Parameters

className

the class name owning the logger.

Returns

a message logger.

Referenced by ome::xml::model::enums::AcquisitionMode::AcquisitionMode(), ome::xml::model::enums::ArcType::ArcType(), ome::xml::model::enums::Binning::Binning(), ome::xml::model::enums::ContrastMethod::ContrastMethod(), ome::xml::model::enums::Correction::Correction(), ome::xml::model::enums::DetectorType::DetectorType(), ome::xml::model::enums::ExperimentType::ExperimentType(), ome::xml::model::enums::FilamentType::FilamentType(), ome::xml::model::enums::FilterType::FilterType(), ome::xml::model::enums::IlluminationType::IlluminationType(), ome::xml::model::enums::Immersion::Immersion(), ome::xml::model::enums::LaserMedium::LaserMedium(), ome::xml::model::enums::LaserType::LaserType(), ome::xml::model::enums::Medium::Medium(), ome::xml::model::enums::MicrobeamManipulationType::MicrobeamManipulationType(), ome::xml::model::enums::MicroscopeType::MicroscopeType(), and ome::xml::model::enums::Pulse::Pulse().

Here is the caller graph for this function:

logging::trivial::severity_level ome::common::getLogLevel

(

)

Get global logging level.

Returns

the log severity.

std::string ome::common::ltrim ( const std::string &  str )

inline

Trim leading whitespace from a string.

Space, newline, carriage return and horizontal and vertical tabs are removed from the left-hand side of the string.

Parameters

str	the string to trim.

Returns

the left-trimmed string.

boost::filesystem::path ome::common::make_relative ( boost::filesystem::path  from, boost::filesystem::path  to  )

inline

Make a relative path.

Parameters

from	the start (reference) path.
to	the end path (to make relative to the start path).

Returns

the relative path.

References absolute().

Referenced by ome::bioformats::out::OMETIFFWriter::fillMetadata(), and ome::bioformats::out::OMETIFFWriter::getOMEXML().

Here is the caller graph for this function:

boost::filesystem::path ome::common::module_runtime_path

(

const std::string &

dtype

)

Get the runtime installation prefix path for this module.

This is intended primarily for internal use, to allow discovery of the location of datafiles, loadable modules, etc.

Parameters

dtype

the directory type to query.

Returns

the installation prefix path.

Exceptions

a	std::runtime_error if the path could not be determined.

References canonical().

Referenced by ome::xml::OMEEntityResolver::OMEEntityResolver().

Here is the caller graph for this function:

bool ome::common::operator!= ( const boolean &  lhs, bool  rhs  )

inline

Compare boolean with bool for inequality.

Parameters

lhs	the first value to compare.
rhs	the second value to compare.

Returns

true if not equal, false if equal.

bool ome::common::operator!= ( bool  lhs, const boolean &  rhs  )

inline

Compare bool with boolean for inequality.

Parameters

lhs	the first value to compare.
rhs	the second value to compare.

Returns

true if not equal, false if equal.

bool ome::common::operator!= ( const boolean &  lhs, const boolean &  rhs  )

inline

Compare bool with boolean for inequality.

Parameters

lhs	the first value to compare.
rhs	the second value to compare.

Returns

true if not equal, false if equal.

template<class charT , class traits >

std::basic_ostream<charT,traits>& ome::common::operator<< ( std::basic_ostream< charT, traits > &  os, const boolean &  rhs  )

inline

Output boolean to output stream.

Parameters

os	the output stream.
rhs	the boolean to output.

Returns

the output stream.

bool ome::common::operator== ( const boolean &  lhs, bool  rhs  )

inline

Compare boolean with bool for equality.

Parameters

lhs	the first value to compare.
rhs	the second value to compare.

Returns

true if equal, false if not equal.

bool ome::common::operator== ( bool  lhs, const boolean &  rhs  )

inline

Compare bool with boolean for equality.

Parameters

lhs	the first value to compare.
rhs	the second value to compare.

Returns

true if equal, false if not equal.

bool ome::common::operator== ( const boolean &  lhs, const boolean &  rhs  )

inline

Compare boolean with boolean for equality.

Parameters

lhs	the first value to compare.
rhs	the second value to compare.

Returns

true if equal, false if not equal.

template<class charT , class traits >

std::basic_istream<charT,traits>& ome::common::operator>> ( std::basic_istream< charT, traits > &  is, boolean &  rhs  )

inline

Set boolean from input stream.

Parameters

is	the input stream.
rhs	the boolean to set.

Returns

the input stream.

std::string ome::common::rtrim ( const std::string &  str )

inline

Trim trailing whitespace from a string.

Space, newline, carriage return and horizontal and vertical tabs are removed from the right-hand side of the string.

Parameters

str	the string to trim.

Returns

the right-trimmed string.

void ome::common::setLogLevel

(

logging::trivial::severity_level

severity

)

Set global logging level.

Log messages will be filtered such that messages with a priority greater or equal to the specified severity will be logged; messages with a lower priority will be discarded.

If using Boost.Log for logging, this is used to set the logging core filter.

Parameters

severity

the log severity.

std::string ome::common::trim ( const std::string &  str )

inline

Trim leading and trailing whitespace from a string.

Space, newline, carriage return and horizontal and vertical tabs are removed from the left- and right-hand sides of the string.

Parameters

str	the string to trim.

Returns

the trimmed string.

Referenced by ome::xml::model::enums::AcquisitionMode::AcquisitionMode(), ome::xml::model::enums::ArcType::ArcType(), ome::xml::model::enums::Binning::Binning(), ome::xml::model::enums::Compression::Compression(), ome::xml::model::enums::ContrastMethod::ContrastMethod(), ome::xml::model::enums::Correction::Correction(), ome::xml::model::enums::DetectorType::DetectorType(), ome::xml::model::enums::DimensionOrder::DimensionOrder(), ome::xml::model::enums::ExperimentType::ExperimentType(), ome::xml::model::enums::FilamentType::FilamentType(), ome::xml::model::enums::FillRule::FillRule(), ome::xml::model::enums::FilterType::FilterType(), ome::xml::model::enums::FontFamily::FontFamily(), ome::xml::model::enums::FontStyle::FontStyle(), ome::xml::model::enums::IlluminationType::IlluminationType(), ome::xml::model::enums::Immersion::Immersion(), ome::xml::model::enums::LaserMedium::LaserMedium(), ome::xml::model::enums::LaserType::LaserType(), ome::xml::model::enums::LineCap::LineCap(), ome::xml::model::enums::Marker::Marker(), ome::xml::model::enums::Medium::Medium(), ome::xml::model::enums::MicrobeamManipulationType::MicrobeamManipulationType(), ome::xml::model::enums::MicroscopeType::MicroscopeType(), ome::xml::model::enums::NamingConvention::NamingConvention(), ome::xml::model::enums::PixelType::PixelType(), ome::xml::model::enums::Pulse::Pulse(), and ome::bioformats::detail::FormatReader::setId().

Here is the caller graph for this function: