Class for storing generic metadata. More...

#include <PropertySet.h>

Inheritance diagram for lsst::daf::base::PropertySet:

Public Types
typedef boost::shared_ptr < PropertySet >	Ptr

typedef boost::shared_ptr < PropertySet const >	ConstPtr

Public Types inherited from lsst::daf::base::Persistable
typedef boost::shared_ptr < Persistable >	Ptr

Public Types inherited from lsst::daf::base::Citizen
enum	{ magicSentinel = 0xdeadbeef }

typedef unsigned long	memId
	Type of the block's ID. More...

typedef memId(*	memNewCallback )(const memId cid)
	A function used to register a callback. More...

typedef memId(*	memCallback )(const Citizen *ptr)

Public Member Functions
	PropertySet (bool flat=false)

virtual	~PropertySet (void)

virtual Ptr	deepCopy (void) const

size_t	nameCount (bool topLevelOnly=true) const

std::vector< std::string >	names (bool topLevelOnly=true) const

std::vector< std::string >	paramNames (bool topLevelOnly=true) const

std::vector< std::string >	propertySetNames (bool topLevelOnly=true) const

bool	exists (std::string const &name) const

bool	isArray (std::string const &name) const

bool	isPropertySetPtr (std::string const &name) const

size_t	valueCount (std::string const &name) const

std::type_info const &	typeOf (std::string const &name) const

template<typename T >
T	get (std::string const &name) const

template<typename T >
T	get (std::string const &name, T const &defaultValue) const

template<typename T >
std::vector< T >	getArray (std::string const &name) const

bool	getAsBool (std::string const &name) const

int	getAsInt (std::string const &name) const

int64_t	getAsInt64 (std::string const &name) const

double	getAsDouble (std::string const &name) const

std::string	getAsString (std::string const &name) const

PropertySet::Ptr	getAsPropertySetPtr (std::string const &name) const

Persistable::Ptr	getAsPersistablePtr (std::string const &name) const

virtual std::string	toString (bool topLevelOnly=false, std::string const &indent="") const

template<typename T >
void	set (std::string const &name, T const &value)

template<typename T >
void	set (std::string const &name, std::vector< T > const &value)

void	set (std::string const &name, char const *value)

template<typename T >
void	add (std::string const &name, T const &value)

template<typename T >
void	add (std::string const &name, std::vector< T > const &value)

void	add (std::string const &name, char const *value)

virtual void	copy (std::string const &dest, ConstPtr source, std::string const &name)

virtual void	combine (ConstPtr source)

virtual void	remove (std::string const &name)

template<typename T >
vector< T >	getArray (string const &name) const

Public Member Functions inherited from lsst::daf::base::Persistable
	Persistable (void)

virtual	~Persistable (void)

template<class Archive >
void	serialize (Archive &, unsigned int const)

Public Member Functions inherited from lsst::daf::base::Citizen
	Citizen (const std::type_info &)

	Citizen (Citizen const &)

	~Citizen ()

Citizen &	operator= (Citizen const &)

std::string	repr () const
	Return a string representation of a Citizen. More...

void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...

memId	getId () const
	Return the Citizen's ID. More...

Protected Member Functions
virtual void	_set (std::string const &name, boost::shared_ptr< std::vector< boost::any > > vp)

virtual void	_add (std::string const &name, boost::shared_ptr< std::vector< boost::any > > vp)

virtual std::string	_format (std::string const &name) const

Private Types
typedef std::tr1::unordered_map < std::string, boost::shared_ptr< std::vector < boost::any > > >	AnyMap

Private Member Functions
AnyMap::iterator	_find (std::string const &name)

AnyMap::const_iterator	_find (std::string const &name) const

virtual void	_findOrInsert (std::string const &name, boost::shared_ptr< std::vector< boost::any > > vp)

void	_cycleCheckPtrVec (std::vector< Ptr > const &v, std::string const &name)

void	_cycleCheckAnyVec (std::vector< boost::any > const &v, std::string const &name)

void	_cycleCheckPtr (Ptr const &v, std::string const &name)

Private Attributes
AnyMap	_map

bool	_flat

Additional Inherited Members
Static Public Member Functions inherited from lsst::daf::base::Citizen
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...

static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...

static int	init ()
	Called once when the memory system is being initialised. More...

static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...

static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...

static const std::vector < const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...

static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...

static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...

static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...

static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...

static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Detailed Description

Class for storing generic metadata.

This class stores key/value pairs, like a Python dictionary but in C++. Keys are always C++ strings. Values can be C++ primitive data types, strings, lsst::daf::base::DateTime objects, and lsst::daf::base::Persistable subclasses (although the latter is currently discouraged). Values can also be vectors of these items.

PropertySets are hierarchical; values within a PropertySet that is contained within another PropertySet can be addressed using dotted paths ("a.b.c"). If "flat=true" is specified to the constructor, the PropertySet still takes dotted paths but is not actually hierarchical in structure. This is used to support PropertyList.

Definition at line 82 of file PropertySet.h.

Member Typedef Documentation

typedef std::tr1::unordered_map<std::string, boost::shared_ptr< std::vector<boost::any> > > lsst::daf::base::PropertySet::AnyMap

private

Definition at line 167 of file PropertySet.h.

typedef boost::shared_ptr<PropertySet const> lsst::daf::base::PropertySet::ConstPtr

Definition at line 91 of file PropertySet.h.

typedef boost::shared_ptr<PropertySet> lsst::daf::base::PropertySet::Ptr

Definition at line 90 of file PropertySet.h.

Constructor & Destructor Documentation

lsst::daf::base::PropertySet::PropertySet ( bool flat = false )

explicit

Constructor.

Parameters

[in] flat false (default) = flatten hierarchy by ignoring dots in names

Definition at line 55 of file PropertySet.cc.

55 : Citizen(typeid(*this)), _flat(flat) {

56 }

lsst::daf::base::PropertySet::_flat

bool _flat

Definition: PropertySet.h:179

lsst::daf::base::Citizen::Citizen

Citizen(const std::type_info &)

Definition: Citizen.cc:173

lsst::daf::base::PropertySet::~PropertySet ( void )

virtual

Destructor.

Definition at line 60 of file PropertySet.cc.

60 {

61 }

Member Function Documentation

void lsst::daf::base::PropertySet::_add	(	std::string const &	name,
		boost::shared_ptr< std::vector< boost::any > >	vp
	)

protectedvirtual

Finds the property name (possibly hierarchical) and appends or sets its value with the given vector of values.

Parameters

[in]	name	Property name to find, possibly hierarchical.
[in]	vp	shared_ptr to vector of values.

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 848 of file PropertySet.cc.

                                                                       {
 
     AnyMap::const_iterator dp = _find(name);
     if (dp == _map.end()) {
         _set(name, vp);
     }
     else {
         if (vp->back().type() != dp->second->back().type()) {
             throw LSST_EXCEPT(pexExcept::TypeError,
                               name + " has mismatched type");
         }
         // Check for cycles
         if (vp->back().type() == typeid(Ptr)) {
             _cycleCheckAnyVec(*vp, name);
         }
         dp->second->insert(dp->second->end(), vp->begin(), vp->end());
     }
 }

void lsst::daf::base::PropertySet::_cycleCheckAnyVec	(	std::vector< boost::any > const &	v,
		std::string const &	name
	)

private

Definition at line 929 of file PropertySet.cc.

                                                                 {
     for (vector<boost::any>::const_iterator i = v.begin(); i != v.end(); ++i) {
         _cycleCheckPtr(boost::any_cast<Ptr>(*i), name);
     }
 }

void lsst::daf::base::PropertySet::_cycleCheckPtr	(	Ptr const &	v,
		std::string const &	name
	)

private

Definition at line 936 of file PropertySet.cc.

                                                                 {
     if (v.get() == this) {
         throw LSST_EXCEPT(pexExcept::InvalidParameterError,
                           name + " would cause a cycle");
     }
     vector<string> sets = v->propertySetNames(false);
     for (vector<string>::const_iterator i = sets.begin();
          i != sets.end(); ++i) {
         if (v->getAsPropertySetPtr(*i).get() == this) {
             throw LSST_EXCEPT(pexExcept::InvalidParameterError,
                               name + " would cause a cycle");
         }
     }
 }

void lsst::daf::base::PropertySet::_cycleCheckPtrVec	(	std::vector< Ptr > const &	v,
		std::string const &	name
	)

private

Definition at line 922 of file PropertySet.cc.

                                                                 {
     for (vector<Ptr>::const_iterator i = v.begin(); i != v.end(); ++i) {
         _cycleCheckPtr(*i, name);
     }
 }

dafBase::PropertySet::AnyMap::iterator lsst::daf::base::PropertySet::_find ( std::string const & name )

private

Finds the property name (possibly hierarchical).

Parameters

[in] name Property name to find, possibly hierarchical.

Returns: unordered_map::iterator to the property or end() if nonexistent.

Definition at line 781 of file PropertySet.cc.

                                                {
     string::size_type i = name.find('.');
     if (_flat || i == name.npos) {
         return _map.find(name);
     }
     string prefix(name, 0, i);
     AnyMap::iterator j = _map.find(prefix);
     if (j == _map.end() || j->second->back().type() != typeid(Ptr)) {
         return _map.end();
     }
     Ptr p = boost::any_cast<Ptr>(j->second->back());
     if (p.get() == 0) {
         return _map.end();
     }
     string suffix(name, i + 1);
     AnyMap::iterator x = p->_find(suffix);
     if (x == p->_map.end()) {
         return _map.end();
     }
     return x;
 }

dafBase::PropertySet::AnyMap::const_iterator lsst::daf::base::PropertySet::_find ( std::string const & name ) const

private

Finds the property name (possibly hierarchical). Const version.

Parameters

[in] name Property name to find, possibly hierarchical.

Returns: unordered_map::const_iterator to the property or end().

Definition at line 808 of file PropertySet.cc.

                                                      {
     string::size_type i = name.find('.');
     if (_flat || i == name.npos) {
         return _map.find(name);
     }
     string prefix(name, 0, i);
     AnyMap::const_iterator j = _map.find(prefix);
     if (j == _map.end() || j->second->back().type() != typeid(Ptr)) {
         return _map.end();
     }
     Ptr p = boost::any_cast<Ptr>(j->second->back());
     if (p.get() == 0) {
         return _map.end();
     }
     string suffix(name, i + 1);
     AnyMap::const_iterator x = p->_find(suffix);
     if (x == p->_map.end()) {
         return _map.end();
     }
     return x;
 }

void lsst::daf::base::PropertySet::_findOrInsert	(	std::string const &	name,
		boost::shared_ptr< std::vector< boost::any > >	vp
	)

privatevirtual

Finds the property name (possibly hierarchical) and sets or replaces its value with the given vector of values.

Parameters

[in]	name	Property name to find, possibly hierarchical.
[in]	vp	shared_ptr to vector of values.

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 874 of file PropertySet.cc.

                                                                       {
     if (vp->back().type() == typeid(Ptr)) {
         if (_flat) {
             Ptr source = boost::any_cast<Ptr>(vp->back());
             vector<string> names = source->paramNames(false);
             for (vector<string>::const_iterator i = names.begin();
                  i != names.end(); ++i) {
                 AnyMap::const_iterator sp = source->_find(*i);
                 _add(name + "." + *i, sp->second);
             }
             return;
         }
 
         // Check for cycles
         _cycleCheckAnyVec(*vp, name);
     }
 
     string::size_type i = name.find('.');
     if (_flat || i == name.npos) {
         _map[name] = vp;
         return;
     }
     string prefix(name, 0, i);
     string suffix(name, i + 1);
     AnyMap::iterator j = _map.find(prefix);
     if (j == _map.end()) {
         PropertySet::Ptr pp(new PropertySet);
         pp->_findOrInsert(suffix, vp);
         boost::shared_ptr< vector<boost::any> > temp(new vector<boost::any>);
         temp->push_back(pp);
         _map[prefix] = temp;
         return;
     }
     else if (j->second->back().type() != typeid(Ptr)) {
         throw LSST_EXCEPT(pexExcept::InvalidParameterError,
                           prefix +
                           " exists but does not contain PropertySet::Ptrs");
     }
     Ptr p = boost::any_cast<Ptr>(j->second->back());
     if (p.get() == 0) {
         throw LSST_EXCEPT(pexExcept::InvalidParameterError,
                           prefix +
                           " exists but contains null PropertySet::Ptr");
     }
     p->_findOrInsert(suffix, vp);
 }

std::string lsst::daf::base::PropertySet::_format ( std::string const & name ) const

protectedvirtual

Definition at line 507 of file PropertySet.cc.

                                                                  {
     ostringstream s;
     s << std::showpoint; // Always show a decimal point for floats
     AnyMap::const_iterator j = _map.find(name);
     s << j->first << " = ";
     boost::shared_ptr< vector<boost::any> > vp = j->second;
     if (vp->size() > 1) {
         s << "[ ";
     }
     type_info const& t = vp->back().type();
     for (vector<boost::any>::const_iterator k = vp->begin();
          k != vp->end(); ++k) {
         if (k != vp->begin()) {
             s << ", ";
         }
         boost::any const& v(*k);
         if (t == typeid(bool)) {
             s << boost::any_cast<bool>(v);
         } else if (t == typeid(char)) {
             s << '\'' << boost::any_cast<char>(v) << '\'';
         } else if (t == typeid(signed char)) {
             s << '\'' << boost::any_cast<signed char>(v) << '\'';
         } else if (t == typeid(unsigned char)) {
             s << '\'' << boost::any_cast<unsigned char>(v) << '\'';
         } else if (t == typeid(short)) {
             s << boost::any_cast<short>(v);
         } else if (t == typeid(unsigned short)) {
             s << boost::any_cast<unsigned short>(v);
         } else if (t == typeid(int)) {
             s << boost::any_cast<int>(v);
         } else if (t == typeid(unsigned int)) {
             s << boost::any_cast<unsigned int>(v);
         } else if (t == typeid(long)) {
             s << boost::any_cast<long>(v);
         } else if (t == typeid(unsigned long)) {
             s << boost::any_cast<unsigned long>(v);
         } else if (t == typeid(long long)) {
             s << boost::any_cast<long long>(v);
         } else if (t == typeid(unsigned long long)) {
             s << boost::any_cast<unsigned long long>(v);
         } else if (t == typeid(float)) {
             s << std::setprecision(7) << boost::any_cast<float>(v);
         } else if (t == typeid(double)) {
             s << std::setprecision(14) << boost::any_cast<double>(v);
         } else if (t == typeid(string)) {
             s << '"' << boost::any_cast<string>(v) << '"';
         } else if (t == typeid(dafBase::DateTime)) {
             s << boost::any_cast<dafBase::DateTime>(v).toString();
         } else if (t == typeid(Ptr)) {
             s << "{ ... }";
         } else if (t == typeid(Persistable::Ptr)) {
             s << "<Persistable>";
         } else {
             s << "<Unknown>";
         }
     }
     if (j->second->size() > 1) {
         s << " ]";
     }
     s << endl;
     return s.str();
 }

void lsst::daf::base::PropertySet::_set	(	std::string const &	name,
		boost::shared_ptr< std::vector< boost::any > >	vp
	)

protectedvirtual

Finds the property name (possibly hierarchical) and sets or replaces its value with the given vector of values. Hook for subclass overrides of top-level setting.

Parameters

[in]	name	Property name to find, possibly hierarchical.
[in]	vp	shared_ptr to vector of values.

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Reimplemented in lsst::daf::base::PropertyList.

Definition at line 837 of file PropertySet.cc.

                                                                       {
     _findOrInsert(name, vp);
 }

template<typename T >

void lsst::daf::base::PropertySet::add	(	std::string const &	name,
		T const &	value
	)

Appends a single value to the vector of values for a property name (possibly hierarchical). Sets the value if the property does not exist.

Parameters

[in]	name	Property name to append to, possibly hierarchical.
[in]	value	Value to append.

Exceptions

TypeError	Type does not match existing values.
InvalidParameterError	Hierarchical name uses non-PropertySet.

Definition at line 619 of file PropertySet.cc.

                                                                   {
     AnyMap::iterator i = _find(name);
     if (i == _map.end()) {
         set(name, value);
     }
     else {
         if (i->second->back().type() != typeid(T)) {
             throw LSST_EXCEPT(pexExcept::TypeError,
                               name + " has mismatched type");
         }
         i->second->push_back(value);
     }
 }

template<typename T >

void lsst::daf::base::PropertySet::add	(	std::string const &	name,
		std::vector< T > const &	value
	)

Appends a vector of values to the vector of values for a property name (possibly hierarchical). Sets the values if the property does not exist.

Parameters

[in]	name	Property name to append to, possibly hierarchical.
[in]	value	Vector of values to append.

Exceptions

TypeError	Type does not match existing values.
InvalidParameterError	Hierarchical name uses non-PropertySet.

Note: May only partially add the vector if an exception occurs.

Definition at line 660 of file PropertySet.cc.

                                                        {
     AnyMap::iterator i = _find(name);
     if (i == _map.end()) {
         set(name, value);
     }
     else {
         if (i->second->back().type() != typeid(T)) {
             throw LSST_EXCEPT(pexExcept::TypeError,
                               name + " has mismatched type");
         }
         i->second->insert(i->second->end(), value.begin(), value.end());
     }
 }

void lsst::daf::base::PropertySet::add	(	std::string const &	name,
		char const *	value
	)

Appends a char const* value to the vector of values for a property name (possibly hierarchical). Sets the value if the property does not exist.

Parameters

[in]	name	Property name to append to, possibly hierarchical.
[in]	value	Character string value to append.

Exceptions

TypeError	Type does not match existing values.
InvalidParameterError	Hierarchical name uses non-PropertySet.

Definition at line 700 of file PropertySet.cc.

                                                                      {
     add(name, string(value));
 }

void lsst::daf::base::PropertySet::combine ( ConstPtr source )

virtual

Appends all value vectors from the source to their corresponding properties. Sets values if a property does not exist.

Parameters

[in] source PropertySet::Ptr for the source PropertySet.

Exceptions

TypeError	Type does not match existing values.
InvalidParameterError	Hierarchical name uses non-PropertySet.

Note: May only partially combine the PropertySets if an exception occurs.

Reimplemented in lsst::daf::base::PropertyList.

Definition at line 738 of file PropertySet.cc.

                                                 {
     if (source.get() == 0) {
         return;
     }
     vector<string> names = source->paramNames(false);
     for (vector<string>::const_iterator i = names.begin();
          i != names.end(); ++i) {
         AnyMap::const_iterator sp = source->_find(*i);
         _add(*i, sp->second);
     }
 }

void lsst::daf::base::PropertySet::copy	(	std::string const &	dest,
		ConstPtr	source,
		std::string const &	name
	)

virtual

Replaces a single value vector in the destination with one from the source.

Parameters

[in]	dest	Destination property name.
[in]	source	PropertySet::Ptr for the source PropertySet.
[in]	name	Property name to extract.

Exceptions

TypeError	Type does not match existing values.
InvalidParameterError	Name does not exist in source.
InvalidParameterError	Hierarchical name uses non-PropertySet.

Reimplemented in lsst::daf::base::PropertyList.

Definition at line 713 of file PropertySet.cc.

                                                                         {
     if (source.get() == 0) {
         throw LSST_EXCEPT(pexExcept::InvalidParameterError,
                           "Missing source");
     }
     AnyMap::const_iterator sj = source->_find(name);
     if (sj == source->_map.end()) {
         throw LSST_EXCEPT(pexExcept::InvalidParameterError,
                           name + " not in source");
     }
     remove(dest);
     boost::shared_ptr< vector<boost::any> > vp(
         new vector<boost::any>(*(sj->second)));
     _set(dest, vp);
 }

dafBase::PropertySet::Ptr lsst::daf::base::PropertySet::deepCopy ( void ) const

virtual

Copy the PropertySet and all of its contents.

Returns: PropertySet::Ptr pointing to the new copy.

Reimplemented in lsst::daf::base::PropertyList.

Definition at line 70 of file PropertySet.cc.

                                                              {
     Ptr n(new PropertySet(_flat));
     for (AnyMap::const_iterator i = _map.begin(); i != _map.end(); ++i) {
         if (i->second->back().type() == typeid(Ptr)) {
             for (vector<boost::any>::const_iterator j =
                  i->second->begin(); j != i->second->end(); ++j) {
                 Ptr p = boost::any_cast<Ptr>(*j);
                 if (p.get() == 0) {
                     n->add(i->first, Ptr());
                 } else {
                     n->add(i->first, p->deepCopy());
                 }
             }
         } else {
             boost::shared_ptr< vector<boost::any> > vp(
                 new vector<boost::any>(*(i->second)));
             n->_map[i->first] = vp;
         }
     }
     return n;
 }

bool lsst::daf::base::PropertySet::exists ( std::string const & name ) const

Determine if a name (possibly hierarchical) exists.

Parameters

[in] name Property name to examine, possibly hierarchical.

Returns: true if property exists.

Definition at line 190 of file PropertySet.cc.

                                                            {
     return _find(name) != _map.end();
 }

template<typename T >

T lsst::daf::base::PropertySet::get ( std::string const & name ) const

Get the last value for a property name (possibly hierarchical). Note that the type must be explicitly specified for this template:

int i = propertySet.get<int>("foo")

Parameters

[in] name Property name to examine, possibly hierarchical.

Returns: Last value set or added.

Exceptions

NotFoundError	Property does not exist.
TypeError	Value does not match desired type.

Definition at line 246 of file PropertySet.cc.

                                                   { /* parasoft-suppress LsstDm-3-4a LsstDm-4-6 "allow template over bool" */
     AnyMap::const_iterator i = _find(name);
     if (i == _map.end()) {
         throw LSST_EXCEPT(pexExcept::NotFoundError, name + " not found");
     }
     try {
         return boost::any_cast<T>(i->second->back());
     }
     catch (boost::bad_any_cast) {
         throw LSST_EXCEPT(pexExcept::TypeError, name);
     }
     // not reached
     return boost::any_cast<T>(i->second->back());
 }

template<typename T >

T lsst::daf::base::PropertySet::get	(	std::string const &	name,
		T const &	defaultValue
	)		const

Get the last value for a property name (possibly hierarchical). Returns the provided defaultValue if the property does not exist. Note that the type must be explicitly specified for this template:

int i = propertySet.get<int>("foo", 42)

Parameters

[in]	name	Property name to examine, possibly hierarchical.
[in]	defaultValue	Default value to return if property does not exist.

Returns: Last value set or added.

Exceptions

TypeError Value does not match desired type.

Definition at line 271 of file PropertySet.cc.

                                                                          { /* parasoft-suppress LsstDm-3-4a LsstDm-4-6 "allow template over bool" */
     AnyMap::const_iterator i = _find(name);
     if (i == _map.end()) {
         return defaultValue;
     }
     try {
         return boost::any_cast<T>(i->second->back());
     }
     catch (boost::bad_any_cast) {
         throw LSST_EXCEPT(pexExcept::TypeError, name);
     }
     // not reached
     return boost::any_cast<T>(i->second->back());
 }

template<typename T >

std::vector<T> lsst::daf::base::PropertySet::getArray ( std::string const & name ) const

template<typename T >

vector<T> lsst::daf::base::PropertySet::getArray ( string const & name ) const

Get the vector of values for a property name (possibly hierarchical). Note that the type must be explicitly specified for this template:

vector<int> v = propertySet.getArray<int>("foo")

Parameters

[in] name Property name to examine, possibly hierarchical.

Returns: Vector of values.

Exceptions

NotFoundError	Property does not exist.
TypeError	Value does not match desired type.

Definition at line 295 of file PropertySet.cc.

                                                                {
     AnyMap::const_iterator i = _find(name);
     if (i == _map.end()) {
         throw LSST_EXCEPT(pexExcept::NotFoundError, name + " not found");
     }
     vector<T> v;
     for (vector<boost::any>::const_iterator j = i->second->begin();
          j != i->second->end(); ++j) {
         try {
             v.push_back(boost::any_cast<T>(*j));
         }
         catch (boost::bad_any_cast) {
             throw LSST_EXCEPT(pexExcept::TypeError, name);
         }
     }
     return v;
 }

bool lsst::daf::base::PropertySet::getAsBool ( std::string const & name ) const

Get the last value for a bool property name (possibly hierarchical).

Parameters

[in] name Property name to examine, possibly hierarchical.

Returns: Value as a bool.

Exceptions

NotFoundError	Property does not exist.
TypeError	Value is not a bool.

Definition at line 321 of file PropertySet.cc.

                                                               { /* parasoft-suppress LsstDm-3-4a LsstDm-4-6 "for symmetry with other types" */
     return get<bool>(name);
 }

double lsst::daf::base::PropertySet::getAsDouble ( std::string const & name ) const

Get the last value for any arithmetic property name (possibly hierarchical).

Parameters

[in] name Property name to examine, possibly hierarchical.

Returns: Value as a double.

Exceptions

NotFoundError	Property does not exist.
TypeError	Value cannot be converted to double.

Definition at line 406 of file PropertySet.cc.

                                                                   {
     AnyMap::const_iterator i = _find(name);
     if (i == _map.end()) {
         throw LSST_EXCEPT(pexExcept::NotFoundError, name + " not found");
     }
     boost::any v = i->second->back();
     type_info const& t = v.type();
     if (t == typeid(bool)) return boost::any_cast<bool>(v);
     if (t == typeid(char)) return boost::any_cast<char>(v);
     if (t == typeid(signed char)) return boost::any_cast<signed char>(v);
     if (t == typeid(unsigned char)) return boost::any_cast<unsigned char>(v);
     if (t == typeid(short)) return boost::any_cast<short>(v);
     if (t == typeid(unsigned short)) return boost::any_cast<unsigned short>(v);
     if (t == typeid(int)) return boost::any_cast<int>(v);
     if (t == typeid(unsigned int)) return boost::any_cast<unsigned int>(v);
     if (t == typeid(long)) return boost::any_cast<long>(v);
     if (t == typeid(unsigned long)) return boost::any_cast<unsigned long>(v);
     if (t == typeid(long long)) return boost::any_cast<long long>(v);
     if (t == typeid(unsigned long long)) return boost::any_cast<unsigned long long>(v);
     if (t == typeid(float)) return boost::any_cast<float>(v);
     try {
         return boost::any_cast<double>(v);
     }
     catch (boost::bad_any_cast) {
         throw LSST_EXCEPT(pexExcept::TypeError, name);
     }
     // not reached
     return boost::any_cast<double>(v);
 }

int lsst::daf::base::PropertySet::getAsInt ( std::string const & name ) const

Get the last value for a bool/char/short/int property name (possibly hierarchical). Unsigned int properties are not acceptable, but unsigned versions of smaller types are.

Parameters

[in] name Property name to examine, possibly hierarchical.

Returns: Value as an int.

Exceptions

NotFoundError	Property does not exist.
TypeError	Value cannot be converted to int.

Definition at line 333 of file PropertySet.cc.

                                                             {
     AnyMap::const_iterator i = _find(name);
     if (i == _map.end()) {
         throw LSST_EXCEPT(pexExcept::NotFoundError, name + " not found");
     }
     boost::any v = i->second->back();
     type_info const& t = v.type();
     if (t == typeid(bool)) {
         return boost::any_cast<bool>(v);
     } else if (t == typeid(char)) {
         return boost::any_cast<char>(v);
     } else if (t == typeid(signed char)) {
         return boost::any_cast<signed char>(v);
     } else if (t == typeid(unsigned char)) {
         return boost::any_cast<unsigned char>(v);
     } else if (t == typeid(short)) {
         return boost::any_cast<short>(v);
     } else if (t == typeid(unsigned short)) {
         return boost::any_cast<unsigned short>(v);
     }
     try {
         return boost::any_cast<int>(v);
     }
     catch (boost::bad_any_cast) {
         throw LSST_EXCEPT(pexExcept::TypeError, name);
     }
     // not reached
     return boost::any_cast<int>(v);
 }

int64_t lsst::daf::base::PropertySet::getAsInt64 ( std::string const & name ) const

Get the last value for a bool/char/short/int/int64_t property name (possibly hierarchical). Unsigned int64_t properties are not acceptable, but unsigned versions of smaller types are, except possibly unsigned long, depending on compiler.

Parameters

[in] name Property name to examine, possibly hierarchical.

Returns: Value as an int64_t.

Exceptions

NotFoundError	Property does not exist.
TypeError	Value cannot be converted to int64_t.

Definition at line 372 of file PropertySet.cc.

                                                                   {
     AnyMap::const_iterator i = _find(name);
     if (i == _map.end()) {
         throw LSST_EXCEPT(pexExcept::NotFoundError, name + " not found");
     }
     boost::any v = i->second->back();
     type_info const& t = v.type();
     if (t == typeid(bool)) return boost::any_cast<bool>(v);
     if (t == typeid(char)) return boost::any_cast<char>(v);
     if (t == typeid(signed char)) return boost::any_cast<signed char>(v);
     if (t == typeid(unsigned char)) return boost::any_cast<unsigned char>(v);
     if (t == typeid(short)) return boost::any_cast<short>(v);
     if (t == typeid(unsigned short)) return boost::any_cast<unsigned short>(v);
     if (t == typeid(int)) return boost::any_cast<int>(v);
     if (t == typeid(unsigned int)) return boost::any_cast<unsigned int>(v);
     if (t == typeid(long)) return boost::any_cast<long>(v);
     if (t == typeid(long long)) return boost::any_cast<long long>(v);
     try {
         return boost::any_cast<int64_t>(v);
     }
     catch (boost::bad_any_cast) {
         throw LSST_EXCEPT(pexExcept::TypeError, name);
     }
     // not reached
     return boost::any_cast<int64_t>(v);
 }

dafBase::Persistable::Ptr lsst::daf::base::PropertySet::getAsPersistablePtr ( std::string const & name ) const

Get the last value for a Persistable name (possibly hierarchical).

Parameters

[in] name Property name to examine, possibly hierarchical.

Returns: Persistable::Ptr value.

Exceptions

NotFoundError	Property does not exist.
TypeError	Value is not a Persistable::Ptr.

Definition at line 466 of file PropertySet.cc.

                                                                    {
     return get<Persistable::Ptr>(name);
 }

dafBase::PropertySet::Ptr lsst::daf::base::PropertySet::getAsPropertySetPtr ( std::string const & name ) const

Get the last value for a subproperty name (possibly hierarchical).

Parameters

[in] name Property name to examine, possibly hierarchical.

Returns: PropertySet::Ptr value.

Exceptions

NotFoundError	Property does not exist.
TypeError	Value is not a PropertySet::Ptr.

Definition at line 455 of file PropertySet.cc.

                                                                    {
     return get<Ptr>(name);
 }

std::string lsst::daf::base::PropertySet::getAsString ( std::string const & name ) const

Get the last value for a string property name (possibly hierarchical). Note that properties set with char const* can be retrieved as strings using this method.

Parameters

[in] name Property name to examine, possibly hierarchical.

Returns: String value.

Exceptions

NotFoundError	Property does not exist.
TypeError	Value is not a string.

Definition at line 444 of file PropertySet.cc.

                                                                      {
     return get<string>(name);
 }

bool lsst::daf::base::PropertySet::isArray ( std::string const & name ) const

Determine if a name (possibly hierarchical) has multiple values.

Parameters

[in] name Property name to examine, possibly hierarchical.

Returns: true if property exists and has more than one value.

Definition at line 198 of file PropertySet.cc.

                                                             {
     AnyMap::const_iterator i = _find(name);
     return i != _map.end() && i->second->size() > 1U;
 }

bool lsst::daf::base::PropertySet::isPropertySetPtr ( std::string const & name ) const

Determine if a name (possibly hierarchical) is a subproperty.

Parameters

[in] name Property name to examine, possibly hierarchical.

Returns: true if property exists and its values are PropertySet::Ptrs.

Definition at line 207 of file PropertySet.cc.

                                                                      {
     AnyMap::const_iterator i = _find(name);
     return i != _map.end() && i->second->back().type() == typeid(Ptr);
 }

size_t lsst::daf::base::PropertySet::nameCount ( bool topLevelOnly = true ) const

Get the number of names in the PropertySet, optionally including those in subproperties. The name of the subproperty is counted in that case.

Parameters

[in] topLevelOnly true (default) = don't include subproperties.

Returns: Number of names.

Definition at line 97 of file PropertySet.cc.

                                                             {
     int n = 0;
     for (AnyMap::const_iterator i = _map.begin(); i != _map.end(); ++i) {
         ++n;
         if (!topLevelOnly && i->second->back().type() == typeid(Ptr)) {
             Ptr p = boost::any_cast<Ptr>(i->second->back());
             if (p.get() != 0) {
                 n += p->nameCount(false);
             }
         }
     }
     return n;
 }

vector< string > lsst::daf::base::PropertySet::names ( bool topLevelOnly = true ) const

Get the names in the PropertySet, optionally including those in subproperties. The name of the subproperty is included in that case. Hierarchical subproperty names are separated by a period.

Parameters

[in] topLevelOnly true (default) = don't include subproperties.

Returns: Vector of names.

Definition at line 117 of file PropertySet.cc.

                                                                 {
     vector<string> v;
     for (AnyMap::const_iterator i = _map.begin(); i != _map.end(); ++i) {
         v.push_back(i->first);
         if (!topLevelOnly && i->second->back().type() == typeid(Ptr)) {
             Ptr p = boost::any_cast<Ptr>(i->second->back());
             if (p.get() != 0) {
                 vector<string> w = p->names(false);
                 for (vector<string>::const_iterator k = w.begin();
                      k != w.end(); ++k) {
                     v.push_back(i->first + "." + *k);
                 }
             }
         }
     }
     return v;
 }

vector< string > lsst::daf::base::PropertySet::paramNames ( bool topLevelOnly = true ) const

Get the names of parameters (non-subproperties) in the PropertySet, optionally including those in subproperties. Hierarchical subproperty names are separated by a period.

Parameters

[in] topLevelOnly true (default) = don't include subproperties.

Returns: Vector of parameter names.

Definition at line 142 of file PropertySet.cc.

                                                       {
     vector<string> v;
     for (AnyMap::const_iterator i = _map.begin(); i != _map.end(); ++i) {
         if (i->second->back().type() == typeid(Ptr)) {
             Ptr p = boost::any_cast<Ptr>(i->second->back());
             if (p.get() != 0 && !topLevelOnly) {
                 vector<string> w = p->paramNames(false);
                 for (vector<string>::const_iterator k = w.begin();
                      k != w.end(); ++k) {
                     v.push_back(i->first + "." + *k);
                 }
             }
         } else {
             v.push_back(i->first);
         }
     }
     return v;
 }

vector< string > lsst::daf::base::PropertySet::propertySetNames ( bool topLevelOnly = true ) const

Get the names of subproperties in the PropertySet, optionally including those in subproperties. Hierarchical subproperty names are separated by a period.

Parameters

[in] topLevelOnly true (default) = don't include subproperties.

Returns: Vector of subproperty names.

Definition at line 168 of file PropertySet.cc.

                                                             {
     vector<string> v;
     for (AnyMap::const_iterator i = _map.begin(); i != _map.end(); ++i) {
         if (i->second->back().type() == typeid(Ptr)) {
             v.push_back(i->first);
             Ptr p = boost::any_cast<Ptr>(i->second->back());
             if (p.get() != 0 && !topLevelOnly) {
                 vector<string> w = p->propertySetNames(false);
                 for (vector<string>::const_iterator k = w.begin();
                      k != w.end(); ++k) {
                     v.push_back(i->first + "." + *k);
                 }
             }
         }
     }
     return v;
 }

void lsst::daf::base::PropertySet::remove ( std::string const & name )

virtual

Removes all values for a property name (possibly hierarchical). Does nothing if the property does not exist.

Parameters

[in] name Property name to remove, possibly hierarchical.

Reimplemented in lsst::daf::base::PropertyList.

Definition at line 754 of file PropertySet.cc.

                                                      {
     string::size_type i = name.find('.');
     if (_flat || i == name.npos) {
         _map.erase(name);
         return;
     }
     string prefix(name, 0, i);
     AnyMap::iterator j = _map.find(prefix);
     if (j == _map.end() || j->second->back().type() != typeid(Ptr)) {
         return;
     }
     Ptr p = boost::any_cast<Ptr>(j->second->back());
     if (p.get() != 0) {
         string suffix(name, i + 1);
         p->remove(suffix);
     }
 }

template<typename T >

void lsst::daf::base::PropertySet::set	(	std::string const &	name,
		T const &	value
	)

Replace all values for a property name (possibly hierarchical) with a new value.

Parameters

[in]	name	Property name to set, possibly hierarchical.
[in]	value	Value to set.

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 581 of file PropertySet.cc.

                                                                   {
     boost::shared_ptr< vector<boost::any> > vp(new vector<boost::any>);
     vp->push_back(value);
     _set(name, vp);
 }

template<typename T >

void lsst::daf::base::PropertySet::set	(	std::string const &	name,
		std::vector< T > const &	value
	)

Replace all values for a property name (possibly hierarchical) with a vector of new values.

Parameters

[in]	name	Property name to set, possibly hierarchical.
[in]	value	Vector of values to set.

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 594 of file PropertySet.cc.

                                                        {
     if (value.empty()) return;
     boost::shared_ptr< vector<boost::any> > vp(new vector<boost::any>);
     vp->insert(vp->end(), value.begin(), value.end());
     _set(name, vp);
 }

void lsst::daf::base::PropertySet::set	(	std::string const &	name,
		char const *	value
	)

Replace all values for a property name (possibly hierarchical) with a string value.

Parameters

[in]	name	Property name to set, possibly hierarchical.
[in]	value	Character string (converted to `std::string` ).

Definition at line 607 of file PropertySet.cc.

                                                                      {
     set(name, string(value));
 }

std::string lsst::daf::base::PropertySet::toString	(	bool	topLevelOnly = `false`,
		std::string const &	indent = `""`
	)		const

virtual

Generate a string representation of the PropertySet. Use this for debugging, not for serialization/persistence.

Parameters

[in]	topLevelOnly	false (default) = do include subproperties.
[in]	indent	String to indent lines by (default none).

Returns: String representation of the PropertySet.

Reimplemented in lsst::daf::base::PropertyList.

Definition at line 476 of file PropertySet.cc.

                                                                           {
     ostringstream s;
     vector<string> nv = names();
     sort(nv.begin(), nv.end());
     for (vector<string>::const_iterator i = nv.begin(); i != nv.end(); ++i) {
         boost::shared_ptr< vector<boost::any> > vp = _map.find(*i)->second;
         type_info const& t = vp->back().type();
         if (t == typeid(Ptr)) {
             s << indent << *i << " = ";
             if (topLevelOnly) {
                 s << "{ ... }";
             } else {
                 Ptr p = boost::any_cast<Ptr>(vp->back());
                 if (p.get() == 0) {
                     s << "{ NULL }";
                 } else {
                     s << '{' << endl;
                     s << p->toString(false, indent + "..");
                     s << indent << '}';
                 }
             }
             s << endl;
         }
         else {
             s << indent << _format(*i);
         }
     }
     return s.str();
 }

type_info const & lsst::daf::base::PropertySet::typeOf ( std::string const & name ) const

Get the type of values for a property name (possibly hierarchical).

Parameters

[in] name Property name to examine, possibly hierarchical.

Returns: Type of values for that property.

Exceptions

NotFoundError Property does not exist.

Definition at line 227 of file PropertySet.cc.

                                                                        {
     AnyMap::const_iterator i = _find(name);
     if (i == _map.end()) {
         throw LSST_EXCEPT(pexExcept::NotFoundError, name + " not found");
     }
     return i->second->back().type();
 }

size_t lsst::daf::base::PropertySet::valueCount ( std::string const & name ) const

Get number of values for a property name (possibly hierarchical).

Parameters

[in] name Property name to examine, possibly hierarchical.

Returns: Number of values for that property. 0 if it doesn't exist.

Definition at line 216 of file PropertySet.cc.

                                                                  {
     AnyMap::const_iterator i = _find(name);
     if (i == _map.end()) return 0;
     return i->second->size();
 }

Member Data Documentation

bool lsst::daf::base::PropertySet::_flat

private

Definition at line 179 of file PropertySet.h.

AnyMap lsst::daf::base::PropertySet::_map

private

Definition at line 178 of file PropertySet.h.

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

/home/lsstsw/stack/Linux64/daf_base/11.0+1/include/lsst/daf/base/PropertySet.h
/home/lsstsw/stack/Linux64/daf_base/11.0+1/src/PropertySet.cc

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation