tdc::Env Class Reference

Local environment for a compression/encoding/decompression call. More...

#include <Env.hpp>

Public Member Functions
	Env ()=delete
	Env (const Env &other)=delete
	Env (Env &&other)
	Env (std::shared_ptr< EnvRoot > root, const AlgorithmValue &node)
	~Env ()
const std::shared_ptr< EnvRoot > &	root () const
void	error (const std::string &msg) const
	Log an error and end the current operation. More...
Env	env_for_option (const std::string &option) const
	Create the environment for a sub algorithm option. More...
const OptionValue &	option (const std::string &option) const
	Get an option of this algorithm. More...

Detailed Description

Local environment for a compression/encoding/decompression call.

Gives access to environment options that can be used to modify the default behavior of an algorithm.

Definition at line 55 of file pre_header/Env.hpp.

Constructor & Destructor Documentation

Env() [1/4]

tdc::Env::Env ( )

inlinedelete

Env() [2/4]

tdc::Env::Env ( const Env &  other )

inlinedelete

Env() [3/4]

tdc::Env::Env ( Env &&  other )

inline

Definition at line 11 of file Env.hpp.

Env() [4/4]

tdc::Env::Env ( std::shared_ptr< EnvRoot >  root, const AlgorithmValue &  node  )

inline

Definition at line 15 of file Env.hpp.

~Env()

tdc::Env::~Env ( )

inlinedefault

Member Function Documentation

env_for_option()

Env tdc::Env::env_for_option ( const std::string &  option ) const

inline

Create the environment for a sub algorithm option.

Definition at line 34 of file Env.hpp.

error()

void tdc::Env::error ( const std::string &  msg ) const

inline

Log an error and end the current operation.

Definition at line 30 of file Env.hpp.

option()

const OptionValue & tdc::Env::option ( const std::string &  option ) const

inline

Get an option of this algorithm.

Definition at line 44 of file Env.hpp.

root()

const std::shared_ptr< EnvRoot > & tdc::Env::root ( ) const

inline

Definition at line 26 of file Env.hpp.

---

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

• pre_header/Env.hpp