Collections Library
[Libraries]


Detailed Description

Created: 23rd May 2006 Updated: 11th January 2007.

This library defines collections that extend the STL.

The STL-collections provided by the STLSoft libraries include:


Modules

 Collections
 STL-extension collections.

Classes

class  message_queue_sequence
 An instance adaptor that adapts an instance of ACE_Message_Queue to provide an STL input-sequence interface. More...
class  collection_sequence
 A template for adapting COM collections to STL-compatible sequence iteration. More...
class  clone_failure
 Exception class thrown when Clone() method fails. More...
struct  noncloneable_enumerator_tag
 Policy tag type that indicates an enumerator's Clone() method will fail. More...
struct  cloneable_enumerator_tag
 Policy tag type that indicates an enumerator's Clone() method will succeed. More...
struct  repeatable_enumerator_tag
 Policy tag type that indicates an enumerator's Clone() method will succeed, and return an enumerator that will provide the same sequence of items as the source instance. More...
struct  input_cloning_policy
 Policy type that causes COM enumerator cloning according the STL Input Iterator concept. More...
struct  cloneable_cloning_policy
 Policy type that causes COM enumerator cloning according the STL Input Iterator concept. More...
struct  forward_cloning_policy
 Policy type that causes COM enumerator cloning according the STL Forward Iterator concept. More...
struct  value_policy_adaptor
 Adapts a value policy to a function class based interface. More...
struct  policy_adaptor
 [DEPRECATED] Adapts a value policy to a function class based interface More...
struct  new_enum_property_policy
 Acquires an enumerator from a collection assuming _NewEnum property. More...
struct  new_enum_method_policy
 Acquires an enumerator from a collection assuming _NewEnum method. More...
struct  new_enum_by_dispid_policy
 Acquires an enumerator from a collection by looking up the DISPID_NEWENUM on the collection's IDispatch interface. More...
class  enumerator_sequence
 A template for adapting COM enumerators to STL-compatible sequence iteration. More...
class  safearray_sequence
 Provides an STL-iterable view over a COM SAFEARRAY. More...
class  ArrayListEnumerator
 Provides an IEnumerator implementation on an ArrayList. More...
class  CArray_adaptor_base
 Adaptor class, providing implementation for CArray_cadaptor and CArray_iadaptor classes. More...
class  CArray_cadaptor
 Adaptor class, representing a Class Adaptor over the CArray family of MFC containers. More...
class  CArray_iadaptor
 Adaptor class, representing an Instance Adaptor over the CArray family of MFC containers. More...
struct  CArray_traits
 Traits for CArray_adaptor_base. More...
struct  CArray_specific_traits
 Traits type for specific setting of value_type and arg_type. More...
class  CList_adaptor_base
 Adaptor class, providing implementation for CList_cadaptor and CList_iadaptor classes. More...
class  CList_iadaptor
 Adaptor class, representing an Instance Adaptor over the CList family of MFC containers. More...
struct  CList_traits
 Traits for CList_adaptor_base. More...
struct  CList_specific_traits
 Traits type for specific setting of value_type and arg_type. More...
class  CString_adaptor_base
 Applies standard string (std::basic_string) interface to the CString class. More...
class  CString_cadaptor
 Adaptor class, representing a Class Adaptor over the MFC CString type. More...
class  CString_iadaptor
 Adaptor class, representing an Instance Adaptor over the MFC CString type. More...
class  const_CString_iadaptor
 Non-mutable Adaptor class, representing an Instance Adaptor over the MFC CString type. More...
class  array_proxy
 Acts as a proxy for built-in arrays, ensuring functions passed array proxies have safe access to both array pointer and length. More...
class  array_view
 Acts as a view for built-in arrays, ensuring functions passed array proxies have safe access to both array pointer and length, to avoid polymorphic array problems. More...
class  associative_container_veneer
 Applies per-item functions to an associative container's items at its destruction. More...
class  associative_key_sequence
 Adapts an associative container to provide a sequence over the element keys. More...
class  associative_value_sequence
 Instance adaptor that represents an associative collection as a sequence of its values. More...
class  sequence_container_veneer
 Applies a per-item function to a sequence container's items at its destruction. More...
struct  associative_mapped_type_detector
 Detector traits class template for determining the member types of associative containers. More...
struct  collection_tag
 Rootmost tag for a collection. More...
struct  stl_collection_tag
 Indentifies a collection as being an STL collection: it has begin() and end(). More...

Functions

template<class A>
void CArray_swap (A &lhs, A &rhs)
 Swaps the contents of two instances of CArray-family containers.
template<class A>
void CList_swap (A &lhs, A &rhs)
 Swaps the contents of two instances of CList-family containers.
template<typename M, typename K>
ss_typename_type_ret_k
M::mapped_type & 
lookup (M &m, K const &key)
 Looks up and returns the matching referent for a given key, or throws std::out_of_range if the key is not found in the map.
template<typename M, typename K>
ss_typename_type_ret_k
M::mapped_type const & 
lookup (M const &m, K const &key)
 Looks up and returns the matching referent for a given key, or throws std::out_of_range if the key is not found in the map.


Function Documentation

void mfcstl::CArray_swap ( A &  lhs,
A &  rhs 
) [inline]

Swaps the contents of two instances of CArray-family containers.

Referenced by CArray_adaptor_base< A, mfcstl::CArray_cadaptor< A, T >, T >::assign().

void mfcstl::CList_swap ( A &  lhs,
A &  rhs 
) [inline]

Swaps the contents of two instances of CList-family containers.

ss_typename_type_ret_k M::mapped_type const& stlsoft::lookup ( M const &  m,
K const &  key 
) [inline]

Looks up and returns the matching referent for a given key, or throws std::out_of_range if the key is not found in the map.

Parameters:
m The map to be searched
key The key to be searched for
Returns:
The matching referent
Note:
If key does not refer to an entry in the map m, then std::out_of_range is thrown

References ss_typename_type_k, and stlsoft_ns_qual_std.

ss_typename_type_ret_k M::mapped_type& stlsoft::lookup ( M &  m,
K const &  key 
) [inline]

Looks up and returns the matching referent for a given key, or throws std::out_of_range if the key is not found in the map.

Parameters:
m The map to be searched
key The key to be searched for
Returns:
The matching referent
Note:
If key does not refer to an entry in the map m, then std::out_of_range is thrown

References ss_typename_type_k, and stlsoft_ns_qual_std.


Generated on Thu Jun 10 08:58:17 2010 for STLSoft by  doxygen 1.5.6