This is helper for converting between pointers of different types, given dynamically by std::type_info. More...

#include <TypeConverter.h>

Collaboration diagram for D3PD::TypeConverter:

Public Member Functions
	TypeConverter ()
	Default constructor. More...

StatusCode	init (const std::type_info &src_ti, const std::type_info &dst_ti)
	Initialize the converter. More...

StatusCode	init (const std::type_info &src_ti, const std::vector< const std::type_info * > &dst_tis, size_t &which)
	Initialize the converter. More...

template<typename T >
StatusCode	init (const std::type_info &src_ti)
	Alternate form of `init`, passing the destination type as a template argument. More...

const void *	convertUntyped (const void *p) const
	Convert pointer. More...

template<class T >
const T *	convert (const void *p) const
	Convert pointer. More...

bool	isValid () const
	Test to see if this converter has been properly initialized. More...

const std::type_info &	srcTypeinfo () const
	Return the configured source type. More...

const std::type_info &	dstTypeinfo () const
	Return the configured destination type. More...

std::string	srcName () const
	Return the name of the source type, or an empty string. More...

std::string	dstName () const
	Return the name of the destination type, or an empty string. More...

Private Types
enum	Strategy { INVALID, IDENTICAL, SRC_BASE, DST_BASE }

Private Member Functions
StatusCode	tryInit (const std::type_info &src_ti, const std::type_info &dst_ti)
	Initialize the converter. More...

Private Attributes
const std::type_info *	m_srcTypeinfo
	The source type. More...

const std::type_info *	m_dstTypeinfo
	The destination type. More...

const SG::BaseInfoBase *	m_srcBIB
	BaseInfo for the source type. More...

const SG::BaseInfoBase *	m_dstBIB
	BaseInfo for the destination type. More...

Strategy	m_strategy
	Strategy to use for the conversion. More...

Detailed Description

This is helper for converting between pointers of different types, given dynamically by std::type_info.

The converter must first be initialized by calling init() with the source and destination types. If the conversion is allowable, then this will return SUCCESS, and isValid() will return true. Pointers can them be converted by calling convert() or convertUntyped().

The remaining methods retrieve the data that was passed to init().

Definition at line 44 of file TypeConverter.h.

Member Enumeration Documentation

◆ Strategy

enum D3PD::TypeConverter::Strategy

private

Enumerator
INVALID	No valid conversion has been configured.
IDENTICAL	Source and destination types are identical.
SRC_BASE	Destination is a base of source — use source BaseInfo.
DST_BASE	Source is a base of destination — use destination BaseInfo.

Definition at line 185 of file TypeConverter.h.

                 {
     INVALID,
  
     IDENTICAL,
  
     SRC_BASE,
  
     DST_BASE
   };

Constructor & Destructor Documentation

◆ TypeConverter()

D3PD::TypeConverter::TypeConverter ( )

Default constructor.

This will create the object in an invalid state.

Definition at line 29 of file TypeConverter.cxx.

   : m_srcTypeinfo (0),
     m_dstTypeinfo (0),
     m_srcBIB (0),
     m_dstBIB (0),
     m_strategy (INVALID)
 {
 }

Member Function Documentation

◆ convert()

template<class T >

const T* D3PD::TypeConverter::convert ( const void * p ) const

Convert pointer.

Parameters

The	pointer to convert, as a pointer to the source type.

Returns: The converted pointer, as a T*.

T must be the same as the previously configured destination type.

Will return 0 if the converter isn't properly initialized, or if the conversion fails (for a base -> derived conversion).

◆ convertUntyped()

const void * D3PD::TypeConverter::convertUntyped ( const void * p ) const

Convert pointer.

Parameters

The	pointer to convert, as a pointer to the source type.

Returns: The converted pointer, as a pointer to the destination type.

Will return 0 if the converter isn't properly initialized, or if the conversion fails (for a base -> derived conversion).

Definition at line 116 of file TypeConverter.cxx.

 {
   switch (m_strategy) {
   case IDENTICAL:
     return p;
  
   case SRC_BASE: {
     // need non-const pointer
     void* nonconst_p ATLAS_THREAD_SAFE = const_cast<void*> (p);
     return m_srcBIB->cast (nonconst_p, *m_dstTypeinfo);
   }
   case DST_BASE: {
     // need non-const pointer
     void* nonconst_p ATLAS_THREAD_SAFE = const_cast<void*> (p);
     return m_dstBIB->castTo (nonconst_p, *m_srcTypeinfo);
   }
   default:
     std::abort();
   }
 }

◆ dstName()

std::string D3PD::TypeConverter::dstName ( ) const

Return the name of the destination type, or an empty string.

Definition at line 151 of file TypeConverter.cxx.

 {
   if (!m_dstTypeinfo) return "";
   return System::typeinfoName (*m_dstTypeinfo);
 }

◆ dstTypeinfo()

const std::type_info& D3PD::TypeConverter::dstTypeinfo ( ) const

Return the configured destination type.

◆ init() [1/3]

template<typename T >

StatusCode D3PD::TypeConverter::init ( const std::type_info & src_ti )

Alternate form of init, passing the destination type as a template argument.

Parameters

src_ti The source type for the conversion.

The types should be for the pointer value types. I.e, if we want to convert from T* to U*, pass typeid(T) as src_ti and U as the template argument.

Returns FAILURE if the conversion is not allowable. Either derived -> base or base -> derived conversions are allowed.

◆ init() [2/3]

StatusCode D3PD::TypeConverter::init	(	const std::type_info &	src_ti,
		const std::type_info &	dst_ti
	)

Initialize the converter.

Parameters

src_ti	The source type for the conversion.
dst_ti	The destination type for the conversion.

The types should be for the pointer value types. I.e, if we want to convert from T* to U*, pass typeid(T) and typeid(U) as src_ti and dst_ti, respectively.

Returns FAILURE if the conversion is not allowable. Either derived -> base or base -> derived conversions are allowed.

Definition at line 51 of file TypeConverter.cxx.

 {
   if (tryInit (src_ti, dst_ti).isFailure()) {
     // Not a valid conversion.
     REPORT_MESSAGE (MSG::ERROR)
       << "Incompatible conversion: from " << srcName() << " to " << dstName();
     return StatusCode::FAILURE;
   }
   return StatusCode::SUCCESS;
 }

◆ init() [3/3]

StatusCode D3PD::TypeConverter::init	(	const std::type_info &	src_ti,
		const std::vector< const std::type_info * > &	dst_tis,
		size_t &	which
	)

Initialize the converter.

Parameters

	src_ti	The source type for the conversion.
	dst_tis	List of possible destination types for the conversion.
[out]	which	Index of accepted conversion.

The types should be for the pointer value types. I.e, if we want to convert from T* to U*, pass typeid(T) and typeid(U) as src_ti and dst_ti, respectively.

All possible destination types are tried; the first one that succeeds is accepted, and WHICH is set to the index of that type. Either derived -> base or base -> derived conversions are allowed.

Returns FAILURE if no candidate conversions are allowable.

Definition at line 82 of file TypeConverter.cxx.

 {
   size_t sz = dst_tis.size();
   for (which = 0; which < sz; which++) {
     if (tryInit (src_ti, *dst_tis[which]).isSuccess())
       return StatusCode::SUCCESS;
   }
  
   // Produce an error message listing the possible destination types.
   std::ostringstream dst_names;
   for (which = 0; which < sz; which++) {
     if (which > 0)
       dst_names << " ";
     dst_names << System::typeinfoName (*dst_tis[which]);
   }
   
   REPORT_MESSAGE (MSG::ERROR)
     << "Incompatible conversion: from " << srcName() << " to one of ["
     << dst_names.str() << "]";
   return StatusCode::FAILURE;
 }

◆ isValid()

bool D3PD::TypeConverter::isValid ( ) const

Test to see if this converter has been properly initialized.

◆ srcName()

std::string D3PD::TypeConverter::srcName ( ) const

Return the name of the source type, or an empty string.

Definition at line 141 of file TypeConverter.cxx.

 {
   if (!m_srcTypeinfo) return "";
   return System::typeinfoName (*m_srcTypeinfo);
 }

◆ srcTypeinfo()

const std::type_info& D3PD::TypeConverter::srcTypeinfo ( ) const

Return the configured source type.

◆ tryInit()

StatusCode D3PD::TypeConverter::tryInit	(	const std::type_info &	src_ti,
		const std::type_info &	dst_ti
	)

private

Initialize the converter.

Parameters

src_ti	The source type for the conversion.
dst_ti	The destination type for the conversion.

The types should be for the pointer value types. I.e, if we want to convert from T* to U*, pass typeid(T) and typeid(U) as src_ti and dst_ti, respectively.

Returns FAILURE if the conversion is not allowable. Either derived -> base or base -> derived conversions are allowed.

Helper: this doesn't print error messages.

Definition at line 172 of file TypeConverter.cxx.

 {
   // Find the source BaseInfo.
   if (!m_srcBIB || m_srcBIB->typeinfo() != src_ti) {
     m_srcTypeinfo = &src_ti;
     m_srcBIB = SG::BaseInfoBase::find (src_ti);
   }
  
   // Find the destination BaseInfo.
   m_dstTypeinfo = &dst_ti;
   m_dstBIB = SG::BaseInfoBase::find (dst_ti);
  
   // Test for source and destination types identical.
   if (m_srcTypeinfo == m_dstTypeinfo) {
     m_strategy = IDENTICAL;
     return StatusCode::SUCCESS;
   }
  
   if (m_srcBIB && m_srcBIB->is_base (*m_dstTypeinfo)) {
     // Destination is a base of source --- use source BaseInfo.
     m_strategy = SRC_BASE;
     return StatusCode::SUCCESS;
   }
  
   if (m_dstBIB && m_dstBIB->is_base (*m_srcTypeinfo)) {
     // Source is a base of destination --- use destination BaseInfo.
     m_strategy = DST_BASE;
     return StatusCode::SUCCESS;
   }
  
   return StatusCode::FAILURE;
 }

Member Data Documentation

◆ m_dstBIB

const SG::BaseInfoBase* D3PD::TypeConverter::m_dstBIB

private

BaseInfo for the destination type.

Definition at line 183 of file TypeConverter.h.

◆ m_dstTypeinfo

const std::type_info* D3PD::TypeConverter::m_dstTypeinfo

private

The destination type.

Definition at line 177 of file TypeConverter.h.

◆ m_srcBIB

const SG::BaseInfoBase* D3PD::TypeConverter::m_srcBIB

private

BaseInfo for the source type.

Definition at line 180 of file TypeConverter.h.

◆ m_srcTypeinfo

const std::type_info* D3PD::TypeConverter::m_srcTypeinfo

private

The source type.

Definition at line 174 of file TypeConverter.h.

◆ m_strategy

Strategy D3PD::TypeConverter::m_strategy

private

Strategy to use for the conversion.

Definition at line 200 of file TypeConverter.h.

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Strategy

Constructor & Destructor Documentation

◆ TypeConverter()

Member Function Documentation

◆ convert()

◆ convertUntyped()

◆ dstName()

◆ dstTypeinfo()

◆ init() [1/3]

◆ init() [2/3]

◆ init() [3/3]

◆ isValid()

◆ srcName()

◆ srcTypeinfo()

◆ tryInit()

Member Data Documentation

◆ m_dstBIB

◆ m_dstTypeinfo

◆ m_srcBIB

◆ m_srcTypeinfo

◆ m_strategy