Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template storage

boost::signals::storage — Stores and transmits arguments received from a signal.

Synopsis

template<typename Signature, typename OutSignal = unfused, 
         typename Combiner = boost::last_value<typename boost::function_traits<Signature>::result_type>, 
         typename Group = int, typename GroupCompare = std::less<Group> > 
class storage {
public:
  // types
  typedef unspecified parameter_types;
  typedef unspecified storable_types; 
  typedef unspecified storable_vector;

  // construct/copy/destruct
  template<typename Seq> storage(const Seq &);
  storage();

  // public member functions
  void open() ;
  void close() ;
  base_type::signal_type::result_type send() ;
  base_type::signal_type::result_type send(const boost::fusion::vector<> &) ;
  const storable_vector & stored_vector() ;
  template<int N> 
    boost::fusion::result_of::at_c< storable_vector, N >::type at() ;
  template<int N> boost::mpl::at_c< parameter_types, N >::type value_at() ;
  template<int N> slot_selector at_slot() ;
  template<int N> slot_selector value_at_slot() ;

  // protected member functions
  storable_vector & stored() ;
};

Description

storage construct/copy/destruct

  1. template<typename Seq> storage(const Seq & seq);

    Initializes the stored parameter values using the provided sequence.

    Parameters:
    seq

    Sequence from which the stored parameter sequence is initialized from.

  2. storage();

    Initializes the stored parameter values using its default constructor.

storage public member functions

  1. void open() ;
  2. void close() ;
  3. base_type::signal_type::result_type send() ;

    Sends a signal containing the stored parameter values.

    Returns:

    Return value of the sent signal.

  4. base_type::signal_type::result_type send(const boost::fusion::vector<> &) ;

    Sends a signal containing the stored parameter values.

    Returns:

    Return value of the sent signal.

  5. const storable_vector & stored_vector() ;

    Returns:

    A reference to the fusion vector of stored parameter values.

  6. template<int N> 
      boost::fusion::result_of::at_c< storable_vector, N >::type at() ;

    Returns:

    The stored value of parameter N using an optimizing cast.

  7. template<int N> boost::mpl::at_c< parameter_types, N >::type value_at() ;

    Returns:

    The stored value of parameter N typed exactly as it appears in the Signature.

  8. template<int N> slot_selector at_slot() ;

    Returns:

    The slot selector for the related at function.

  9. template<int N> slot_selector value_at_slot() ;

    Returns:

    The slot selector for the value_at function.

storage protected member functions

  1. storable_vector & stored() ;
Copyright © 2007 Stjepan Rajko

PrevUpHomeNext