OutputMapWrapper< T > Class Template Reference

In newer versions of Clang calling operator[] on a map with a component that has a default constructor is an error, thus utilizing a map directly to store a ExecFlagEnum is not possible. More...

#include <AdvancedOutputUtils.h>

Public Member Functions
	OutputMapWrapper ()
	Constructor.
T &	operator[] (const std::string &name)
	A map accessor that errors if the key is not found.
bool	contains (const std::string &name) const
	A method for testing of a key exists.
std::map< std::string, T >::iterator	begin ()
	Provide iterator and find access to the underlying map data.
std::map< std::string, T >::iterator	end ()
std::map< std::string, T >::iterator	find (const std::string &name)
std::map< std::string, T >::const_iterator	begin () const
std::map< std::string, T >::const_iterator	end () const
const std::map< std::string, T >::const_iterator	find (const std::string &name) const

Protected Attributes
std::map< std::string, T >	_map
	Data storage.

Detailed Description

template<typename T>
class OutputMapWrapper< T >

In newer versions of Clang calling operator[] on a map with a component that has a default constructor is an error, thus utilizing a map directly to store a ExecFlagEnum is not possible.

This template class is a map wrapper that provides the basic map-like functionality for accessing map types with operator[] by using find internally. It also produces an error if the map key does not exists, this it provides a layer of protection not available to maps operator[] in general.

This class is used here to create two different warehouse containers below.

See also

OutputOnWarehouse OutputDataWarehouse

Definition at line 60 of file AdvancedOutputUtils.h.

Constructor & Destructor Documentation

OutputMapWrapper()

template<typename T >

OutputMapWrapper< T >::OutputMapWrapper ( )

inline

Constructor.

Definition at line 66 of file AdvancedOutputUtils.h.

{}

Member Function Documentation

begin() [1/2]

template<typename T >

std::map< std::string, T >::iterator OutputMapWrapper< T >::begin ( )

inline

Provide iterator and find access to the underlying map data.

Definition at line 84 of file AdvancedOutputUtils.h.

{ return _map.begin(); }

begin() [2/2]

template<typename T >

std::map< std::string, T >::const_iterator OutputMapWrapper< T >::begin ( ) const

inline

Definition at line 90 of file AdvancedOutputUtils.h.

{ return _map.begin(); }

contains()

template<typename T >

bool OutputMapWrapper< T >::contains ( const std::string &  name ) const

inline

A method for testing of a key exists.

Definition at line 101 of file AdvancedOutputUtils.h.

{ return find(name) != end(); }

Referenced by AdvancedOutput::hasOutput(), AdvancedOutput::hasOutputHelper(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), and AdvancedOutput::wantOutput().

end() [1/2]

template<typename T >

std::map< std::string, T >::iterator OutputMapWrapper< T >::end ( )

inline

Definition at line 85 of file AdvancedOutputUtils.h.

{ return _map.end(); }

Referenced by OutputMapWrapper< T >::contains(), and AdvancedOutput::wantOutput().

end() [2/2]

template<typename T >

std::map< std::string, T >::const_iterator OutputMapWrapper< T >::end ( ) const

inline

Definition at line 91 of file AdvancedOutputUtils.h.

{ return _map.end(); }

find() [1/2]

template<typename T >

std::map< std::string, T >::iterator OutputMapWrapper< T >::find ( const std::string &  name )

inline

Definition at line 86 of file AdvancedOutputUtils.h.

  {
    return _map.find(name);
  }

Referenced by OutputMapWrapper< T >::contains(), CSV::initialSetup(), and AdvancedOutput::wantOutput().

find() [2/2]

template<typename T >

const std::map< std::string, T >::const_iterator OutputMapWrapper< T >::find ( const std::string &  name ) const

inline

Definition at line 92 of file AdvancedOutputUtils.h.

  {
    return _map.find(name);
  }

operator[]()

template<typename T >

T & OutputMapWrapper< T >::operator[] ( const std::string &  name )

inline

A map accessor that errors if the key is not found.

Definition at line 71 of file AdvancedOutputUtils.h.

  {
    // Locate the map entry, error if it is not found
    typename std::map<std::string, T>::iterator iter = _map.find(name);
    if (iter == _map.end())
      mooseError("Unknown map key ", name);
    return iter->second;
  }

Member Data Documentation

_map

template<typename T >

std::map<std::string, T> OutputMapWrapper< T >::_map

protected

Data storage.

Definition at line 105 of file AdvancedOutputUtils.h.

Referenced by OutputMapWrapper< T >::begin(), OutputMapWrapper< T >::begin(), OutputMapWrapper< T >::end(), OutputMapWrapper< T >::end(), OutputMapWrapper< T >::find(), OutputMapWrapper< T >::find(), and OutputMapWrapper< T >::operator[]().

---

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

• include/outputs/AdvancedOutputUtils.h