Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of boost. Click here for the latest Boost documentation.

Struct template named_parameter

boost::nfp::named_parameter

Synopsis

// In header: <boost/test/utils/named_params.hpp>

template<typename T, typename unique_id, typename RefType> 
struct named_parameter {
  // types
  typedef T         data_type;
  typedef RefType   ref_type; 
  typedef unique_id id;       

  // construct/copy/destruct
  explicit named_parameter(ref_type);
  named_parameter(named_parameter const &);

  // public member functions
  ref_type operator[](keyword< unique_id, true >) const;
  ref_type operator[](keyword< unique_id, false >) const;
  template<typename UnknownId> 
    nil operator[](keyword< UnknownId, false >) const;
  bool has(keyword< unique_id, false >) const;
  template<typename UnknownId> bool has(keyword< UnknownId, false >) const;
  void erase(keyword< unique_id, false >) const;
  template<typename UnknownId> void erase(keyword< UnknownId, false >) const;
  template<typename Visitor> void apply_to(Visitor &) const;
  named_parameter_combine< NP, named_parameter< T, unique_id, RefType > > 
  operator,(NP const &) const;
};

Description

`named_parameter` public construct/copy/destruct

```
explicit named_parameter(ref_type v);
```

named_parameter(named_parameter const & np);

`named_parameter` public member functions

ref_type operator[](keyword< unique_id, true >) const;

ref_type operator[](keyword< unique_id, false >) const;

template<typename UnknownId> nil operator[](keyword< UnknownId, false >) const;

bool has(keyword< unique_id, false >) const;

template<typename UnknownId> bool has(keyword< UnknownId, false >) const;

void erase(keyword< unique_id, false >) const;

template<typename UnknownId> void erase(keyword< UnknownId, false >) const;

template<typename Visitor> void apply_to(Visitor & V) const;

named_parameter_combine< NP, named_parameter< T, unique_id, RefType > > 
operator,(NP const & np) const;