Node.h

Go to the documentation of this file.

/* ========================================================================
 * Copyright (c) 2006,
 * Institute for Computer Graphics and Vision
 * Graz University of Technology
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * Neither the name of the Graz University of Technology nor the names of
 * its contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ========================================================================
 * PROJECT: OpenTracker
 * ======================================================================== */
/* ======================================================================= */

#ifndef _NODE_H
#define _NODE_H

#include "../dllinclude.h"

#include <string>
#include <vector>

namespace ot {

    class Context;
    class ConfigurationParser;
    class Node;
    class NodePort;

#ifdef USE_LIVE
    class LiveContext;
#endif

} // namespace ot

#include "StringTable.h"
#include <OpenTracker/core/IRefCounted.h>
#include <OpenTracker/misc/Cptr.h>

#include "Event.h"
#ifdef USE_LIVE
#include <OpenTracker/skeletons/OTGraph.hh>
#endif

namespace ot {



#ifdef USE_LIVE
    class OPENTRACKER_API Node : public POA_OTGraph::Node,
                                 public PortableServer::RefCountServantBase
#else
    class OPENTRACKER_API Node
#endif
    {
        

    public:
#ifdef USE_LIVE
        typedef Node* Ptr;
#else
        OT_DECLARE_IREFCOUNTED;
        typedef Cptr<Node> Ptr;
#endif

    typedef std::vector<Ptr> NodeVector;

    protected:
        NodeVector parents;
        NodeVector children;

        StringTable attributes;


        std::string name;
        

        std::string type;

    public:
        enum error { OK=0,                              
                     GRAPH_CONSTRAINT,  
                     READONLY,                  
                     CONTEXT_ERROR,             
                     NOT_FOUND                  
        };

    protected:


    public:        

        Node();



        const std::string get( const std::string & key ) const;
        int get(const std::string & key, int * value, int len = 1 ) ;
        int get(const std::string & key, float * value, int len = 1 ) ;
        int get(const std::string & key, double * value, int len = 1 ) ;

        void put( const std::string &key, const std::string &value );
        void remove( const std::string &key );

        void put(const std::string & key, const int value);
        void put(const std::string & key, const float value);
        void put(const std::string & key, const double value);

        void put(const std::string & key, const int * value, int len);
        void put(const std::string & key, const float * value, int len);
        void put(const std::string & key, const double * value, int len);

    public:

        virtual ~Node();

        const std::string & getType() const
        {
            return type;
        }

        const std::string & getName() const
        {
            return name;
        }

        void setName(const std::string & name_){
            name = name_;
        }

        Context * getContext() const;


   
        Node * getParent();

        Node * getParent( unsigned int index);

        unsigned int countParents();
        unsigned int countChildren();



        Node * getChild( unsigned int index );

        error addChild(Node & child);

        error removeChild(Node & child);


        unsigned int countPorts();
#ifdef USE_LIVE
        char* get_type();
        char* get_name();
        char* get_id();
        char* get_attribute(const char* _key);
        OTGraph::StringTable* get_attributes();
#endif
        

        NodePort * getPort( const std::string & name, unsigned int index = 0 );

        NodePort * getPort( unsigned int index );

        error addPort( const std::string & name );

        error removePort( const std::string & name );

        error removePort( NodePort & port);

        error removePort( unsigned int index );



        virtual int isEventGenerator()
        {
            return 0;
        }

        virtual void onEventGenerated( Event& event, Node& generator)
        {
        }

        void updateObservers( Event &data );



        virtual int isEventQueue()
        {
            return 0;
        }
        virtual Event& getEvent(unsigned int index = 0)
        {
            return Event::null;
        }
        virtual Event& getEventNearTime(double time)
        {
            return Event::null;
        }
        virtual unsigned int getSize()
        {
            return 0;
        }



        virtual int isTimeDependend()
        {
            return 0;
        }

        virtual Event& getEventAtTime(double time)
        {
            return Event::null;
        }


        virtual int isNodePort()
        {
            return 0;
        }

        

        Node * findNode(const std::string & key, const std::string & val);
          
       // adds a parent to this node. Because the new implementation 
       // is a graph, any given child can have more than one parent.
        void addParent( Node * parent);

        unsigned int countAllChildren();

        Node * getAnyChild( unsigned int index);

        StringTable & getAttributes();



        friend class Context;

#ifdef USE_LIVE
        friend class LiveContext;
#endif
    };

} // namespace ot

#endif

/* 
 * ------------------------------------------------------------
 *   End of Node.h
 * ------------------------------------------------------------
 *   Automatic Emacs configuration follows.
 *   Local Variables:
 *   mode:c++
 *   c-basic-offset: 4
 *   eval: (c-set-offset 'substatement-open 0)
 *   eval: (c-set-offset 'case-label '+)
 *   eval: (c-set-offset 'statement 'c-lineup-runin-statements)
 *   eval: (setq indent-tabs-mode nil)
 *   End:
 * ------------------------------------------------------------ 
 */

---