AttributeSet.h

Go to the documentation of this file.

#ifndef OPALX_AttributeSet_HH
#define OPALX_AttributeSet_HH
 
// ------------------------------------------------------------------------
// $RCSfile: AttributeSet.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.2 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class: AttributeSet
//   A map of name (std::string) versus value (double) intended to store
//   user-defined attributes.
//
// ------------------------------------------------------------------------
// Class category: AbsBeamline
// ------------------------------------------------------------------------
//
// $Date: 2000/12/16 16:26:43 $
// $Author: mad $
//
// ------------------------------------------------------------------------
 
// #include "Channels/Channel.h"
#include <functional>
#include <map>
#include <string>
 
class Channel;
class ConstChannel;
 
// Class AttributeSet
// ------------------------------------------------------------------------
//  Class AttributeSet implements a map of name (std::string) versus value
//  (double) for user-defined attributes.  This map is intended for
//  algorithms that require specific, but not predefined data in the
//  accelerator model for their working.
 
class AttributeSet {
public:
    typedef std::map<std::string, double, std::less<std::string> > NameMap;
 
    typedef NameMap::const_iterator const_iterator;
 
    //  Constructs an empty map.
    AttributeSet();
 
    AttributeSet(const AttributeSet&);
    virtual ~AttributeSet();
    const AttributeSet& operator=(const AttributeSet&);
 
    const_iterator begin() const;
 
    const_iterator end() const;
 
    //  If the attribute does not exist, return zero.
    double getAttribute(const std::string& aKey) const;
 
    //  If the attribute exists, return true, otherwise false.
    bool hasAttribute(const std::string& aKey) const;
 
    //  If the key [b]aKey[/b] exists, this method removes it.
    void removeAttribute(const std::string& aKey);
 
    void setAttribute(const std::string& aKey, double val);
 
    //  This method constructs a Channel permitting read/write access to
    //  the attribute [b]aKey[/b] and returns it.
    //  If the attribute does not exist, it returns nullptr.
    Channel* getChannel(const std::string& aKey, bool create = false);
 
    //  This method constructs a Channel permitting read-only access to
    //  the attribute [b]aKey[/b] and returns it.
    //  If the attribute does not exist, it returns nullptr.
    const ConstChannel* getConstChannel(const std::string& aKey) const;
 
protected:
 
    NameMap itsMap;
};
 
// Implementation.
// ------------------------------------------------------------------------
 
inline AttributeSet::const_iterator AttributeSet::begin() const { return itsMap.begin(); }
 
inline AttributeSet::const_iterator AttributeSet::end() const { return itsMap.end(); }
 
#endif  // OPALX_AttributeSet_HH