bbtk::any< TypeTraits > Class Template Reference

#include <bbtkAny.h>

Collaboration diagram for bbtk::any< TypeTraits >:

[legend]

List of all members.

Public Types
typedef any< TypeTraits >	self
Public Member Functions
	any ()
	Default constructor.
template<typename ValueType >
	any (const ValueType &value)
	Constructor with a value of template type.
	any (const any &other)
	Copy constructor.
	~any ()
	Destructor.
any &	swap (any &rhs)
	Swaps the content of this with another any.
template<typename ValueType >
any &	operator= (const ValueType &rhs)
	Affectation of a value of template type.
any &	operator= (const any &rhs)
	Affectation of another any.
bool	empty () const
	Is it empty (no value held) ?
const std::type_info &	type () const
	Returns the type_info of the held value.
const std::type_info &	pointed_type () const
	Returns the type_info of the pointed held value.
template<typename Type >
bool	contains ()
	Returns true iff the contained type is Type.
bool	contains_pointer ()
	Returns true iff the contained type is a pointer.
bool	contains (TypeInfo t)
	Returns true iff the contained type is t.
template<typename Type >
bool	accepts ()
	Returns true iff any of type ValueType can be held.
template<typename ValueType >
const ValueType &	get () const
template<typename ValueType >
const ValueType *	getP () const
template<typename ValueType >
const ValueType &	unsafe_get () const
void *	get_pointer () const
void *	get_pointer_to (const std::type_info &t) const
Private Attributes
anyplaceholder *	content
	content

---

Detailed Description

template<template< class > class TypeTraits>
class bbtk::any< TypeTraits >

A magic class which can store any type of data which is allowed by the template template parameter TypeTrait.

The only requirement on TypeTrait<T> is to have the member : static const bool value; which is true iff the type T is an allowed type

TypeTraits compliant objects are usually template structs for which the initialisation of value is set to false by default and set to true for the allowed types (template specialisation) Example : template <typename t>=""> struct mytypes { static const bool value; }; template <typename t>=""> const bool mytypes<T>::value = false; template <> const bool mytypes<int>::value = true; template <> const bool mytypes<float>::value = true; etc. You can use any boost type_trait, like is_pointer, is_floating_point, etc.

The class any is a generalisation of the boost::any class (see http://www.boost.org/doc/html/any.html). The boost::any class itself is reproduced by any<thing>, where thing is a TypeTrait whose value is true for all types.

Definition at line 184 of file bbtkAny.h.

---

Member Typedef Documentation

template<template< class > class TypeTraits>

typedef any< TypeTraits > bbtk::any< TypeTraits >::self

Definition at line 187 of file bbtkAny.h.

---

Constructor & Destructor Documentation

template<template< class > class TypeTraits>

bbtk::any< TypeTraits >::any

(

)

[inline]

Default constructor.

Definition at line 191 of file bbtkAny.h.

Referenced by bbtk::any< TypeTraits >::operator=().

      : content(0)
    {
    }

Here is the caller graph for this function:

template<template< class > class TypeTraits>

template<typename ValueType >

bbtk::any< TypeTraits >::any

(

const ValueType &

value

)

[inline]

Constructor with a value of template type.

Definition at line 198 of file bbtkAny.h.

References bbtkDebugMessage, bbtkError, bbtk::any< TypeTraits >::content, and bbtk::HumanTypeName().

      : content(0)
    {
      bbtkDebugMessage("Data",1,
                       bbtk::HumanTypeName<self>()<<" construction with <"
                       <<bbtk::HumanTypeName<ValueType>()<<">"<<std::endl);
      //      ValueType v = value;
      //      int** i = (int**)(&v);
      //      std::cout << "v="<<*i<<std::endl;
      
      if (accepts<ValueType>()) 
        { 
          content = new anyholder<ValueType>(value);
        }
      else 
        {
          bbtkError(bbtk::HumanTypeName<self>()
                    <<" constructor : data of type <"
                    <<bbtk::HumanTypeName<ValueType>()
                    <<"> are not accepted by traits <"
                    <<bbtk::HumanTypeName<TypeTraits<void> >()<<"> ");
        }
    }

Here is the call graph for this function:

template<template< class > class TypeTraits>

bbtk::any< TypeTraits >::any

(

const any< TypeTraits > &

other

)

[inline]

Copy constructor.

Definition at line 223 of file bbtkAny.h.

References bbtkDebugMessage, bbtk::HumanTypeName(), and bbtk::any< TypeTraits >::type().

      : content(other.content ? other.content->clone() : 0)
    {
      bbtkDebugMessage("Data",1,
                       HumanTypeName<self>()
                       <<" copy construction with new content : "
                       <<HumanTypeName(type())
                       <<std::endl);
    }

Here is the call graph for this function:

template<template< class > class TypeTraits>

bbtk::any< TypeTraits >::~any

(

)

[inline]

Destructor.

Definition at line 234 of file bbtkAny.h.

References bbtk::any< TypeTraits >::content.

    {
      delete content;
    }

---

Member Function Documentation

template<template< class > class TypeTraits>

template<typename Type >

bool bbtk::any< TypeTraits >::accepts

(

)

[inline]

Returns true iff any of type ValueType can be held.

Definition at line 325 of file bbtkAny.h.

    {
      return TypeTraits<Type>::value; //is_valid();
    }

template<template< class > class TypeTraits>

bool bbtk::any< TypeTraits >::contains

(

TypeInfo

t

)

[inline]

Returns true iff the contained type is t.

Definition at line 318 of file bbtkAny.h.

References bbtk::any< TypeTraits >::type().

    {
      return ( (bool)((type() == t)!=0) );
     }

Here is the call graph for this function:

template<template< class > class TypeTraits>

template<typename Type >

bool bbtk::any< TypeTraits >::contains

(

)

[inline]

Returns true iff the contained type is Type.

Definition at line 306 of file bbtkAny.h.

References bbtk::any< TypeTraits >::type().

    {
      return ( type() == typeid(Type) );
    }

Here is the call graph for this function:

template<template< class > class TypeTraits>

bool bbtk::any< TypeTraits >::contains_pointer

(

)

[inline]

Returns true iff the contained type is a pointer.

Definition at line 312 of file bbtkAny.h.

References bbtk::any< TypeTraits >::content, and bbtk::anyplaceholder::is_pointer().

    {
      return content ? content->is_pointer() : false;
    }

Here is the call graph for this function:

template<template< class > class TypeTraits>

bool bbtk::any< TypeTraits >::empty

(

)

const [inline]

Is it empty (no value held) ?

Definition at line 286 of file bbtkAny.h.

References bbtk::any< TypeTraits >::content.

    {
      return !content;
    }

template<template< class > class TypeTraits>

template<typename ValueType >

const ValueType& bbtk::any< TypeTraits >::get

(

)

const [inline]

Returns a const reference on the held value iff its type matches the template parameter

Definition at line 333 of file bbtkAny.h.

References bbtkDebugMessage, bbtkError, bbtk::any< TypeTraits >::content, bbtk::HumanTypeName(), and bbtk::any< TypeTraits >::type().

    {
        bbtkDebugMessage("Data",1,
                         HumanTypeName<self >()
                         <<" get<"<<HumanTypeName<ValueType>()
                         <<"> with content : "
                         <<HumanTypeName(type())<<std::endl);

      if ( type() == typeid(ValueType) )
        return static_cast< anyholder<ValueType> *>(content)->held;

      bbtkError(HumanTypeName<self >()
                <<" get with type <"
                <<bbtk::HumanTypeName<ValueType>()
                <<"> does not match content type <"
                <<bbtk::HumanTypeName<>(type())<<">");
    }

Here is the call graph for this function:

template<template< class > class TypeTraits>

void* bbtk::any< TypeTraits >::get_pointer

(

)

const [inline]

Definition at line 392 of file bbtkAny.h.

References bbtkDebugMessage, bbtk::any< TypeTraits >::content, bbtk::anyplaceholder::get_pointer(), bbtk::HumanTypeName(), and bbtk::any< TypeTraits >::type().

    {
      void* p = content->get_pointer();
      bbtkDebugMessage("Data",1,
                       HumanTypeName<self>()
                       <<"::get_pointer() with content <"
                       <<HumanTypeName(this->type())
                       <<"> : result = "
                       << p
                       <<std::endl);
      return p;
    }

Here is the call graph for this function:

template<template< class > class TypeTraits>

void* bbtk::any< TypeTraits >::get_pointer_to

(

const std::type_info &

t

)

const [inline]

Definition at line 405 of file bbtkAny.h.

References bbtkDebugMessage, bbtk::any< TypeTraits >::content, bbtk::anyplaceholder::get_pointer_to(), bbtk::HumanTypeName(), and bbtk::any< TypeTraits >::type().

    {
      void* p = content->get_pointer_to(t);
      bbtkDebugMessage("Data",1,
                       HumanTypeName<self>()
                       <<"::get_pointer_to("<<HumanTypeName(t)
                       <<") with content <"
                       <<HumanTypeName(this->type())
                       <<"> : result = "
                       << p
                       <<std::endl);
      return p;
    }

Here is the call graph for this function:

template<template< class > class TypeTraits>

template<typename ValueType >

const ValueType* bbtk::any< TypeTraits >::getP

(

)

const [inline]

Definition at line 352 of file bbtkAny.h.

References bbtkError, bbtk::any< TypeTraits >::content, and bbtk::any< TypeTraits >::type().

    {
      if ( type() == typeid(ValueType) )
        return &static_cast< anyholder<ValueType> *>(content)->held;
 
      bbtkError(HumanTypeName<self >()
                <<" getP with type <"
                <<bbtk::HumanTypeName<ValueType>()
                <<"> does not match content type <"
                <<bbtk::HumanTypeName<>(type())<<">");
    }

Here is the call graph for this function:

template<template< class > class TypeTraits>

any& bbtk::any< TypeTraits >::operator=

(

const any< TypeTraits > &

rhs

)

[inline]

Affectation of another any.

Definition at line 273 of file bbtkAny.h.

References bbtk::any< TypeTraits >::any(), bbtkDebugMessage, bbtk::HumanTypeName(), and bbtk::any< TypeTraits >::type().

    {
        bbtkDebugMessage("Data",1,
                         HumanTypeName<self >()
                         <<" operator=(const any&) with content : "
                         <<HumanTypeName(rhs.type())<<std::endl);

      any(rhs).swap(*this);
      return *this;
    }

Here is the call graph for this function:

template<template< class > class TypeTraits>

template<typename ValueType >

any& bbtk::any< TypeTraits >::operator=

(

const ValueType &

rhs

)

[inline]

Affectation of a value of template type.

Definition at line 249 of file bbtkAny.h.

References bbtk::any< TypeTraits >::any(), bbtkDebugMessage, bbtkError, and bbtk::HumanTypeName().

    {
      bbtkDebugMessage("Data",1,
                       HumanTypeName<self>()
                       <<" operator= with data of type <"
                       <<HumanTypeName<ValueType>()
                       <<">"<<std::endl);
      if (accepts<ValueType>()) 
        {
          any(rhs).swap(*this);
          return *this;
        }
      else 
        {
          bbtkError(HumanTypeName<self>()
                    <<" operator= : data of type <"
                    <<HumanTypeName<ValueType>()
                    <<"> are not accepted by traits <"
                    <<HumanTypeName<TypeTraits<void> >()<<"> ");
        }
    
    }

Here is the call graph for this function:

template<template< class > class TypeTraits>

const std::type_info& bbtk::any< TypeTraits >::pointed_type

(

)

const [inline]

Returns the type_info of the pointed held value.

Definition at line 298 of file bbtkAny.h.

References bbtk::any< TypeTraits >::content, and bbtk::anyplaceholder::pointed_type().

    {
      return content ? content->pointed_type() : typeid(void);
    }

Here is the call graph for this function:

template<template< class > class TypeTraits>

any& bbtk::any< TypeTraits >::swap

(

any< TypeTraits > &

rhs

)

[inline]

Swaps the content of this with another any.

Definition at line 241 of file bbtkAny.h.

References bbtk::any< TypeTraits >::content.

    {
      std::swap(content, rhs.content);
      return *this;
    }

template<template< class > class TypeTraits>

const std::type_info& bbtk::any< TypeTraits >::type

(

)

const [inline]

Returns the type_info of the held value.

Definition at line 292 of file bbtkAny.h.

References bbtk::any< TypeTraits >::content, and bbtk::anyplaceholder::type().

Referenced by bbtk::any< TypeTraits >::any(), bbtk::any< TypeTraits >::contains(), bbtk::any< TypeTraits >::get(), bbtk::any< TypeTraits >::get_pointer(), bbtk::any< TypeTraits >::get_pointer_to(), bbtk::any< TypeTraits >::getP(), bbtk::any< TypeTraits >::operator=(), and bbtk::any< TypeTraits >::unsafe_get().

    {
      return content ? content->type() : typeid(void);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

template<template< class > class TypeTraits>

template<typename ValueType >

const ValueType& bbtk::any< TypeTraits >::unsafe_get

(

)

const [inline]

Returns a const reference on the held value EVEN IF ITS TYPE DOES NOT MATCH THE TEMPLATE PARAMETER ** Hence must be used when one knows that the type is good Otherwise can lead to unpredictible results

Definition at line 369 of file bbtkAny.h.

References bbtkDebugMessage, bbtkError, bbtk::any< TypeTraits >::content, bbtk::HumanTypeName(), and bbtk::any< TypeTraits >::type().

    {
        bbtkDebugMessage("Data",1,
                         HumanTypeName<self>()
                         <<"::unsafe_get<"
                         <<HumanTypeName<ValueType>()<<"> with content : "
                         <<HumanTypeName(this->type())
                         <<std::endl);

        //      PrintValueIfIsPointer<ValueType>(static_cast< anyholder<ValueType> * >(content)->held);
        //      int** i = (int**)(&static_cast< anyholder<ValueType> * >(content)->held);
        //      std::cout << "v="<<*i<<std::endl;

        if (content) 
          return static_cast< anyholder<ValueType> * >(content)->held;
        
        bbtkError(HumanTypeName<self >()
                  <<"::usafe_get<"
                  <<bbtk::HumanTypeName<ValueType>()
                  <<"> : void content");
    }

Here is the call graph for this function:

---

Member Data Documentation

template<template< class > class TypeTraits>

anyplaceholder* bbtk::any< TypeTraits >::content [private]

content

Definition at line 421 of file bbtkAny.h.

Referenced by bbtk::any< TypeTraits >::any(), bbtk::any< TypeTraits >::contains_pointer(), bbtk::any< TypeTraits >::empty(), bbtk::any< TypeTraits >::get(), bbtk::any< TypeTraits >::get_pointer(), bbtk::any< TypeTraits >::get_pointer_to(), bbtk::any< TypeTraits >::getP(), bbtk::any< TypeTraits >::pointed_type(), bbtk::any< TypeTraits >::swap(), bbtk::any< TypeTraits >::type(), bbtk::any< TypeTraits >::unsafe_get(), and bbtk::any< TypeTraits >::~any().

---

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

• /Users/davila/Creatis/All5/creatools_source/bbtk/kernel/src/bbtkAny.h