Class for storing ordered metadata with comments. More...

#include <PropertyList.h>

Inheritance diagram for lsst::daf::base::PropertyList:

Public Types
typedef std::shared_ptr< PropertyList >	Ptr

typedef std::shared_ptr< PropertyList const >	ConstPtr

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
	PropertyList ()
	Construct an empty PropertyList. More...

virtual	~PropertyList () noexcept
	Destructor. More...

virtual PropertySet::Ptr	deepCopy () const
	Make a deep copy of the PropertyList and all of its contents. More...

template<typename T >
T	get (std::string const &name) const
	Get the last value for a property name (possibly hierarchical). More...

template<typename T >
T	get (std::string const &name, T const &defaultValue) const
	Get the last value for a property name (possibly hierarchical); return the provided defaultValue if the property does not exist. More...

template<typename T >
std::vector< T >	getArray (std::string const &name) const
	Get the vector of values for a property name (possibly hierarchical). More...

std::string const &	getComment (std::string const &name) const
	Get the comment for a string property name (possibly hierarchical). More...

std::vector< std::string >	getOrderedNames () const
	Get the list of property names, in the order they were added. More...

std::list< std::string >::const_iterator	begin () const
	Begin iterator over the list of property names, in the order they were added. More...

std::list< std::string >::const_iterator	end () const
	End iterator over the list of property names, in the order they were added. More...

virtual std::string	toString (bool topLevelOnly=false, std::string const &indent="") const
	Generate a string representation of the PropertySet. More...

template<typename T >
void	set (std::string const &name, T const &value)
	Replace all values for a property name (possibly hierarchical) with a new scalar value. More...

void	set (std::string const &name, PropertySet::Ptr const &value)
	Replace all values for a property name (possibly hierarchical) with a new PropertySet. More...

template<typename T >
void	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. More...

void	set (std::string const &name, char const *value)
	Replace all values for a property name (possibly hierarchical) with a string value. More...

template<typename T >
void	add (std::string const &name, T const &value)
	Append a single value to the vector of values for a property name (possibly hierarchical). More...

template<typename T >
void	add (std::string const &name, std::vector< T > const &value)
	Append a vector of values to the vector of values for a property name (possibly hierarchical). More...

void	add (std::string const &name, char const *value)
	Append a `char const*` value to the vector of values for a property name (possibly hierarchical). More...

template<typename T >
void	set (std::string const &name, T const &value, std::string const &comment)
	Version of set scalar value that accepts a comment. More...

template<typename T >
void	set (std::string const &name, std::vector< T > const &value, std::string const &comment)
	Version of set vector value that accepts a comment. More...

void	set (std::string const &name, char const *value, std::string const &comment)
	Version of set char* value that accepts a comment. More...

template<typename T >
void	add (std::string const &name, T const &value, std::string const &comment)
	Version of add scalar value that accepts a comment. More...

template<typename T >
void	add (std::string const &name, std::vector< T > const &value, std::string const &comment)
	Version of add vector value that accepts a comment. More...

void	add (std::string const &name, char const *value, std::string const &comment)
	Version of add char* value that accepts a comment. More...

template<typename T >
void	set (std::string const &name, T const &value, char const *comment)
	Version of set scalar value that accepts a comment. More...

template<typename T >
void	set (std::string const &name, std::vector< T > const &value, char const *comment)
	Version of set vector value that accepts a comment. More...

void	set (std::string const &name, char const value, char const comment)
	Version of set char* value that accepts a comment. More...

template<typename T >
void	add (std::string const &name, T const &value, char const *comment)
	Version of add scalar value that accepts a comment. More...

template<typename T >
void	add (std::string const &name, std::vector< T > const &value, char const *comment)
	Version of add vector value that accepts a comment. More...

void	add (std::string const &name, char const value, char const comment)
	Version of add char* value that accepts a comment. More...

virtual void	copy (std::string const &dest, PropertySet::ConstPtr source, std::string const &name, bool asScalar=false)
	Replace a single value vector in the destination with one from the source. More...

virtual void	combine (PropertySet::ConstPtr source)
	Append all value vectors from the source to their corresponding properties. More...

virtual void	remove (std::string const &name)
	Remove all values for a property name (possibly hierarchical). More...

size_t	nameCount (bool topLevelOnly=true) const
	Get the number of names in the PropertySet, optionally including those in subproperties. More...

std::vector< std::string >	names (bool topLevelOnly=true) const
	Get the names in the PropertySet, optionally including those in subproperties. More...

std::vector< std::string >	paramNames (bool topLevelOnly=true) const
	A variant of names that excludes the names of subproperties. More...

std::vector< std::string >	propertySetNames (bool topLevelOnly=true) const
	A variant of names that only returns the names of subproperties. More...

bool	exists (std::string const &name) const
	Determine if a name (possibly hierarchical) exists. More...

bool	isArray (std::string const &name) const
	Determine if a name (possibly hierarchical) has multiple values. More...

bool	isPropertySetPtr (std::string const &name) const
	Determine if a name (possibly hierarchical) is a subproperty. More...

bool	isUndefined (std::string const &name) const
	Determine if a name (possibly hierarchical) has a defined value. More...

size_t	valueCount (std::string const &name) const
	Get the number of values for a property name (possibly hierarchical). More...

std::type_info const &	typeOf (std::string const &name) const
	Get the type of values for a property name (possibly hierarchical). More...

bool	getAsBool (std::string const &name) const
	Get the last value for a bool property name (possibly hierarchical). More...

int	getAsInt (std::string const &name) const
	Get the last value for a bool/char/short/int property name (possibly hierarchical). More...

int64_t	getAsInt64 (std::string const &name) const
	Get the last value for a bool/char/short/int/int64_t property name (possibly hierarchical). More...

uint64_t	getAsUInt64 (std::string const &name) const
	Get the last value for an bool/char/short/int/int64_t property name (possibly hierarchical). More...

double	getAsDouble (std::string const &name) const
	Get the last value for any arithmetic property name (possibly hierarchical). More...

std::string	getAsString (std::string const &name) const
	Get the last value for a string property name (possibly hierarchical). More...

PropertySet::Ptr	getAsPropertySetPtr (std::string const &name) const
	Get the last value for a subproperty name (possibly hierarchical). More...

Persistable::Ptr	getAsPersistablePtr (std::string const &name) const
	Get the last value for a Persistable name (possibly hierarchical). More...

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...

Static Public Member Functions
template<typename T >
static std::type_info const &	typeOfT ()
	Get type info for the specified class. More...

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...

Census
Provide a list of current Citizens
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...

callbackIDs
Set callback Ids. The old Id is returned
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...

callbacks
Set the New/Delete callback functions; in each case the previously installed callback is returned. These callback functions return a value which is Added to the previously registered id. The default callback functions are called default{New,Delete}Callback; you may want to set a break point in these callbacks from your favourite debugger
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...

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

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

Detailed Description

Class for storing ordered metadata with comments.

This class stores key/value pairs like PropertySet, of which it is a subclass. The difference is that the PropertyList maintains the order of the key/value pairs according to how they were inserted. By default, replacing the value of an existing key does not change its ordering. In addition, a comment string may be associated with each key/value pair.

The main motivating use case for PropertyList is FITS headers.

PropertyLists are not truly hierarchical, although they accept dotted paths as keys. If a PropertySet or PropertyList is added as a value to a PropertyList, the hierarchical pathnames are flattened into the resulting PropertyList.

Definition at line 68 of file PropertyList.h.

Member Typedef Documentation

◆ ConstPtr

typedef std::shared_ptr<PropertyList const> lsst::daf::base::PropertyList::ConstPtr

Definition at line 72 of file PropertyList.h.

◆ memCallback

typedef memId(* lsst::daf::base::Citizen::memCallback) (const Citizen *ptr)

inherited

Definition at line 61 of file Citizen.h.

◆ memId

typedef unsigned long lsst::daf::base::Citizen::memId

inherited

Type of the block's ID.

Definition at line 58 of file Citizen.h.

◆ memNewCallback

typedef memId(* lsst::daf::base::Citizen::memNewCallback) (const memId cid)

inherited

A function used to register a callback.

Definition at line 60 of file Citizen.h.

◆ Ptr

typedef std::shared_ptr<PropertyList> lsst::daf::base::PropertyList::Ptr

Definition at line 71 of file PropertyList.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Enumerator
magicSentinel

Definition at line 88 of file Citizen.h.

88 { magicSentinel = 0xdeadbeef };

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

Definition: Citizen.h:88

Constructor & Destructor Documentation

◆ PropertyList()

lsst::daf::base::PropertyList::PropertyList ( )

Construct an empty PropertyList.

Constructor.

Definition at line 40 of file PropertyList.cc.

40 : PropertySet(true) {}

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

PropertySet(bool flat=false)

Construct an empty PropertySet.

◆ ~PropertyList()

lsst::daf::base::PropertyList::~PropertyList ( )

virtualdefaultnoexcept

Destructor.

Member Function Documentation

◆ _add()

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

protectedvirtualinherited

◆ _format()

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

protectedvirtualinherited

◆ add() [1/9]

template<typename T >

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

Append 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 138 of file PropertyList.cc.

                                                             {
     PropertySet::add(name, value);
 }

◆ add() [2/9]

template<typename T >

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

Append 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 145 of file PropertyList.cc.

                                                                        {
     PropertySet::add(name, value);
 }

◆ add() [3/9]

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

Append 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 142 of file PropertyList.cc.

142 { add(name, std::string(value)); }

lsst::afw::geom.transform.transformContinued.name

string name

Definition: transformContinued.py:32

std::string

STL class.

lsst::daf::base::PropertyList::add

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

Append a single value to the vector of values for a property name (possibly hierarchical).

Definition: PropertyList.cc:138

◆ add() [4/9]

template<typename T >

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

Version of add scalar value that accepts a comment.

Parameters

[in]	name	Property name to append to, possibly hierarchical.
[in]	value	Value to add.
[in]	comment	Comment to set.

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 168 of file PropertyList.cc.

                                                                                       {
     PropertySet::add(name, value);
     _commentOrderFix(name, comment);
 }

◆ add() [5/9]

template<typename T >

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

Version of add vector value that accepts a comment.

Parameters

[in]	name	Property name to append to, possibly hierarchical.
[in]	value	Character string value to add.
[in]	comment	Comment to set.

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 178 of file PropertyList.cc.

                                                                                                  {
     PropertySet::add(name, value);
     _commentOrderFix(name, comment);
 }

◆ add() [6/9]

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

Version of add char* value that accepts a comment.

Parameters

[in]	name	Property name to append to, possibly hierarchical.
[in]	value	Character string value to add.
[in]	comment	Comment to set.

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 173 of file PropertyList.cc.

                                                                                          {
     add(name, std::string(value), comment);
 }

◆ add() [7/9]

template<typename T >

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

inline

Version of add scalar value that accepts a comment.

Parameters

[in]	name	Property name to append to, possibly hierarchical.
[in]	value	Value to add.
[in]	comment	Comment to set.

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 262 of file PropertyList.h.

                                                                          {
         add(name, value, std::string(comment));
     }

◆ add() [8/9]

template<typename T >

void lsst::daf::base::PropertyList::add	(	std::string const &	name,
		std::vector< T > const &	value,
		char const *	comment
	)

inline

Version of add vector value that accepts a comment.

Parameters

[in]	name	Property name to append to, possibly hierarchical.
[in]	value	Character string value to add.
[in]	comment	Comment to set.

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 267 of file PropertyList.h.

                                                                                     {
         add(name, value, std::string(comment));
     }

◆ add() [9/9]

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

inline

Version of add char* value that accepts a comment.

Parameters

[in]	name	Property name to append to, possibly hierarchical.
[in]	value	Character string value to add.
[in]	comment	Comment to set.

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 272 of file PropertyList.h.

                                                                             {
         add(name, value, std::string(comment));
     }

◆ begin()

std::list< std::string >::const_iterator lsst::daf::base::PropertyList::begin ( ) const

Begin iterator over the list of property names, in the order they were added.

Definition at line 89 of file PropertyList.cc.

89 { return _order.begin(); }

std::list::begin

T begin(T... args)

◆ census() [1/3]

int lsst::daf::base::Citizen::census	(	int	,
		memId	startingMemId = `0`
	)

staticinherited

How many active Citizens are there?

Parameters

startingMemId Don't print Citizens with lower IDs

Definition at line 238 of file Citizen.cc.

   {
     if (startingMemId == 0) {  // easy
         ReadGuard guard(citizenLock);
         return _activeCitizens.size();
     }
 
     int n = 0;
     ReadGuard guard(citizenLock);
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         if (cur->first->_CitizenId >= startingMemId) {
             n++;
         }
     }
 
     return n;
 }

◆ census() [2/3]

void lsst::daf::base::Citizen::census	(	std::ostream &	stream,
		memId	startingMemId = `0`
	)

staticinherited

Print a list of all active Citizens to stream, sorted by ID.

Parameters

stream	stream to print to
startingMemId	Don't print Citizens with lower IDs

Definition at line 259 of file Citizen.cc.

   {
     ReadGuard guard(citizenLock);
 
     std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census());
 
     for (std::vector<Citizen const*>::const_iterator citizen = leaks->begin(), end = leaks->end();
          citizen != end; ++citizen) {
         if ((*citizen)->getId() >= startingMemId) {
             stream << (*citizen)->repr() << "\n";
         }
     }
 }

◆ census() [3/3]

std::vector< dafBase::Citizen const * > const * lsst::daf::base::Citizen::census ( )

staticinherited

Return a (newly allocated) std::vector of active Citizens sorted by ID.

You are responsible for deleting it; or you can say std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census()); and not bother (that becomes std::unique_ptr in C++11)

Definition at line 287 of file Citizen.cc.

                                                                {
     std::vector<Citizen const*>* vec = new std::vector<Citizen const*>(0);
     ReadGuard guard(citizenLock);
     vec->reserve(_activeCitizens.size());
 
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         vec->push_back(dynamic_cast<Citizen const*>(cur->first));
     }
 
     std::sort(vec->begin(), vec->end(), cmpId);
 
     return vec;
 }

◆ combine()

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

virtual

Append all value vectors from the source to their corresponding properties.

Sets values if a property does not exist.

If a property already exists then the types of the existing value(s) must match the type of the value(s) in source.

Parameters

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

Exceptions

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

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

Reimplemented from lsst::daf::base::PropertySet.

Definition at line 195 of file PropertyList.cc.

                                                      {
     ConstPtr pl = std::dynamic_pointer_cast<PropertyList const, PropertySet const>(source);
     std::list<std::string> newOrder;
     if (pl) {
         newOrder = _order;
         for (auto const& name : *pl) {
             bool present = _comments.find(name) != _comments.end();
             if (!present) {
                 newOrder.push_back(name);
             }
         }
     }
     PropertySet::combine(source);
     if (pl) {
         _order = newOrder;
         for (auto const& name : *pl) {
             _comments[name] = pl->_comments.find(name)->second;
         }
     }
 }

◆ copy()

void lsst::daf::base::PropertyList::copy	(	std::string const &	dest,
		PropertySet::ConstPtr	source,
		std::string const &	name,
		bool	asScalar = `false`
	)

virtual

Replace 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.
[in]	asScalar	If true copy the item as a scalar by ignoring all but the last value (which is the value returned by get<T>(name))

Exceptions

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

Reimplemented from lsst::daf::base::PropertySet.

Definition at line 186 of file PropertyList.cc.

                                        {
     PropertySet::copy(dest, source, name, asScalar);
     ConstPtr pl = std::dynamic_pointer_cast<PropertyList const, PropertySet const>(source);
     if (pl) {
         _comments[name] = pl->_comments.find(name)->second;
     }
 }

◆ deepCopy()

PropertySet::Ptr lsst::daf::base::PropertyList::deepCopy ( ) const

virtual

Make a deep copy of the PropertyList and all of its contents.

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

Reimplemented from lsst::daf::base::PropertySet.

Definition at line 50 of file PropertyList.cc.

                                             {
     Ptr n(new PropertyList);
     n->PropertySet::combine(this->PropertySet::deepCopy());
     n->_order = _order;
     n->_comments = _comments;
     return n;
 }

◆ end()

std::list< std::string >::const_iterator lsst::daf::base::PropertyList::end ( ) const

End iterator over the list of property names, in the order they were added.

Definition at line 91 of file PropertyList.cc.

91 { return _order.end(); }

std::list::end

T end(T... args)

◆ exists()

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

inherited

Determine if a name (possibly hierarchical) exists.

Parameters

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

Returns: true if property exists.

◆ get() [1/2]

template<typename T >

T lsst::daf::base::PropertyList::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 61 of file PropertyList.cc.

               { /* parasoft-suppress LsstDm-3-4a LsstDm-4-6 "allow template over bool" */
     return PropertySet::get<T>(name);
 }

◆ get() [2/2]

template<typename T >

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

Get the last value for a property name (possibly hierarchical); return 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 67 of file PropertyList.cc.

               { /* parasoft-suppress LsstDm-3-4a LsstDm-4-6 "allow template over bool" */
     return PropertySet::get<T>(name, defaultValue);
 }

◆ getArray()

template<typename T >

std::vector< T > lsst::daf::base::PropertyList::getArray ( std::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 73 of file PropertyList.cc.

                                                                {
     return PropertySet::getArray<T>(name);
 }

◆ getAsBool()

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

inherited

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

Only bool properties are supported.

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.

◆ getAsDouble()

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

inherited

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.

◆ getAsInt()

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

inherited

Get the last value for a bool/char/short/int property name (possibly hierarchical).

Unsigned int properties are not acceptable.

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.

◆ getAsInt64()

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

inherited

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.

◆ getAsPersistablePtr()

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

inherited

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.

◆ getAsPropertySetPtr()

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

inherited

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.

◆ getAsString()

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

inherited

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

Only strings values are supported, though this does include properties set with char const*.

Parameters

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

Returns: String value.

Exceptions

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

◆ getAsUInt64()

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

inherited

Get the last value for an bool/char/short/int/int64_t property name (possibly hierarchical).

Parameters

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

Returns: Value as an uint64_t.

Exceptions

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

◆ getComment()

std::string const & lsst::daf::base::PropertyList::getComment ( std::string const & name ) const

Get the comment for a string property name (possibly hierarchical).

Parameters

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

Returns: Comment string.

Exceptions

NotFoundError Property does not exist.

Definition at line 77 of file PropertyList.cc.

                                                                      {
     return _comments.find(name)->second;
 }

◆ getId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getId ( ) const

inherited

Return the Citizen's ID.

Definition at line 206 of file Citizen.cc.

206 { return _CitizenId; }

◆ getNextMemId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getNextMemId ( )

staticinherited

Return the memId of the next object to be allocated.

Definition at line 209 of file Citizen.cc.

209 { return _nextMemId(); }

◆ getOrderedNames()

std::vector< std::string > lsst::daf::base::PropertyList::getOrderedNames ( ) const

Get the list of property names, in the order they were added.

Definition at line 81 of file PropertyList.cc.

                                                          {
     std::vector<std::string> v;
     for (auto const& name : _order) {
         v.push_back(name);
     }
     return v;
 }

◆ hasBeenCorrupted()

bool lsst::daf::base::Citizen::hasBeenCorrupted ( )

staticinherited

Check all allocated blocks for corruption.

Definition at line 316 of file Citizen.cc.

                                       {
     ReadGuard guard(citizenLock);
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         if (cur->first->_hasBeenCorrupted()) {
             return true;
         }
     }
     for (table::iterator cur = _persistentCitizens.begin(); cur != _persistentCitizens.end(); cur++) {
         if (cur->first->_hasBeenCorrupted()) {
             return true;
         }
     }
 
     return false;
 }

◆ init()

int lsst::daf::base::Citizen::init ( )

staticinherited

Called once when the memory system is being initialised.

Definition at line 196 of file Citizen.cc.

                          {
     volatile int dummy = 1;
     return dummy;
 }

◆ isArray()

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

inherited

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.

◆ isPropertySetPtr()

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

inherited

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.

◆ isUndefined()

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

inherited

Determine if a name (possibly hierarchical) has a defined value.

Parameters

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

Returns: true if property exists and its values are undefined.

◆ markPersistent()

void lsst::daf::base::Citizen::markPersistent ( void )

inherited

Mark a Citizen as persistent and not destroyed until process end.

Definition at line 225 of file Citizen.cc.

                                         {
     WriteGuard guard(citizenLock);
     _persistentCitizens[this] = _activeCitizens[this];
     _activeCitizens.erase(this);
 }

◆ nameCount()

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

inherited

Get the number of names in the PropertySet, optionally including those in subproperties.

Parameters

[in] topLevelOnly If true (default) omit names from subproperties and names of subproperties.

Returns: Number of names.

◆ names()

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

inherited

Get the names in the PropertySet, optionally including those in subproperties.

Parameters

[in] topLevelOnly If true (default) omit names from subproperties and names of subproperties. If false subproperty names are separated by a dot, e.g. "subname.subitem1"

Returns: Vector of names.

◆ paramNames()

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

inherited

A variant of names that excludes the names of subproperties.

◆ propertySetNames()

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

inherited

A variant of names that only returns the names of subproperties.

◆ remove()

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

virtual

Remove 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 from lsst::daf::base::PropertySet.

Definition at line 216 of file PropertyList.cc.

                                                {
     PropertySet::remove(name);
     _comments.erase(name);
     _order.remove(name);
 }

◆ repr()

std::string lsst::daf::base::Citizen::repr ( ) const

inherited

Return a string representation of a Citizen.

Definition at line 219 of file Citizen.cc.

                                      {
     return boost::str(boost::format("%d: %08x %s") % _CitizenId % this %
                       lsst::utils::demangleType(_typeName));
 }

◆ set() [1/10]

template<typename T >

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

Replace all values for a property name (possibly hierarchical) with a new scalar 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 113 of file PropertyList.cc.

                                                             {
     PropertySet::set(name, value);
 }

◆ set() [2/10]

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

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

Parameters

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

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 117 of file PropertyList.cc.

                                                                          {
     Ptr pl = std::dynamic_pointer_cast<PropertyList, PropertySet>(value);
     PropertySet::set(name, value);
     _comments.erase(name);
     _order.remove(name);
     std::vector<std::string> paramNames = value->paramNames(false);
     if (pl) {
         for (auto const& paramName : paramNames) {
             _commentOrderFix(name + "." + paramName, pl->getComment(paramName));
         }
     }
 }

◆ set() [3/10]

template<typename T >

void lsst::daf::base::PropertyList::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 133 of file PropertyList.cc.

                                                                        {
     PropertySet::set(name, value);
 }

◆ set() [4/10]

void lsst::daf::base::PropertyList::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 130 of file PropertyList.cc.

130 { set(name, std::string(value)); }

lsst::afw::geom.transform.transformContinued.name

string name

Definition: transformContinued.py:32

std::string

STL class.

◆ set() [5/10]

template<typename T >

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

Version of set scalar value that accepts a comment.

Parameters

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

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 153 of file PropertyList.cc.

                                                                                       {
     PropertySet::set(name, value);
     _commentOrderFix(name, comment);
 }

◆ set() [6/10]

template<typename T >

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

Version of set vector value that accepts a comment.

Parameters

[in]	name	Property name to set, possibly hierarchical.
[in]	value	Vector value to set.
[in]	comment	Comment to set.

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 163 of file PropertyList.cc.

                                                                                                  {
     PropertySet::set(name, value);
     _commentOrderFix(name, comment);
 }

◆ set() [7/10]

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

Version of set char* value that accepts a comment.

Parameters

[in]	name	Property name to set, possibly hierarchical.
[in]	value	Character string value to set.
[in]	comment	Comment to set.

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 158 of file PropertyList.cc.

                                                                                          {
     set(name, std::string(value), comment);
 }

◆ set() [8/10]

template<typename T >

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

inline

Version of set scalar value that accepts a comment.

Parameters

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

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 245 of file PropertyList.h.

                                                                          {
         set(name, value, std::string(comment));
     }

◆ set() [9/10]

template<typename T >

void lsst::daf::base::PropertyList::set	(	std::string const &	name,
		std::vector< T > const &	value,
		char const *	comment
	)

inline

Version of set vector value that accepts a comment.

Parameters

[in]	name	Property name to set, possibly hierarchical.
[in]	value	Vector value to set.
[in]	comment	Comment to set.

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 251 of file PropertyList.h.

                                                                                     {
         set(name, value, std::string(comment));
     }

◆ set() [10/10]

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

inline

Version of set char* value that accepts a comment.

Parameters

[in]	name	Property name to set, possibly hierarchical.
[in]	value	Character string value to set.
[in]	comment	Comment to set.

Exceptions

InvalidParameterError Hierarchical name uses non-PropertySet.

Definition at line 256 of file PropertyList.h.

                                                                             {
         set(name, value, std::string(comment));
     }

◆ setCorruptionCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setCorruptionCallback ( Citizen::memCallback func )

staticinherited

Set the CorruptionCallback function.

Parameters

func	function be called when block is found to be corrupted

Definition at line 391 of file Citizen.cc.

   {
     Citizen::memCallback old = _corruptionCallback;
     _corruptionCallback = func;
 
     return old;
 }

◆ setDeleteCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setDeleteCallback ( Citizen::memCallback func )

staticinherited

Set the DeleteCallback function.

Parameters

func	function be called when desired block is deleted

Definition at line 381 of file Citizen.cc.

   {
     Citizen::memCallback old = _deleteCallback;
     _deleteCallback = func;
 
     return old;
 }

◆ setDeleteCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setDeleteCallbackId ( Citizen::memId id )

staticinherited

Call the current DeleteCallback when block is deleted.

Parameters

id	Desired ID

Definition at line 347 of file Citizen.cc.

   {
     WriteGuard guard(citizenLock);
     Citizen::memId oldId = _deleteId;
     _deleteId = id;
 
     return oldId;
 }

◆ setNewCallback()

dafBase::Citizen::memNewCallback lsst::daf::base::Citizen::setNewCallback ( Citizen::memNewCallback func )

staticinherited

Set the NewCallback function.

Parameters

func	The new function to be called when a designated block is allocated

Definition at line 371 of file Citizen.cc.

   {
     Citizen::memNewCallback old = _newCallback;
     _newCallback = func;
 
     return old;
 }

◆ setNewCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setNewCallbackId ( Citizen::memId id )

staticinherited

Call the NewCallback when block is allocated.

Parameters

id	Desired ID

Definition at line 337 of file Citizen.cc.

   {
     WriteGuard guard(citizenLock);
     Citizen::memId oldId = _newId;
     _newId = id;
 
     return oldId;
 }

◆ toString()

std::string lsst::daf::base::PropertyList::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 from lsst::daf::base::PropertySet.

Definition at line 93 of file PropertyList.cc.

                                                                                  {
     std::ostringstream s;
     for (auto const& name : _order) {
         s << _format(name);
         std::string const& comment = _comments.find(name)->second;
         if (comment.size()) {
             s << "// " << comment << std::endl;
         }
     }
     return s.str();
 }

◆ typeOf()

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

inherited

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

If the value is an array this returns the type of the elements.

Parameters

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

Returns: Type of values for that property.

Exceptions

NotFoundError Property does not exist.

◆ typeOfT()

template<typename T >

static std::type_info const& lsst::daf::base::PropertySet::typeOfT ( )

staticinherited

Get type info for the specified class.

◆ valueCount()

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

inherited

Get the 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.

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

/j/snowflake/release/lsstsw/stack/Linux64/daf_base/18.1.0/include/lsst/daf/base/PropertyList.h
/j/snowflake/release/lsstsw/stack/Linux64/daf_base/18.1.0/src/PropertyList.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ ConstPtr

◆ memCallback

◆ memId

◆ memNewCallback

◆ Ptr

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ PropertyList()

◆ ~PropertyList()

Member Function Documentation

◆ _add()

◆ _format()

◆ add() [1/9]

◆ add() [2/9]

◆ add() [3/9]

◆ add() [4/9]

◆ add() [5/9]

◆ add() [6/9]

◆ add() [7/9]

◆ add() [8/9]

◆ add() [9/9]

◆ begin()

◆ census() [1/3]

◆ census() [2/3]

◆ census() [3/3]

◆ combine()

◆ copy()

◆ deepCopy()

◆ end()

◆ exists()

◆ get() [1/2]

◆ get() [2/2]

◆ getArray()

◆ getAsBool()

◆ getAsDouble()

◆ getAsInt()

◆ getAsInt64()

◆ getAsPersistablePtr()

◆ getAsPropertySetPtr()

◆ getAsString()

◆ getAsUInt64()

◆ getComment()

◆ getId()

◆ getNextMemId()

◆ getOrderedNames()

◆ hasBeenCorrupted()

◆ init()

◆ isArray()

◆ isPropertySetPtr()

◆ isUndefined()

◆ markPersistent()

◆ nameCount()

◆ names()

◆ paramNames()

◆ propertySetNames()

◆ remove()

◆ repr()

◆ set() [1/10]

◆ set() [2/10]

◆ set() [3/10]

◆ set() [4/10]

◆ set() [5/10]

◆ set() [6/10]

◆ set() [7/10]

◆ set() [8/10]

◆ set() [9/10]

◆ set() [10/10]

◆ setCorruptionCallback()

◆ setDeleteCallback()

◆ setDeleteCallbackId()

◆ setNewCallback()

◆ setNewCallbackId()

◆ toString()