devicemanager_p.h

Go to the documentation of this file.

/*-*-c++-*-*****************************************************************
 devicemanager.h
 ---------------
 begin       : 15.03.2006
 copyright   : (C) 2006 by Christian Stimming
 email       : stimming@tuhh.de

 ***************************************************************************
 *                                                                         *
 *   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., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef SIMTHETIC_DEVICEMANAGER_P_H
#define SIMTHETIC_DEVICEMANAGER_P_H

#include "devicemanager.h"

#include <gwenhywfar/xml.h>

namespace simth {

  class DeviceDescriptionPriv {
        friend class DeviceDescription;
    friend class DeviceManager;
    friend class DeviceManagerPriv;
     private:
    std::string _name;
    std::string _type;
    std::string _type_escaped;
    std::string _extends;
    PropertyList _properties;
    Property::list_string _libraries;
    bool _abstract;
    std::string _description;
    DeviceDescription::IfaceList _input_interfaces;
    DeviceDescription::IfaceList _output_interfaces;

    // Read in a propertylist for a given device. If necessary,
    // recursively use this function for its parent devices.
    static void 
    _readDeviceProperties(PropertyList &pl, 
                  GWEN_XMLNODE *dn,
                  const std::string &dname,
                  int depth,
                  Property::list_string &sl,
                  DeviceDescription::IfaceList& input_interfaces,
                  DeviceDescription::IfaceList& output_interfaces);

    // Read a propertylist from a node for the given device. No more
    // recursion inside here.
    static void _readPropertylistNode(PropertyList &pl,
                      GWEN_XMLNODE *pnode,
                      const std::string &dname);

    // Read the overriddenproperties element here and remove the
    // respective elements from the given propertylist
    static void _readOverriddenPropNode(PropertyList &pl,
                        GWEN_XMLNODE *pnode,
                        const std::string &dname);

    // Read a interfacelist from a node for the given device. No
    // more recursion inside here.
    static void _readInterfacelistNode(DeviceDescription::IfaceList& iiflist,
                       GWEN_XMLNODE *pnode,
                       const std::string &dname);

    // Construct a DeviceDescription from the specified devicenode.
    DeviceDescriptionPriv (GWEN_XMLNODE *devicenode,
                   GWEN_XMLNODE *devicelist, 
                   const std::string& dname);

     public:
    DeviceDescriptionPriv();
    ~DeviceDescriptionPriv();
  };

  class DeviceManagerPriv {
     public:
    // Read in the given file name into the given rootnode and return
    // a pointer to the devicelist node.
    static GWEN_XMLNODE *
    _getDevicelistFromFile(DeviceManager &dm,
                   const std::string &fname,
                   GWEN_XMLNODE *rootnode)
       throw(file_not_found, bad_device_file);
    
    static GWEN_XMLNODE *findDeviceNode(GWEN_XMLNODE *dn,
                        const std::string &dname);
    
    static std::string getStringData(GWEN_XMLNODE *node);

    static GWEN_XMLNODE *findNodeByName(GWEN_XMLNODE *node,
                        const std::string& node_name,
                        const std::string& filename,
                        bool required = true)
       throw(simth::bad_device_file);
  };


} /* namespace */


#endif /* SIMTHETIC_DEVICEMANAGER_H */

---