Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::attribute_value_ordering< ValueT, FunT > Class Template Reference

Ordering predicate, based on attribute values associated with records. More...

#include <record_ordering.hpp>

Inheritance diagram for boost::attribute_value_ordering< ValueT, FunT >:
Collaboration diagram for boost::attribute_value_ordering< ValueT, FunT >:

Public Types

typedef bool result_type
 Result type. More...
 
typedef ValueT value_type
 Compared attribute value type. More...
 

Public Member Functions

 attribute_value_ordering (attribute_name const &name, FunT const &fun=FunT())
 Initializing constructor. More...
 
result_type operator() (record_view const &left, record_view const &right) const
 Ordering operator. More...
 

Friends

struct l1_visitor
 

Detailed Description

template<typename ValueT, typename FunT = less>
class boost::attribute_value_ordering< ValueT, FunT >

Ordering predicate, based on attribute values associated with records.

This predicate allows to order log records based on values of a specifically named attribute associated with them. Two given log records being compared should both have the specified attribute value of the specified type to be able to be ordered properly. As a special case, if neither of the records have the value, these records are considered equivalent. Otherwise, the ordering results are unspecified.

Member Typedef Documentation

template<typename ValueT , typename FunT = less>
typedef bool boost::attribute_value_ordering< ValueT, FunT >::result_type

Result type.

template<typename ValueT , typename FunT = less>
typedef ValueT boost::attribute_value_ordering< ValueT, FunT >::value_type

Compared attribute value type.

Constructor & Destructor Documentation

template<typename ValueT , typename FunT = less>
boost::attribute_value_ordering< ValueT, FunT >::attribute_value_ordering ( attribute_name const &  name,
FunT const &  fun = FunT() 
)
inlineexplicit

Initializing constructor.

Parameters
nameThe attribute value name to be compared
funThe ordering functor

Member Function Documentation

template<typename ValueT , typename FunT = less>
result_type boost::attribute_value_ordering< ValueT, FunT >::operator() ( record_view const &  left,
record_view const &  right 
) const
inline

Friends And Related Function Documentation

template<typename ValueT , typename FunT = less>
friend struct l1_visitor
friend

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