XObject.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (C) 2011 by Benjamin Hadorn (b_hadorn@bluewin.ch)
 *****************************************************************************
 * Project    : Zeus Base Library
 * Module     : XObject
 * Package    : Zeus.ZeusBase.System
 * Author     : Benjamin Hadorn
 * Date       : 27.12.2011
 * System     : Zeus-Framework
 *****************************************************************************
 * Licence:                                                                  *
 *   This library is free software; you can redistribute it and/or modify    *
 *   it under the terms of the GNU Lesser General Public License as          *
 *   published by the Free Software Foundation; either version               *
 *   2.1 of the License, or (at your option) any later version.              *
 *                                                                           *
 *   This library 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 Lesser General Public License for more details.                     *
 *                                                                           *
 *   You should have received a copy of the GNU Lesser General Public        *
 *   License along with this library; if not, write to the Free Software     *
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA    *
 *****************************************************************************/

/*****************************************************************************
 * Changes:
 *  27.12.2011 bha: created zeus 2.0
 *****************************************************************************/

#ifndef XObjectH
#define XObjectH

#include <zeusbase/System/ZObject.h>
#include <zeusbase/System/SingleLinkedList.hpp>
#include <zeusbase/System/Interfaces/IXMLNode.hpp>
#include <zeusbase/System/Interfaces/IXObject.hpp>

BEGIN_NAMESPACE_Zeus

class TCriticalSection;
class TXMemberCollection;

/***************************************************************************/
/***************************************************************************/
zeusbase_class TXObject : public TZObject, public IXObject
{
  public:
    TXObject(IXMLNode& rNode);

    virtual TString getXMLStream() const;
    virtual TString getCodeModule() const;

    //Methods of IXObject
    virtual void MQUALIFIER getName(IString& rName)const;
    virtual void MQUALIFIER getClassName(IString& rName)const;
    virtual Uint MQUALIFIER getID()const;
    virtual Retval MQUALIFIER addChild(IXObject& rChild);
    virtual Retval MQUALIFIER deleteChild(Int iIndex, bool bDoFreeze=false);
    virtual Retval MQUALIFIER removeChild(IXObject& rChild, bool bDoFreeze=false);
    virtual Int MQUALIFIER getChildCount()const;
    virtual Retval MQUALIFIER getChild(Int iIndex, IXObject*& rpChild);
    virtual Retval MQUALIFIER getChildByName(const IString& rName, IXObject*& rpChild);
    virtual Retval MQUALIFIER getChildrenByName(const IString& name, IXObjectCollection*& pObjects);
    virtual Retval MQUALIFIER getParent(IXObject*& rpParent)const;
    virtual Retval MQUALIFIER setParent(IXObject* pParent);
    virtual Retval MQUALIFIER getXMLNode(IXMLNode*& rpNode) const;
    virtual Retval MQUALIFIER setChild(IXObject& rChild);
    virtual Retval MQUALIFIER getObject(const IString& rPath, IXObject*& rpObj);
    virtual Retval MQUALIFIER getObjects(const IString& rPath, IXObjectCollection*& pObjects);
    virtual Retval MQUALIFIER getRootObject(IXObject*& rpObj);
    virtual bool MQUALIFIER canCreateChildren()const;
    virtual bool MQUALIFIER freeze();
    virtual bool MQUALIFIER unfreeze();
    virtual bool MQUALIFIER isFrozen()const;
    virtual void MQUALIFIER setTreeLock(ICriticalSection* pSection);
    virtual void MQUALIFIER lockTree();
    virtual void MQUALIFIER unlockTree();
    virtual Retval MQUALIFIER onExecute(ISimpleCommand& rCommand, Uint uiMode);
    virtual void MQUALIFIER onBroadCast(ISimpleCommand& rMessage);
    virtual Retval MQUALIFIER insertChild(Int iIndex, IXObject& rChild);
    virtual Int MQUALIFIER indexOfChild(IXObject& rChild);
    virtual Retval MQUALIFIER createChildObject(const IString& rName,
                                                const IString& rClassName,
                                                const IString& rCodeModule,
                                                IXObject*& rpChild);
    virtual Retval MQUALIFIER createChildObjectCustom(const IString& rName,
                                                      const IString& rClassName,
                                                      const IString& rCodeModule,
                                                      const IStringList& rList,
                                                      IXObject*& rpChild);
    virtual Retval MQUALIFIER getCastedObject(const IString& rPath,
                                              const InterfaceID& rInterfaceID,
                                              IZUnknown*& rpObj);
    virtual Retval MQUALIFIER readIntAttribute(const IString& rName, Int& rValue, Int iDefault = 0) const;
    virtual Retval MQUALIFIER readUintAttribute(const IString& rName, Uint& rValue, Uint uiDefault = 0) const;
    virtual Retval MQUALIFIER readFloatAttribute(const IString& rName, Float& rValue, Float fDefault = 0) const;
    virtual Retval MQUALIFIER readStringAttribute(const IString& rName, IString& rValue) const;
    virtual Retval MQUALIFIER readTimevalAttribute(const IString& rstrName, Timeval& rtmValue, Timeval rtmDefault = 0) const;
    virtual Retval MQUALIFIER readBoolAttribute(const IString& rstrName, bool& rbValue, bool bDefault = false) const;
    virtual Retval MQUALIFIER storeIntAttribute(const IString& rName, const Int& rValue);
    virtual Retval MQUALIFIER storeUintAttribute(const IString& rName, const Uint& rValue);
    virtual Retval MQUALIFIER storeFloatAttribute(const IString& rName, const Float& rValue);
    virtual Retval MQUALIFIER storeStringAttribute(const IString& rName, const IString& rValue);
    virtual Retval MQUALIFIER storeTimevalAttribute(const IString& rstrName, const Timeval& rtmValue);
    virtual Retval MQUALIFIER storeBoolAttribute(const IString& rstrName, const bool& rbValue);
    virtual Int MQUALIFIER getMemberCount() const;
    virtual Retval MQUALIFIER getMemberVariable(Int iIndex, IXMemberVariable*& rpMember) const;
    virtual Retval MQUALIFIER getMemberVariableByName(const IString& rName, IXMemberVariable*& rpMember) const;
    virtual Retval MQUALIFIER addNewMemberVariable(const IString& rName, IXMemberVariable::EVariableType eType);
    virtual Retval MQUALIFIER removeMemberVariable(const IString& rName);
    virtual Retval MQUALIFIER getMemberObjectReference(const IString& rName, IXObject*& rpRef);
    virtual Retval MQUALIFIER getMemberXMLNode(const IString& rName, IXMLNode*& rpNode) const;
    virtual Retval MQUALIFIER readMemberVariable(const IString& rName, IZVariant& rValue) const;
    virtual Retval MQUALIFIER storeMemberVariable(const IString& rName, const IZVariant& rValue);
    virtual void MQUALIFIER resetMemberVariables();


    //Methods of IZUnknown
    MEMORY_MANAGER_DECL

    //Methods of TZObject
    virtual void setObjName(const TString& rName);


  protected:
    IXMLNode* m_pNode;
    ICriticalSection* m_pTreeLock;
    mutable TXMemberCollection* m_pMemberVariables;

    TXObject();
    virtual ~TXObject();

    virtual void onChildAdded(IXObject& /*rChild*/){};
    virtual void onChildDeleted(IXObject& /*rChild*/){};

    void freezeChildren();
    void unfreezeChildren();

  private:
    TSingleLinkedList<IXObject*> m_lstChildren;
    IXObject* m_pParent;
    bool m_bFrozen;
    TCriticalSection& m_rLock;

    void expandMembers() const;

  //DEPRECATED METHODS.
  protected:
    //Methods to read a persistent value
    inline Retval readAttribute(TString strName, TString& rValue) const { return readStringAttribute(strName, rValue); }
    inline Retval readAttribute(TString strName, Int& rValue) const     { return readIntAttribute(strName, rValue); }
    inline Retval readAttribute(TString strName, Uint& rValue) const    { return readUintAttribute(strName, rValue); }
    inline Retval readAttribute(TString strName, Float& rValue) const   { return readFloatAttribute(strName, rValue); }

    //Methods to write a persistent value
    inline Retval storeAttribute(TString strName, TString strValue) { return storeStringAttribute(strName, strValue); }
    inline Retval storeAttribute(TString strName, Int iValue)       { return storeIntAttribute(strName, iValue); }
    inline Retval storeAttribute(TString strName, Uint uiValue)     { return storeUintAttribute(strName, uiValue); }
    inline Retval storeAttribute(TString strName, Float fValue)     { return storeFloatAttribute(strName, fValue); }

};

//INLINE METHODS
/***************************************************************************/
/***************************************************************************/
inline void MQUALIFIER TXObject::getName(IString& rName)const
{
  rName.assignStr(TZObject::getObjName());
}

/***************************************************************************/
/***************************************************************************/
inline Int MQUALIFIER TXObject::getChildCount() const
{
  return m_lstChildren.getCount();
}

/***************************************************************************/
/***************************************************************************/
inline bool MQUALIFIER TXObject::canCreateChildren() const
{
  return true;
}

/***************************************************************************/
/***************************************************************************/
inline bool MQUALIFIER TXObject::isFrozen() const
{
  return m_bFrozen;
}

/***************************************************************************/
/***************************************************************************/
inline Retval MQUALIFIER TXObject::onExecute(ISimpleCommand& /*rCommand*/, Uint /*uiMode*/)
{
  return RET_REQUEST_FAILED;
}

/***************************************************************************/
/***************************************************************************/
inline Retval MQUALIFIER TXObject::setParent(IXObject* parent)
{
  m_pParent = parent; //To not allocate a reference, because of circularity
  return RET_NOERROR;
}

/***************************************************************************/
/***************************************************************************/
inline Int MQUALIFIER TXObject::indexOfChild(IXObject& rChild)
{
  return this->m_lstChildren.indexOf(&rChild);
}


/***************************************************************************/
/***************************************************************************/
inline void TXObject::setObjName(const TString& /*name*/)
{
  //Can not change the node name
}

END_NAMESPACE_Zeus
#endif