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

Public Member Functions
	PropertyList ()
	Construct an empty PropertyList.

virtual	~PropertyList () noexcept
	Destructor.

virtual std::shared_ptr< PropertySet >	deepCopy () const
	Make a deep copy of the PropertyList and all of its contents.

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

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.

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

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

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

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

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

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

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.

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

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.

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

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

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

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

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.

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.

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

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.

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.

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

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

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.

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

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

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.

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

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

virtual void	combine (PropertySet const &source)
	Append all value vectors from the source to their corresponding properties.

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

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

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

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

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

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

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

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

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

size_t	valueCount () const
	Get the number of values in the entire PropertySet, counting each element of a vector.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	_commentOrderFix (std::string const &name, std::string const &comment)

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.

◆ Ptr

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

Definition at line 71 of file PropertyList.h.

Constructor & Destructor Documentation

◆ PropertyList()

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

Construct an empty PropertyList.

Constructor.

Definition at line 41 of file PropertyList.cc.

41: 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< std::any > >	vp )

protectedvirtualinherited

◆ _commentOrderFix()

void lsst::daf::base::PropertyList::_commentOrderFix	(	std::string const &	name,
		std::string const &	comment )

privatevirtual

Definition at line 242 of file PropertyList.cc.

                                                                                   {
    _comments[name] = comment;
}

◆ _format()

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

protectedvirtualinherited

◆ _moveToEnd()

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

privatevirtual

Definition at line 237 of file PropertyList.cc.

                                                   {
    _order.remove(name);
    _order.push_back(name);
}

◆ _set()

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

privatevirtual

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

Definition at line 229 of file PropertyList.cc.

                                                                                   {
    PropertySet::_set(name, vp);
    if (_comments.find(name) == _comments.end()) {
        _comments.insert(std::make_pair(name, std::string()));
        _order.push_back(name);
    }
}

◆ add() [1/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 143 of file PropertyList.cc.

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

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:139

◆ add() [2/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 276 of file PropertyList.h.

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

◆ add() [3/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 174 of file PropertyList.cc.

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

◆ add() [4/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 146 of file PropertyList.cc.

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

◆ add() [5/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 271 of file PropertyList.h.

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

◆ add() [6/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 179 of file PropertyList.cc.

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

◆ add() [7/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.

If value is a PropertySet, the default implementation will allow it to be retreived later via get (or other methods) using the given name, and the result will be the same shared_ptr passed in, but this is not guaranteed to be the behavior for all derived classes, which may flatten out PropertySet values instead.

Definition at line 139 of file PropertyList.cc.

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

◆ add() [8/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 266 of file PropertyList.h.

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

◆ add() [9/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 169 of file PropertyList.cc.

                                                                                      {
    PropertySet::add(name, value);
    _commentOrderFix(name, 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 90 of file PropertyList.cc.

90{ return _order.begin(); }

std::list::begin

T begin(T... args)

◆ combine()

void lsst::daf::base::PropertyList::combine ( PropertySet const & 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 to extract values from.

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

                                                     {
    auto const * pl = dynamic_cast<PropertyList 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 const &	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 to extract values from.
[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 187 of file PropertyList.cc.

                                       {
    PropertySet::copy(dest, source, name, asScalar);
    auto const * pl = dynamic_cast<PropertyList const *>(&source);
    if (pl) {
        _comments[name] = pl->_comments.find(name)->second;
    }
}

◆ deepCopy()

std::shared_ptr< PropertySet > lsst::daf::base::PropertyList::deepCopy ( ) const

virtual

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

Returns: PropertyList pointing to the new copy.

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

Definition at line 51 of file PropertyList.cc.

                                                        {
    std::shared_ptr<PropertyList> 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 92 of file PropertyList.cc.

92{ return _order.end(); }

◆ 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 62 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 68 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 74 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()

std::shared_ptr< PropertySet > 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 value.

Exceptions

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

◆ 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 78 of file PropertyList.cc.

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

◆ 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 82 of file PropertyList.cc.

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

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

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

◆ 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 219 of file PropertyList.cc.

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

◆ set() [1/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 131 of file PropertyList.cc.

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

set

daf::base::PropertySet * set

Definition fits.cc:931

◆ set() [2/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 260 of file PropertyList.h.

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

◆ set() [3/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 159 of file PropertyList.cc.

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

◆ set() [4/10]

void lsst::daf::base::PropertyList::set	(	std::string const &	name,
		std::shared_ptr< PropertySet > 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.

Unlike the base PropertySet implementation, PropertyList flattens out nested PropertySet objects, storing their keys with nested names but not the PropertySet instance itself.

Definition at line 118 of file PropertyList.cc.

                                                                                     {
    auto 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() [5/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 134 of file PropertyList.cc.

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

◆ set() [6/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 255 of file PropertyList.h.

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

◆ set() [7/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 164 of file PropertyList.cc.

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

◆ set() [8/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.

If value is a PropertySet, the default implementation will allow it to be retreived later via get (or other methods) using the given name, and the result will be the same shared_ptr passed in, but this is not guaranteed to be the behavior for all derived classes, which may flatten out PropertySet values instead.

Definition at line 114 of file PropertyList.cc.

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

◆ set() [9/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 249 of file PropertyList.h.

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

◆ set() [10/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 154 of file PropertyList.cc.

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

◆ 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 94 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() [1/2]

size_t lsst::daf::base::PropertySet::valueCount ( ) const

inherited

Get the number of values in the entire PropertySet, counting each element of a vector.

Returns: Number of values.

◆ valueCount() [2/2]

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/lsst-scipipe-9.0.0/Linux64/daf_base/g3e281a1b8c+c5dd892a6c/include/lsst/daf/base/PropertyList.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/daf_base/g3e281a1b8c+c5dd892a6c/src/PropertyList.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ PropertyList()

◆ ~PropertyList()

Member Function Documentation

◆ _add()

◆ _commentOrderFix()

◆ _format()

◆ _moveToEnd()

◆ _set()

◆ 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()

◆ combine()

◆ copy()

◆ deepCopy()

◆ end()

◆ exists()

◆ get() [1/2]

◆ get() [2/2]

◆ getArray()

◆ getAsBool()

◆ getAsDouble()

◆ getAsInt()

◆ getAsInt64()

◆ getAsPersistablePtr()

◆ getAsPropertySetPtr()

◆ getAsString()

◆ getAsUInt64()

◆ getComment()

◆ getOrderedNames()

◆ isArray()

◆ isPropertySetPtr()

◆ isUndefined()

◆ nameCount()

◆ names()

◆ paramNames()

◆ propertySetNames()

◆ remove()

◆ 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]

◆ toString()

◆ typeOf()

◆ typeOfT()

◆ valueCount() [1/2]

◆ valueCount() [2/2]