TProperty< T > Class Template Reference

Templated wrapper around user properties. More...

#include <TProperty.h>

Inheritance diagram for TProperty< T >:

Collaboration diagram for TProperty< T >:

Public Types
enum	Type {   UNKNOWNTYPE, BOOL, INT, FLOAT,   DOUBLE, STRING, INTVECTOR, FLOATVECTOR,   STRINGVECTOR, TOOLHANDLE, TOOLHANDLEARRAY }
	Property type enumeration. More...
typedef std::vector< int >	IntVector
	Convenience type declaration for an integer vector. More...
typedef std::vector< float >	FloatVector
	Convenience type declaration for a float vector. More...
typedef std::vector< std::string >	StringVector
	Convenience type declaration for a string vector. More...

Public Member Functions
	TProperty (T &val, Type type)
	Constructor from a reference and a type. More...
const T *	pointer () const
	Return the address of the property variable. More...
virtual int	setFrom (const Property &rhs)
	Set value using that from another property. More...
virtual StatusCode	getString (std::string &result) const
	get the property as a string More...
virtual StatusCode	getCastString (std::string &result) const
	get the property as a string I can pas to setString More...
virtual StatusCode	setString (const std::string &value)
	set the property from a string More...
int	setFrom (const Property &rhs)
bool	isValid () const
	Return if this is a valid property. More...
Type	type () const
	Return the type index. More...
const std::string &	typeName () const
	Return the type name. More...
Declare specialization(s) for TProperty::setFrom
int	setFrom (const Property &rhs)
	Special handling for strings to interpret the user supplied string. More...

Static Public Member Functions
static const std::string &	name (Type type)
	Function returning a user-readable name for a property type. More...

Private Attributes
T *	m_ptr
	The address of the wrapped variable. More...
Type	m_type
	The type of the property. More...

Detailed Description

template<typename T>
class TProperty< T >

Templated wrapper around user properties.

This class is used to wrap user-defined tool properties, to be able to set them through the PropertyMgr.

Author

David Adams dlada.nosp@m.ms@b.nosp@m.nl.go.nosp@m.v

Revision

802972

Date

2017-04-15 20:13:17 +0200 (Sat, 15 Apr 2017)

Definition at line 28 of file TProperty.h.

Member Typedef Documentation

FloatVector

typedef std::vector< float > Property::FloatVector

inherited

Convenience type declaration for a float vector.

Definition at line 44 of file Property.h.

IntVector

typedef std::vector< int > Property::IntVector

inherited

Convenience type declaration for an integer vector.

Definition at line 42 of file Property.h.

StringVector

typedef std::vector< std::string > Property::StringVector

inherited

Convenience type declaration for a string vector.

Definition at line 46 of file Property.h.

Member Enumeration Documentation

Type

enum Property::Type

inherited

Property type enumeration.

Enumerator
UNKNOWNTYPE
BOOL
INT
FLOAT
DOUBLE
STRING
INTVECTOR
FLOATVECTOR
STRINGVECTOR
TOOLHANDLE
TOOLHANDLEARRAY

Definition at line 27 of file Property.h.

             {
      UNKNOWNTYPE,
      BOOL,
      INT,
      FLOAT,
      DOUBLE,
      STRING,
      INTVECTOR,
      FLOATVECTOR,
      STRINGVECTOR,
      TOOLHANDLE,
      TOOLHANDLEARRAY
   }; // enum Type

Constructor & Destructor Documentation

TProperty()

template<typename T >

TProperty< T >::TProperty	(	T &	val,
		Type	type
	)

Constructor from a reference and a type.

Member Function Documentation

getCastString()

template<typename T >

virtual StatusCode TProperty< T >::getCastString ( std::string &  result ) const

virtual

get the property as a string I can pas to setString

the main difference to getString is that this will not quote strings, i.e. it will assume strings are already properly quoted if they need to be and won't be otherwise. otherwise there will be an issue when setting non-strings from strings the user provided

Guarantee

strong

Failures

no string conversion available

Reimplemented from Property.

getString()

template<typename T >

virtual StatusCode TProperty< T >::getString ( std::string &  result ) const

virtual

get the property as a string

Guarantee

strong

Failures

no string conversion available

Reimplemented from Property.

isValid()

bool Property::isValid ( ) const

inherited

Return if this is a valid property.

Must have a known type.

Definition at line 53 of file Property.cxx.

                             {
 
   return ( m_type != UNKNOWNTYPE );
}

name()

const std::string & Property::name ( Type  type )

staticinherited

Function returning a user-readable name for a property type.

Definition at line 21 of file Property.cxx.

                                           {
 
   switch( type ) {
      DECLARE_TYPE( UNKNOWNTYPE, "unknown" );
      DECLARE_TYPE( BOOL, "bool" );
      DECLARE_TYPE( INT, "int" );
      DECLARE_TYPE( FLOAT, "float" );
      DECLARE_TYPE( DOUBLE, "double" );
      DECLARE_TYPE( STRING, "string" );
      DECLARE_TYPE( INTVECTOR, "vector<int>" );
      DECLARE_TYPE( FLOATVECTOR, "vector<float>" );
      DECLARE_TYPE( STRINGVECTOR, "vector<string>" );
      DECLARE_TYPE( TOOLHANDLE, "ToolHandle" );
      DECLARE_TYPE( TOOLHANDLEARRAY, "ToolHandleArray" );
   default:
      break;
   }
 
   static const std::string dummy( "<error>" );
   return dummy;
}

pointer()

template<typename T >

const T* TProperty< T >::pointer

(

)

const

Return the address of the property variable.

setFrom() [1/3]

template<typename T >

virtual int TProperty< T >::setFrom ( const Property &  rhs )

virtual

Set value using that from another property.

Reimplemented from Property.

setFrom() [2/3]

int TProperty< std::string >::setFrom ( const Property &  rhs )

virtual

Special handling for strings to interpret the user supplied string.

Reimplemented from Property.

setFrom() [3/3]

int TProperty< std::string >::setFrom ( const Property &  rhs )

virtual

Reimplemented from Property.

Definition at line 569 of file TProperty.cxx.

                                                         {
   // Check that we have a valid pointer:
   if( ! this->pointer() ) {
      return 1;
   }
     
   std::string asString;
   if (rhs.getCastString (asString).isFailure())
     return 1;
   return this->setString (asString).isFailure();
}

setString()

template<typename T >

virtual StatusCode TProperty< T >::setString ( const std::string &  value )

virtual

set the property from a string

Guarantee

basic

Failures

no string conversion available
format errors

Reimplemented from Property.

type()

Property::Type Property::type ( ) const

inherited

Return the type index.

Definition at line 58 of file Property.cxx.

                                  {
 
   return m_type;
}

typeName()

const std::string & Property::typeName ( ) const

inherited

Return the type name.

Definition at line 63 of file Property.cxx.

                                          {
 
   return name( m_type );
}

Member Data Documentation

m_ptr

template<typename T >

T* TProperty< T >::m_ptr

private

The address of the wrapped variable.

Definition at line 48 of file TProperty.h.

m_type

Type Property::m_type

privateinherited

The type of the property.

Definition at line 106 of file Property.h.

---

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

• TProperty.h