lsst.daf.base
13.0-2-g167564e+2
|
Class for storing ordered metadata with comments. More...
#include <PropertyList.h>
Public Types | |
typedef std::shared_ptr < PropertyList > | Ptr |
typedef std::shared_ptr < PropertyList const > | ConstPtr |
![]() | |
typedef std::shared_ptr < PropertySet > | Ptr |
typedef std::shared_ptr < PropertySet const > | ConstPtr |
![]() | |
typedef std::shared_ptr < Persistable > | Ptr |
![]() | |
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 (void) | |
Constructor. More... | |
virtual | ~PropertyList (void) |
Destructor. More... | |
virtual PropertySet::Ptr | deepCopy (void) const |
Copy 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). More... | |
template<typename T > | |
std::vector< T > | getArray (std::string const &name) const |
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 (void) const |
std::list< std::string > ::const_iterator | begin (void) const |
std::list< std::string > ::const_iterator | end (void) const |
virtual std::string | toString (bool topLevelOnly=false, std::string const &indent="") const |
Generate a string representation of the PropertyList. 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 value. More... | |
void | set (std::string const &name, PropertySet::Ptr const &value) |
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) |
Appends 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) |
Appends 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) |
Appends 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) |
Replace all values for a property name (possibly hierarchical) with a new value. More... | |
template<typename T > | |
void | set (std::string const &name, std::vector< T > const &value, std::string const &comment) |
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, std::string const &comment) |
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, std::string const &comment) |
Appends 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, std::string const &comment) |
Appends 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, std::string const &comment) |
Appends 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, char const *comment) |
template<typename T > | |
void | set (std::string const &name, std::vector< T > const &value, char const *comment) |
void | set (std::string const &name, char const *value, char const *comment) |
template<typename T > | |
void | add (std::string const &name, T const &value, char const *comment) |
template<typename T > | |
void | add (std::string const &name, std::vector< T > const &value, char const *comment) |
void | add (std::string const &name, char const *value, char const *comment) |
virtual void | copy (std::string const &dest, PropertySet::ConstPtr source, std::string const &name) |
Replaces a single value vector in the destination with one from the source. More... | |
virtual void | combine (PropertySet::ConstPtr source) |
Appends all value vectors from the source to their corresponding properties. More... | |
virtual void | remove (std::string const &name) |
Removes all values for a property name (possibly hierarchical). More... | |
template<typename T > | |
vector< T > | getArray (string const &name) const |
Get the vector of values for a property name (possibly hierarchical). More... | |
![]() | |
PropertySet (bool flat=false) | |
Constructor. More... | |
virtual | ~PropertySet (void) |
Destructor. More... | |
PropertySet (const PropertySet &)=delete | |
PropertySet & | operator= (const PropertySet &)=delete |
PropertySet (PropertySet &&)=delete | |
PropertySet & | operator= (PropertySet &&)=delete |
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 |
Get the names of parameters (non-subproperties) in the PropertySet, optionally including those in subproperties. More... | |
std::vector< std::string > | propertySetNames (bool topLevelOnly=true) const |
Get the names of subproperties in the PropertySet, optionally including those in 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... | |
size_t | valueCount (std::string const &name) const |
Get 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... | |
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). More... | |
template<typename T > | |
std::vector< T > | getArray (std::string const &name) const |
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... | |
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... | |
template<typename T > | |
void | set (std::string const &name, T const &value) |
Replace all values for a property name (possibly hierarchical) with a new value. 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) |
Appends 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) |
Appends 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) |
Appends a char const* value to the vector of values for a property name (possibly hierarchical). More... | |
template<typename T > | |
vector< T > | getArray (string const &name) const |
Get the vector of values for a property name (possibly hierarchical). More... | |
![]() | |
Persistable (void) | |
Default constructor. More... | |
virtual | ~Persistable (void) |
Destructor. More... | |
template<class Archive > | |
void | serialize (Archive &, unsigned int const) |
Template boost::serialization function for the base class. More... | |
![]() | |
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... | |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
virtual void | _add (std::string const &name, std::shared_ptr< std::vector< boost::any > > vp) |
Finds the property name (possibly hierarchical) and appends or sets its value with the given vector of values. More... | |
virtual std::string | _format (std::string const &name) const |
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 82 of file PropertyList.h.
typedef std::shared_ptr<PropertyList const> lsst::daf::base::PropertyList::ConstPtr |
Definition at line 86 of file PropertyList.h.
typedef std::shared_ptr<PropertyList> lsst::daf::base::PropertyList::Ptr |
Definition at line 85 of file PropertyList.h.
lsst::daf::base::PropertyList::PropertyList | ( | void | ) |
Constructor.
Definition at line 57 of file PropertyList.cc.
|
virtual |
Destructor.
Definition at line 62 of file PropertyList.cc.
void lsst::daf::base::PropertyList::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.
[in] | name | Property name to append to, possibly hierarchical. |
[in] | value | Value to append. |
TypeError | Type does not match existing values. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 238 of file PropertyList.cc.
void lsst::daf::base::PropertyList::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.
[in] | name | Property name to append to, possibly hierarchical. |
[in] | value | Vector of values to append. |
TypeError | Type does not match existing values. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 266 of file PropertyList.cc.
void lsst::daf::base::PropertyList::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.
[in] | name | Property name to append to, possibly hierarchical. |
[in] | value | Value to append. |
TypeError | Type does not match existing values. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 251 of file PropertyList.cc.
void lsst::daf::base::PropertyList::add | ( | std::string const & | name, |
T const & | value, | ||
std::string const & | comment | ||
) |
Appends a single value to the vector of values for a property name (possibly hierarchical).
Sets the value if the property does not exist.
[in] | name | Property name to append to, possibly hierarchical. |
[in] | value | Value to append. |
[in] | comment | Comment to set. |
TypeError | Type does not match existing values. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 327 of file PropertyList.cc.
void lsst::daf::base::PropertyList::add | ( | std::string const & | name, |
std::vector< T > const & | value, | ||
std::string const & | comment | ||
) |
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.
[in] | name | Property name to append to, possibly hierarchical. |
[in] | value | Vector of values to append. |
[in] | comment | Comment to set. |
TypeError | Type does not match existing values. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 361 of file PropertyList.cc.
void lsst::daf::base::PropertyList::add | ( | std::string const & | name, |
char const * | value, | ||
std::string const & | comment | ||
) |
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.
[in] | name | Property name to append to, possibly hierarchical. |
[in] | value | String value to append. |
[in] | comment | Comment to set. |
TypeError | Type does not match existing values. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 344 of file PropertyList.cc.
|
inline |
Definition at line 166 of file PropertyList.h.
|
inline |
Definition at line 171 of file PropertyList.h.
|
inline |
Definition at line 176 of file PropertyList.h.
std::list< std::string >::const_iterator lsst::daf::base::PropertyList::begin | ( | void | ) | const |
Definition at line 143 of file PropertyList.cc.
|
virtual |
Appends all value vectors from the source to their corresponding properties.
Sets values if a property does not exist.
[in] | source | PropertySet::Ptr for the source PropertySet. |
TypeError | Type does not match existing values. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Reimplemented from lsst::daf::base::PropertySet.
Definition at line 401 of file PropertyList.cc.
|
virtual |
Replaces a single value vector in the destination with one from the source.
[in] | dest | Destination property name. |
[in] | source | PropertySet::Ptr for the source PropertySet. |
[in] | name | Property name to extract. |
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 381 of file PropertyList.cc.
|
virtual |
Copy the PropertyList and all of its contents.
Reimplemented from lsst::daf::base::PropertySet.
Definition at line 72 of file PropertyList.cc.
std::list< std::string >::const_iterator lsst::daf::base::PropertyList::end | ( | void | ) | const |
Definition at line 148 of file PropertyList.cc.
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:
[in] | name | Property name to examine, possibly hierarchical. |
NotFoundError | Property does not exist. |
TypeError | Value does not match desired type. |
Definition at line 91 of file PropertyList.cc.
T lsst::daf::base::PropertyList::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:
[in] | name | Property name to examine, possibly hierarchical. |
[in] | defaultValue | Default value to return if property does not exist. |
TypeError | Value does not match desired type. |
Definition at line 105 of file PropertyList.cc.
std::vector<T> lsst::daf::base::PropertyList::getArray | ( | std::string const & | name | ) | const |
vector<T> lsst::daf::base::PropertyList::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:
[in] | name | Property name to examine, possibly hierarchical. |
NotFoundError | Property does not exist. |
TypeError | Value does not match desired type. |
Definition at line 118 of file PropertyList.cc.
std::string const & lsst::daf::base::PropertyList::getComment | ( | std::string const & | name | ) | const |
Get the comment for a string property name (possibly hierarchical).
[in] | name | Property name to examine, possibly hierarchical. |
NotFoundError | Property does not exist. |
Definition at line 128 of file PropertyList.cc.
std::vector< std::string > lsst::daf::base::PropertyList::getOrderedNames | ( | void | ) | const |
Definition at line 133 of file PropertyList.cc.
|
virtual |
Removes all values for a property name (possibly hierarchical).
Does nothing if the property does not exist.
[in] | name | Property name to remove, possibly hierarchical. |
Reimplemented from lsst::daf::base::PropertySet.
Definition at line 430 of file PropertyList.cc.
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 value.
[in] | name | Property name to set, possibly hierarchical. |
[in] | value | Value to set. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 187 of file PropertyList.cc.
void lsst::daf::base::PropertyList::set | ( | std::string const & | name, |
PropertySet::Ptr const & | value | ||
) |
Definition at line 192 of file PropertyList.cc.
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.
[in] | name | Property name to set, possibly hierarchical. |
[in] | value | Vector of values to set. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 225 of file PropertyList.cc.
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.
[in] | name | Property name to set, possibly hierarchical. |
[in] | value | Character string (converted to std::string ). |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 213 of file PropertyList.cc.
void lsst::daf::base::PropertyList::set | ( | std::string const & | name, |
T const & | value, | ||
std::string const & | comment | ||
) |
Replace all values for a property name (possibly hierarchical) with a new value.
[in] | name | Property name to set, possibly hierarchical. |
[in] | value | Value to set. |
[in] | comment | Comment to set. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 283 of file PropertyList.cc.
void lsst::daf::base::PropertyList::set | ( | std::string const & | name, |
std::vector< T > const & | value, | ||
std::string const & | comment | ||
) |
Replace all values for a property name (possibly hierarchical) with a vector of new values.
[in] | name | Property name to set, possibly hierarchical. |
[in] | value | Vector of values to set. |
[in] | comment | Comment to set. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 311 of file PropertyList.cc.
void lsst::daf::base::PropertyList::set | ( | std::string const & | name, |
char const * | value, | ||
std::string const & | comment | ||
) |
Replace all values for a property name (possibly hierarchical) with a string value.
[in] | name | Property name to set, possibly hierarchical. |
[in] | value | Character string value to set. |
[in] | comment | Comment to set. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 297 of file PropertyList.cc.
|
inline |
Definition at line 151 of file PropertyList.h.
|
inline |
Definition at line 156 of file PropertyList.h.
|
inline |
Definition at line 161 of file PropertyList.h.
|
virtual |
Generate a string representation of the PropertyList.
Use this for debugging, not for serialization/persistence.
[in] | topLevelOnly | false (default) = do include subproperties. |
[in] | indent | String to indent lines by (default none). |
Reimplemented from lsst::daf::base::PropertySet.
Definition at line 158 of file PropertyList.cc.