PropertySet.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/*
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */

#ifndef LSST_DAF_BASE_PROPERTYSET
#define LSST_DAF_BASE_PROPERTYSET

#include <memory>
#include <string>
#include <typeinfo>
#include <unordered_map>
#include <vector>

#include "boost/any.hpp"

#include "lsst/base.h"
#include "lsst/daf/base/Citizen.h"
#include "lsst/daf/base/Persistable.h"
#include "lsst/pex/exceptions.h"

namespace lsst {
namespace daf {
namespace base {

#if defined(__ICC)
#pragma warning(push)
#pragma warning(disable : 444)
#endif

class LSST_EXPORT PropertySet : public Citizen {
public:
    // Typedefs
    typedef std::shared_ptr<PropertySet> Ptr;
    typedef std::shared_ptr<PropertySet const> ConstPtr;

    explicit PropertySet(bool flat = false);

    virtual ~PropertySet() noexcept;

    // No copying
    PropertySet(const PropertySet&) = delete;
    PropertySet& operator=(const PropertySet&) = delete;

    // No moving
    PropertySet(PropertySet&&) = delete;
    PropertySet& operator=(PropertySet&&) = delete;

    // Accessors

    virtual Ptr deepCopy() const;

    size_t nameCount(bool topLevelOnly = true) const;

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

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

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

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

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

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

    bool isUndefined(std::string const& name) const;

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

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

     // Implemented in the .cc file to work around symbol visiblity issues on macOS
     // e.g. https://github.com/pybind/pybind11/issues/1503
    template <typename T>
    static std::type_info const& typeOfT();

    // The following throw an exception if the type does not match exactly.

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

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

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

    // The following throw an exception if the conversion is inappropriate.

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

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

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

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

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

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

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

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

    // Modifiers

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

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

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

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

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

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

    virtual void copy(std::string const& dest, ConstPtr source, std::string const& name,
                      bool asScalar = false);

    virtual void combine(ConstPtr source);

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

protected:
    /*
     * Find the property name (possibly hierarchical) and set or replace its
     * value with the given vector of values.  Hook for subclass overrides of
     * top-level setting.
     *
     * @param[in] name Property name to find, possibly hierarchical.
     * @param[in] vp shared_ptr to vector of values.
     * @throws InvalidParameterError Hierarchical name uses non-PropertySet.
     */
    virtual void _set(std::string const& name, std::shared_ptr<std::vector<boost::any> > vp);

    /*
     * Find the property name (possibly hierarchical) and append or set its
     * value with the given vector of values.
     *
     * @param[in] name Property name to find, possibly hierarchical.
     * @param[in] vp shared_ptr to vector of values.
     * @throws InvalidParameterError Hierarchical name uses non-PropertySet.
     */
    virtual void _add(std::string const& name, std::shared_ptr<std::vector<boost::any> > vp);

    // Format a value in human-readable form; called by toString
    virtual std::string _format(std::string const& name) const;

private:

    typedef std::unordered_map<std::string, std::shared_ptr<std::vector<boost::any> > > AnyMap;

    /*
     * Find the property name (possibly hierarchical).
     *
     * @param[in] name Property name to find, possibly hierarchical.
     * @return unordered_map::iterator to the property or end() if nonexistent.
     */
    AnyMap::iterator _find(std::string const& name);

    /*
     * Find the property name (possibly hierarchical).  Const version.
     *
     * @param[in] name Property name to find, possibly hierarchical.
     * @return unordered_map::const_iterator to the property or end().
     */
    AnyMap::const_iterator _find(std::string const& name) const;

    /*
     * Find the property name (possibly hierarchical) and set or replace its
     * value with the given vector of values.
     *
     * @param[in] name Property name to find, possibly hierarchical.
     * @param[in] vp shared_ptr to vector of values.
     * @throws InvalidParameterError Hierarchical name uses non-PropertySet.
     */
    virtual void _findOrInsert(std::string const& name, std::shared_ptr<std::vector<boost::any> > vp);
    void _cycleCheckPtrVec(std::vector<Ptr> const& v, std::string const& name);
    void _cycleCheckAnyVec(std::vector<boost::any> const& v, std::string const& name);
    void _cycleCheckPtr(Ptr const& v, std::string const& name);

    AnyMap _map;
    bool _flat;
};

#if defined(__ICC)
#pragma warning(pop)
#endif

template <>
void PropertySet::add<PropertySet::Ptr>(std::string const& name, Ptr const& value);
template <>
void PropertySet::add<PropertySet::Ptr>(std::string const& name, std::vector<Ptr> const& value);
}
}  // namespace daf
}  // namespace lsst

#endif