LSSTApplications
17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
|
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 |
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... | |
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 |
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.
typedef std::shared_ptr<PropertyList const> lsst::daf::base::PropertyList::ConstPtr |
Definition at line 72 of file PropertyList.h.
|
inherited |
Definition at line 71 of file PropertyList.h.
lsst::daf::base::PropertyList::PropertyList | ( | ) |
Construct an empty PropertyList.
Constructor.
Definition at line 40 of file PropertyList.cc.
|
virtualdefaultnoexcept |
Destructor.
|
protectedvirtualinherited |
|
protectedvirtualinherited |
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.
[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 138 of file PropertyList.cc.
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.
[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 145 of file PropertyList.cc.
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.
[in] | name | Property name to append to, possibly hierarchical. |
[in] | value | Character string value to append. |
TypeError | Type does not match existing values. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 142 of file PropertyList.cc.
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.
[in] | name | Property name to append to, possibly hierarchical. |
[in] | value | Value to add. |
[in] | comment | Comment to set. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 168 of file PropertyList.cc.
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.
[in] | name | Property name to append to, possibly hierarchical. |
[in] | value | Character string value to add. |
[in] | comment | Comment to set. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 178 of file PropertyList.cc.
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.
[in] | name | Property name to append to, possibly hierarchical. |
[in] | value | Character string value to add. |
[in] | comment | Comment to set. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 173 of file PropertyList.cc.
|
inline |
Version of add scalar value that accepts a comment.
[in] | name | Property name to append to, possibly hierarchical. |
[in] | value | Value to add. |
[in] | comment | Comment to set. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 262 of file PropertyList.h.
|
inline |
Version of add vector value that accepts a comment.
[in] | name | Property name to append to, possibly hierarchical. |
[in] | value | Character string value to add. |
[in] | comment | Comment to set. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 267 of file PropertyList.h.
|
inline |
Version of add char* value that accepts a comment.
[in] | name | Property name to append to, possibly hierarchical. |
[in] | value | Character string value to add. |
[in] | comment | Comment to set. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 272 of file PropertyList.h.
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.
|
staticinherited |
How many active Citizens are there?
startingMemId | Don't print Citizens with lower IDs |
Definition at line 238 of file Citizen.cc.
|
staticinherited |
Print a list of all active Citizens to stream, sorted by ID.
stream | stream to print to |
startingMemId | Don't print Citizens with lower IDs |
Definition at line 259 of file Citizen.cc.
|
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.
|
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.
[in] | source | PropertySet::Ptr for the source PropertySet. |
TypeError | Type does not match existing values for an item. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Reimplemented from lsst::daf::base::PropertySet.
Definition at line 195 of file PropertyList.cc.
|
virtual |
Replace 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. |
[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)) |
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.
|
virtual |
Make a deep copy of the PropertyList and all of its contents.
Reimplemented from lsst::daf::base::PropertySet.
Definition at line 50 of file PropertyList.cc.
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.
|
inherited |
Determine if a name (possibly hierarchical) exists.
[in] | name | Property name to examine, possibly hierarchical. |
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 61 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); return 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 67 of file PropertyList.cc.
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:
[in] | name | Property name to examine, possibly hierarchical. |
NotFoundError | Property does not exist. |
TypeError | Value does not match desired type. |
Definition at line 73 of file PropertyList.cc.
|
inherited |
Get the last value for a bool property name (possibly hierarchical).
Only bool properties are supported.
[in] | name | Property name to examine, possibly hierarchical. |
NotFoundError | Property does not exist. |
TypeError | Value is not a bool. |
|
inherited |
Get the last value for any arithmetic property name (possibly hierarchical).
[in] | name | Property name to examine, possibly hierarchical. |
NotFoundError | Property does not exist. |
TypeError | Value cannot be converted to double. |
|
inherited |
Get the last value for a bool/char/short/int property name (possibly hierarchical).
Unsigned int properties are not acceptable.
[in] | name | Property name to examine, possibly hierarchical. |
NotFoundError | Property does not exist. |
TypeError | Value cannot be converted to int. |
|
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.
[in] | name | Property name to examine, possibly hierarchical. |
NotFoundError | Property does not exist. |
TypeError | Value cannot be converted to int64_t. |
|
inherited |
Get the last value for a Persistable name (possibly hierarchical).
[in] | name | Property name to examine, possibly hierarchical. |
NotFoundError | Property does not exist. |
TypeError | Value is not a Persistable::Ptr. |
|
inherited |
Get the last value for a subproperty name (possibly hierarchical).
[in] | name | Property name to examine, possibly hierarchical. |
NotFoundError | Property does not exist. |
TypeError | Value is not a PropertySet::Ptr. |
|
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*
.
[in] | name | Property name to examine, possibly hierarchical. |
NotFoundError | Property does not exist. |
TypeError | Value is not a string. |
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 77 of file PropertyList.cc.
|
inherited |
|
staticinherited |
Return the memId of the next object to be allocated.
Definition at line 209 of file Citizen.cc.
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.
|
staticinherited |
Check all allocated blocks for corruption.
Definition at line 316 of file Citizen.cc.
|
staticinherited |
Called once when the memory system is being initialised.
Definition at line 196 of file Citizen.cc.
|
inherited |
Determine if a name (possibly hierarchical) has multiple values.
[in] | name | Property name to examine, possibly hierarchical. |
|
inherited |
Determine if a name (possibly hierarchical) is a subproperty.
[in] | name | Property name to examine, possibly hierarchical. |
|
inherited |
Determine if a name (possibly hierarchical) has a defined value.
[in] | name | Property name to examine, possibly hierarchical. |
|
inherited |
Mark a Citizen as persistent and not destroyed until process end.
Definition at line 225 of file Citizen.cc.
|
inherited |
Get the number of names in the PropertySet, optionally including those in subproperties.
[in] | topLevelOnly | If true (default) omit names from subproperties and names of subproperties. |
|
inherited |
Get the names in the PropertySet, optionally including those in subproperties.
[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" |
|
inherited |
A variant of names that excludes the names of subproperties.
|
inherited |
A variant of names that only returns the names of subproperties.
|
virtual |
Remove 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 216 of file PropertyList.cc.
|
inherited |
Return a string representation of a Citizen.
Definition at line 219 of file Citizen.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 scalar value.
[in] | name | Property name to set, possibly hierarchical. |
[in] | value | Value to set. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 113 of file PropertyList.cc.
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.
[in] | name | Property name to set, possibly hierarchical. |
[in] | value | Value to set. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 117 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 133 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 ). |
Definition at line 130 of file PropertyList.cc.
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.
[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 153 of file PropertyList.cc.
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.
[in] | name | Property name to set, possibly hierarchical. |
[in] | value | Vector value to set. |
[in] | comment | Comment to set. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 163 of file PropertyList.cc.
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.
[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 158 of file PropertyList.cc.
|
inline |
Version of set scalar value that accepts a comment.
[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 245 of file PropertyList.h.
|
inline |
Version of set vector value that accepts a comment.
[in] | name | Property name to set, possibly hierarchical. |
[in] | value | Vector value to set. |
[in] | comment | Comment to set. |
InvalidParameterError | Hierarchical name uses non-PropertySet. |
Definition at line 251 of file PropertyList.h.
|
inline |
Version of set char* value that accepts a comment.
[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 256 of file PropertyList.h.
|
staticinherited |
Set the CorruptionCallback function.
func | function be called when block is found to be corrupted |
Definition at line 391 of file Citizen.cc.
|
staticinherited |
Set the DeleteCallback function.
func | function be called when desired block is deleted |
Definition at line 381 of file Citizen.cc.
|
staticinherited |
Call the current DeleteCallback when block is deleted.
id | Desired ID |
Definition at line 347 of file Citizen.cc.
|
staticinherited |
Set the NewCallback function.
func | The new function to be called when a designated block is allocated |
Definition at line 371 of file Citizen.cc.
|
staticinherited |
Call the NewCallback when block is allocated.
id | Desired ID |
Definition at line 337 of file Citizen.cc.
|
virtual |
Generate a string representation of the PropertySet.
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 93 of file PropertyList.cc.
|
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.
[in] | name | Property name to examine, possibly hierarchical. |
NotFoundError | Property does not exist. |
|
staticinherited |
Get type info for the specified class.
|
inherited |
Get the number of values for a property name (possibly hierarchical).
[in] | name | Property name to examine, possibly hierarchical. |