ObjectState.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file ObjectState.hh
 *
 * Declaration of ObjectState class.
 *
 * @author Lasse Laasonen 2003 (lasse.laasonen-no.spam-tut.fi)
 * @note reviewed 8 Jun 2004 by tr, jm, am, ll
 * @note rating: red
 */
 
#ifndef TTA_OBJECT_STATE_HH
#define TTA_OBJECT_STATE_HH
 
#include <string>
#include <vector>
 
#include "Exception.hh"
#include "BaseType.hh"
 
/**
 * Class ObjectState represents state of an object.
 *
 * It may contain attribute-value pairs of the object and a main
 * value. It may be used as a node in tree structure or alone. If a
 * class is going to be serialized to a file, it must be able to
 * create an ObjectState object of itself. It must be able to create
 * itself from an ObjectState object too. That is, it must implement
 * the Serializable interface.  ObjectState tree is a general
 * structure which can be handled by many different kind of
 * serializers, for example XMLSerializer. Serializers can read a file
 * create an ObjectState tree according to it and they can write a
 * file of a certain format according to a ObjectState
 * tree. ObjectState enables an easy way to serialize an object model
 * to different kinds of file formats.
 */
class ObjectState {
public:
    /// Struct for describing an attribute of the XML element.
    struct Attribute {
        std::string name;  ///< Name of the attribute.
        std::string value; ///< Value of the attribute.
    };
 
    ObjectState(const std::string& name, ObjectState* parent=NULL);
    ObjectState(const ObjectState& old);
    ~ObjectState();
 
    ObjectState* parent() const;
    std::string name() const;
    void setName(const std::string& name);
 
    void setValue(const std::string& value);
    void setValue(int value);
    void setValue(double value);
    void setValue(bool value);
    void setValue(UIntWord value);
 
    std::string stringValue() const;
    int intValue() const;
    unsigned int unsignedIntValue() const;
    double doubleValue() const;
    bool boolValue() const;
    int UIntWordValue() const;
 
    void setAttribute(const std::string& name, const std::string& value);
    void setAttribute(const std::string& name, int value);
    void setAttribute(const std::string& name, unsigned int value);
    void setAttribute(const std::string& name, double value);
    void setAttribute(const std::string& name, bool value);
    void setAttribute(const std::string& name, ULongWord value);
 
    int attributeCount() const;
    Attribute* attribute(int index) const;
 
    bool hasAttribute(const std::string& name) const;
    std::string stringAttribute(const std::string& name) const;
    int intAttribute(const std::string& name) const;
    unsigned int unsignedIntAttribute(const std::string& name) const;
    double doubleAttribute(const std::string& name) const;
    bool boolAttribute(const std::string& name) const;
    UIntWord UIntWordAttribute(const std::string& name) const;
    ULongWord uLongAttribute(const std::string& name) const;
 
    bool hasChild(const std::string& name) const;
    void addChild(ObjectState* child);
    void removeChild(ObjectState* child);
    void replaceChild(ObjectState* old, ObjectState* newChild);
 
    int childCount() const;
    ObjectState* childByName(const std::string& name) const;
    ObjectState* child(int index) const;
 
    bool operator!=(const ObjectState& object);
 
    static void dumpObjectState(
        const ObjectState& state,
        std::ostream& output,
        const std::string& identation = "");
 
private:
    /// Table of child ObjectState.
    typedef std::vector<ObjectState*> ChildTable;
    /// Table of attributes.
    typedef std::vector<Attribute> AttributeTable;
 
    /// Assingment forbidden.
    ObjectState& operator=(const ObjectState& old);
    std::string commonErrorMessage() const;
 
    /// Name of the element.
    std::string name_;
 
    /// The value of a leaf element.
    std::string value_;
 
    /// The parent element.
    ObjectState* parent_;
 
    /// The child elements.
    ChildTable children_;
 
    /// Contains all the attributes of the element.
    AttributeTable attributes_;
};
 
#include "ObjectState.icc"
 
#endif