Property Class Reference

Support class for PropertyMgr. More...

#include <Property.h>

Inheritance diagram for Property:

Collaboration diagram for Property:

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
	Property ()
	Default constructor. More...
	Property (Type type)
	Constructor with a type. More...
virtual	~Property ()
	Destructor. More...
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...
virtual int	setFrom (const Property &rhs)
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...

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

Private Attributes
Type	m_type
	The type of the property. More...

Detailed Description

Support class for PropertyMgr.

Base class for all property types that can be set on a tool.

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 23 of file Property.h.

Member Typedef Documentation

FloatVector

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

Convenience type declaration for a float vector.

Definition at line 44 of file Property.h.

IntVector

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

Convenience type declaration for an integer vector.

Definition at line 42 of file Property.h.

StringVector

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

Convenience type declaration for a string vector.

Definition at line 46 of file Property.h.

Member Enumeration Documentation

Type

enum Property::Type

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

Property() [1/2]

Property::Property

(

)

Default constructor.

Definition at line 43 of file Property.cxx.

   : m_type( UNKNOWNTYPE ) {
 
}

Property() [2/2]

Property::Property

(

Type

type

)

Constructor with a type.

Definition at line 48 of file Property.cxx.

   : m_type( type ) {
 
}

~Property()

virtual Property::~Property ( )

inlinevirtual

Destructor.

Definition at line 56 of file Property.h.

{}

Member Function Documentation

getCastString()

StatusCode Property::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 in TProperty< T >.

Definition at line 81 of file Property.cxx.

                                                      {
  std::cout << "Property::getCastString: method not implemented" << std::endl;
  return StatusCode::FAILURE;
}

getString()

StatusCode Property::getString ( std::string &  result ) const

virtual

get the property as a string

Guarantee

strong

Failures

no string conversion available

Reimplemented in TProperty< T >.

Definition at line 76 of file Property.cxx.

                                                  {
  std::cout << "Property::getString: method not implemented" << std::endl;
  return StatusCode::FAILURE;
}

isValid()

bool Property::isValid

(

)

const

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 )

static

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;
}

setFrom()

int Property::setFrom ( const Property &  rhs )

virtual

Reimplemented in TProperty< T >, TProperty< T >, and TProperty< T >.

Definition at line 68 of file Property.cxx.

                                       {
 
   std::cout << "Property::setFrom: Property not set!" << std::endl;
   return -1;
}

setString()

StatusCode Property::setString ( const std::string &  value )

virtual

set the property from a string

Guarantee

basic

Failures

no string conversion available
format errors

Reimplemented in TProperty< T >.

Definition at line 86 of file Property.cxx.

                                                  {
  std::cout << "Property::setString: method not implemented" << std::endl;
  return StatusCode::FAILURE;
}

type()

Property::Type Property::type

(

)

const

Return the type index.

Definition at line 58 of file Property.cxx.

                                  {
 
   return m_type;
}

typeName()

const std::string & Property::typeName

(

)

const

Return the type name.

Definition at line 63 of file Property.cxx.

                                          {
 
   return name( m_type );
}

Member Data Documentation

m_type

Type Property::m_type

private

The type of the property.

Definition at line 106 of file Property.h.

---

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

• Property.h
• Property.cxx