#include <DataBucket.h>

Inheritance diagram for SG::DataBucket< T >:

Collaboration diagram for SG::DataBucket< T >:

Public Member Functions
	DataBucket ()

	DataBucket (T *data)

template<class U >
	DataBucket (std::unique_ptr< U > data)

	DataBucket (SG::DataObjectSharedPtr< T > data)

virtual	~DataBucket ()

virtual const CLID &	clID () const override

virtual void *	object () override

virtual const std::type_info &	tinfo () const override
	Return the `type_info` for the stored object. More...

	operator T* ()

	operator const T * () const

virtual void *	cast (CLID clid, IRegisterTransient *irt=0, bool isConst=true) override
	Return the contents of the `DataBucket`, converted to type given by clid. More...

virtual void *	cast (const std::type_info &tinfo, IRegisterTransient *irt=0, bool isConst=true) override
	Return the contents of the `DataBucket`, converted to type given by std::type_info. More...

virtual void *	cast (CLID clid, const std::type_info &tinfo, SG::IRegisterTransient *irt=0, bool isConst=true) override
	Return the contents of the `DataBucket`, converted to type given by clid. More...

virtual void	relinquish () override
	Give up ownership of the `DataBucket` contents. More...

virtual void	lock () override
	If the held object derives from `ILockable`, call `lock()` on it. More...

template<class T >
T *	cast (SG::IRegisterTransient *irt=0, bool isConst=true)
	Return the contents of the `DataBucket`, converted to type T. More...

Static Public Member Functions
static const CLID &	classID ()

Protected Member Functions
T *	ptr ()

const T *	cptr () const

void *	tryStaticConversion (CLID clid)
	Try a conversion using static SG_BASES information. More...

void *	tryStaticConversion (const std::type_info &tinfo)
	Try a conversion using static SG_BASES information. More...

Private Types
typedef std::pair< const CopyConversionBase , void >	ent_t
	Objects made by copy conversion. More...

typedef std::vector< ent_t >	vec_t

Private Member Functions
	DataBucket (const DataBucket &)

DataBucket &	operator= (const DataBucket &)

Private Attributes
T *	m_ptr

vec_t	m_cnvcopies

Detailed Description

template<class T>
class SG::DataBucket< T >

Definition at line 30 of file DataBucket.h.

Member Typedef Documentation

◆ ent_t

template<class T >

typedef std::pair<const CopyConversionBase*, void*> SG::DataBucket< T >::ent_t

private

Objects made by copy conversion.

Definition at line 160 of file DataBucket.h.

◆ vec_t

template<class T >

typedef std::vector<ent_t> SG::DataBucket< T >::vec_t

private

Definition at line 161 of file DataBucket.h.

Constructor & Destructor Documentation

◆ DataBucket() [1/5]

template<class T >

SG::DataBucket< T >::DataBucket ( )

inline

Definition at line 36 of file DataBucket.h.

36 : m_ptr(0) {} //needed by the generic converters

◆ DataBucket() [2/5]

template<class T >

SG::DataBucket< T >::DataBucket ( T * data )

◆ DataBucket() [3/5]

template<class T >

template<class U >

SG::DataBucket< T >::DataBucket ( std::unique_ptr< U > data )

◆ DataBucket() [4/5]

template<class T >

SG::DataBucket< T >::DataBucket ( SG::DataObjectSharedPtr< T > data )

◆ ~DataBucket()

template<class T >

virtual SG::DataBucket< T >::~DataBucket ( )

virtual

◆ DataBucket() [5/5]

template<class T >

SG::DataBucket< T >::DataBucket ( const DataBucket< T > & )

private

Member Function Documentation

◆ cast() [1/4]

template<class T >

virtual void* SG::DataBucket< T >::cast	(	CLID	clid,
		const std::type_info &	tinfo,
		SG::IRegisterTransient *	irt = `0`,
		bool	isConst = `true`
	)

overridevirtual

Return the contents of the DataBucket, converted to type given by clid.

Note that only derived->base conversions are allowed here.

Parameters

clid	The class ID to which to convert.
tinfo	The std::type_info of the type to which to convert.
irt	To be called if we make a new instance.
isConst	True if the object being converted is regarded as const.

This allows the callee to choose whether to use clid or tinfo. Here we use clid.

Reimplemented from DataBucketBase.

Reimplemented in SG::DVLDataBucket< T >, SG::DVLDataBucket< DV >, and SG::MetaContDataBucket< T >.

◆ cast() [2/4]

template<class T >

virtual void* SG::DataBucket< T >::cast	(	CLID	clid,
		IRegisterTransient *	irt = `0`,
		bool	isConst = `true`
	)

overridevirtual

Return the contents of the DataBucket, converted to type given by clid.

Note that only derived->base conversions are allowed here.

Parameters

clid	The class ID to which to convert.
irt	To be called if we make a new instance.
isConst	True if the object being converted is regarded as const.

Implements DataBucketBase.

Reimplemented in SG::DVLDataBucket< T >, SG::DVLDataBucket< DV >, and SG::MetaContDataBucket< T >.

◆ cast() [3/4]

template<class T >

virtual void* SG::DataBucket< T >::cast	(	const std::type_info &	tinfo,
		IRegisterTransient *	irt = `0`,
		bool	isConst = `true`
	)

overridevirtual

Return the contents of the DataBucket, converted to type given by std::type_info.

Note that only derived->base conversions are allowed here.

Parameters

clid	The std::type_info of the type to which to convert.
irt	To be called if we make a new instance.
isConst	True if the object being converted is regarded as const.

Implements DataBucketBase.

Reimplemented in SG::DVLDataBucket< T >, SG::DVLDataBucket< DV >, and SG::MetaContDataBucket< T >.

◆ cast() [4/4]

template<class T >

T* DataBucketBase::cast	(	SG::IRegisterTransient *	irt = `0`,
		bool	isConst = `true`
	)

inherited

Return the contents of the DataBucket, converted to type T.

Note that only derived->base conversions are allowed here. T must have a valid Class ID for this to work.

Parameters

irt	To be called if we make a new instance.
isConst	True if the object being converted is regarded as const.

◆ classID()

template<class T >

static const CLID& SG::DataBucket< T >::classID ( )

static

◆ clID()

template<class T >

virtual const CLID& SG::DataBucket< T >::clID ( ) const

overridevirtual

Reimplemented in SG::DVLDataBucket< T >, and SG::DVLDataBucket< DV >.

◆ cptr()

template<class T >

const T* SG::DataBucket< T >::cptr ( ) const

inlineprotected

Definition at line 133 of file DataBucket.h.

133 { return m_ptr; }

◆ lock()

template<class T >

virtual void SG::DataBucket< T >::lock ( )

overridevirtual

If the held object derives from ILockable, call lock() on it.

Implements DataBucketBase.

◆ object()

template<class T >

virtual void* SG::DataBucket< T >::object ( )

inlineoverridevirtual

Implements DataBucketBase.

Definition at line 51 of file DataBucket.h.

     {
       typedef typename std::remove_const<T>::type T_nc;
       return const_cast<T_nc*>(m_ptr);
     }

◆ operator const T *()

template<class T >

SG::DataBucket< T >::operator const T * ( ) const

inline

Definition at line 74 of file DataBucket.h.

74 { return cptr(); }

◆ operator T*()

template<class T >

SG::DataBucket< T >::operator T* ( )

inline

Definition at line 73 of file DataBucket.h.

73 { return ptr(); } //FIXME can we do without?

◆ operator=()

template<class T >

DataBucket& SG::DataBucket< T >::operator= ( const DataBucket< T > & )

private

◆ ptr()

template<class T >

T* SG::DataBucket< T >::ptr ( )

inlineprotected

Definition at line 132 of file DataBucket.h.

132 { return m_ptr; }

◆ relinquish()

template<class T >

virtual void SG::DataBucket< T >::relinquish ( )

inlineoverridevirtual

Give up ownership of the DataBucket contents.

This leaks the contents and it is useful mainly for error handling.

Implements DataBucketBase.

Definition at line 123 of file DataBucket.h.

123 { m_ptr=0;} //LEAKS m_ptr

◆ tinfo()

template<class T >

virtual const std::type_info& SG::DataBucket< T >::tinfo ( ) const

inlineoverridevirtual

Return the type_info for the stored object.

Implements DataBucketBase.

Reimplemented in SG::DVLDataBucket< T >, and SG::DVLDataBucket< DV >.

Definition at line 60 of file DataBucket.h.

     {
       return typeid(T);
     }

◆ tryStaticConversion() [1/2]

template<class T >

void* SG::DataBucket< T >::tryStaticConversion ( CLID clid )

protected

Try a conversion using static SG_BASES information.

Parameters

clid	The class ID to which to convert.

This can all be unfolded at compile time, so is fast, but doesn't take into account SG_ADD_BASES.

◆ tryStaticConversion() [2/2]

template<class T >

void* SG::DataBucket< T >::tryStaticConversion ( const std::type_info & tinfo )

protected

Try a conversion using static SG_BASES information.

Parameters

tinfo The std::type_info of the type to which to convert.

This can all be unfolded at compile time, so is fast, but doesn't take into account SG_ADD_BASES.

Member Data Documentation

◆ m_cnvcopies

template<class T >

vec_t SG::DataBucket< T >::m_cnvcopies

private

Definition at line 162 of file DataBucket.h.

◆ m_ptr

template<class T >

T* SG::DataBucket< T >::m_ptr

private

Definition at line 157 of file DataBucket.h.

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

DataBucket.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

template<class T> class SG::DataBucket< T >

Member Typedef Documentation

◆ ent_t

◆ vec_t

Constructor & Destructor Documentation

◆ DataBucket() [1/5]

◆ DataBucket() [2/5]

◆ DataBucket() [3/5]

◆ DataBucket() [4/5]

◆ ~DataBucket()

◆ DataBucket() [5/5]

Member Function Documentation

◆ cast() [1/4]

◆ cast() [2/4]

◆ cast() [3/4]

◆ cast() [4/4]

◆ classID()

◆ clID()

◆ cptr()

◆ lock()

◆ object()

◆ operator const T *()

◆ operator T*()

◆ operator=()

◆ ptr()

◆ relinquish()

◆ tinfo()

◆ tryStaticConversion() [1/2]

◆ tryStaticConversion() [2/2]

Member Data Documentation

◆ m_cnvcopies

◆ m_ptr

template<class T>
class SG::DataBucket< T >