dictionary_arg_stream< Dictionary, InputRange, NoThrow > Struct Template Reference

#include <dictionary_arg_stream.hpp>

Public Types
typedef dictionary_arg_stream_base< Dictionary, InputRange >	_inherited
typedef Dictionary	dictionary_type
typedef InputRange	range_type
Public Types inherited from dictionary_arg_stream_base< Dictionary, InputRange >
typedef Dictionary	dictionary_type
typedef boost::range_iterator< InputRange const >::type	iterator
typedef InputRange	range_type

Public Member Functions
	dictionary_arg_stream (Dictionary &d, InputRange const &key_range)
template<typename R >
R	get_next_arg ()
Public Member Functions inherited from dictionary_arg_stream_base< Dictionary, InputRange >
	dictionary_arg_stream_base (dictionary_type &d, range_type const &key_range)
bool	eof () const
void	reset ()
void	throw_if_eof () const

Additional Inherited Members
Public Attributes inherited from dictionary_arg_stream_base< Dictionary, InputRange >
iterator	curr
dictionary_type	dict
range_type	range

Detailed Description

template<typename Dictionary, typename InputRange, typename NoThrow = void>
struct adobe::dictionary_arg_stream< Dictionary, InputRange, NoThrow >

This works with any dictionary type that implements get_dictionary_entry(dict, key)

Template Parameters:

• Dictionary - A dictionary which implements adobe::get_entry
• Inputrange - models stldoc_InputRange
• NoThrow - if std::nothrow_t, then the arg_stream will NOT throw if the key is not in the dictionary (it will instead return a default initialized argument)
  • if it is NOT std::nothrow_t, it will likely throw if the key is not in the dictionary

Definition at line 115 of file dictionary_arg_stream.hpp.

Member Typedef Documentation

typedef dictionary_arg_stream_base<Dictionary, InputRange> _inherited

Definition at line 119 of file dictionary_arg_stream.hpp.

typedef Dictionary dictionary_type

Definition at line 69 of file dictionary_arg_stream.hpp.

typedef InputRange range_type

Definition at line 70 of file dictionary_arg_stream.hpp.

Constructor & Destructor Documentation

dictionary_arg_stream	(	Dictionary &	d,
		InputRange const &	key_range
	)

d - dictionary from with to retrieve arguments key_range define a range of keys each key (in order) is used to retrieve an argument of the arg_stream

Definition at line 131 of file dictionary_arg_stream.hpp.

Member Function Documentation

R get_next_arg

(

)

Definition at line 137 of file dictionary_arg_stream.hpp.