Event.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 EVENT_HEADER
#define EVENT_HEADER

#include <string>
#include <vector>
#include <stdexcept>

#include "../dllinclude.h"
#include "EventAttribute.h"
#include "EventAttributeBase.h"
#include "iostream_ext.h"
#include "OSUtils.h"

#ifdef USE_CORBA
#include <OpenTracker/skeletons/OT_CORBA.hh>
#endif //USE_CORBA

namespace ot
{
    typedef std::map<std::string, EventAttributeBase*> AttributeMap;
    template <typename T>
    static T* copyV2A(const std::vector<T> &vector, T* array)
    {
        for (unsigned int i = 0; i < vector.size(); i++)
            array[i] = vector[i];
        return array;
    };
    template <typename T>
    static std::vector<T>& copyA2V(const T *array, const int arraySize, std::vector<T> &vector)
    {
        vector.clear();
        for (int i = 0; i < arraySize; i++)
            vector.push_back(array[i]);  // do not use operator[] here, it will not work, since no memory will be allocated!
        return vector;
    };
    template <typename T>
    static const std::vector<T> copyA2V(const T *array, const int arraySize)
    {
        std::vector<T> vector;
        for (int i = 0; i < arraySize; i++)
            vector.push_back(array[i]);  // do not use operator[] here, it will not work, since no memory will be allocated!!
        return vector;
    };


    class OPENTRACKER_API Event
    {
    public:
        Event();
        Event(const Event &rv);

#ifdef USE_CORBA
        Event(const OT_CORBA::Event &ev);
#endif

        ~Event();


        Event& operator=(const Event &rv); //throw (std::runtime_error);
        bool hasAttribute(const std::string &name) const;
        bool delAttribute(const std::string &name);
        bool renAttribute(const std::string &oldName, const std::string &newName);
        void copyAllButStdAttr(const Event &rv);
        void clearAttributes();
        void printout() const;
        const std::string getPrintOut() const;
                void getPrintOut(std::string &outstr) const;
        void timeStamp();
        void serialize(std::ostream &out) const;
        const std::string serialize() const;
        std::istream& deserialize(std::istream &in);
        void deserialize(std::string &str);
        inline int getSize() const { return (int)attributes.size(); };
        const std::type_info& getAttributeType(const std::string &name) const throw (std::invalid_argument);
        const std::string& getAttributeTypeName(const std::string &name) const throw (std::invalid_argument);
        const std::string& getAttributeName(const int index) const throw (std::invalid_argument);
        int getAttributeIndex(const std::string &name) const throw (std::invalid_argument);



        std::vector<float>& getPosition();
        inline const std::vector<float>& getPosition() const { return (const_cast<Event *>(this))->getPosition(); }
        std::vector<float>& getOrientation();
        inline const std::vector<float>& getOrientation() const { return (const_cast<Event *>(this))->getOrientation(); }
        float& getConfidence();
        const float& getConfidence() const { return (const_cast<Event *>(this))->getConfidence(); }
        unsigned short& getButton();
        const unsigned short& getButton() const { return (const_cast<Event *>(this))->getButton(); }
        inline void setPosition(const std::vector<float> &value) { setAttribute("position", value); };
        inline void setPosition(const float *value) { setAttribute("position", copyA2V(value, 3)); };
        inline void setOrientation(const std::vector<float> &value) { setAttribute("orientation", value); };
        inline void setOrientation(const float *value) { setAttribute("orientation", copyA2V(value, 4)); };
        inline void setConfidence(const float &value) { setAttribute("confidence", value); };
        inline void setButton(const unsigned short &value) { setAttribute("button", value); };




        bool addAttribute(const std::string &type, const std::string &name, const std::string &value); //throw (std::runtime_error);
        bool setAttribute(const std::string &type, const std::string &name, const std::string &value); //throw (std::runtime_error);
        const std::string getAttributeValueString(const std::string &name) const throw (std::invalid_argument);


        static void registerAllKnownTypes();
        static bool knowsType(const std::string typeName);
#ifdef USE_CORBA
        OT_CORBA::Event getCORBAEvent();
#endif

        template <typename T>
            static void registerGenericTypeName(const T *dummy, const std::string &genericTypeName)
        {
            EventAttributeBase::registerType(genericTypeName, typeid(T), EventAttribute<T>::create);
        };
        template <typename T>
            T& getAttribute(const T *dummy, const std::string &name) //throw (std::invalid_argument)
        {
            AttributeMap::const_iterator it = attributes.find(name);
            if (it == attributes.end())
            {
                std::string errorStr = "event does not have attribute called '" + name + "'";
                throw std::invalid_argument(errorStr);
            }
            else
            {
                EventAttribute<T> *att = dynamic_cast<EventAttribute<T>*>((*it).second);
                if (att)
                    return att->get();
                else
                {
                    std::string errorStr = "attribute called '" + name + "' is not of type '" + typeid(T).name() + "'";
                    throw std::invalid_argument(errorStr);
                }
            }
        };
        template <typename T>
            const T& getAttribute(const T *dummy, const std::string &name) const throw (std::invalid_argument)
        {
            return (const_cast<Event *>(this))->getAttribute(dummy, name);
        };
        template <typename T>
            T& getAttribute(const std::string &name, const T &defValue) //throw (std::invalid_argument, std::runtime_error)
        {
            try
            {
                return getAttribute((T*)NULL, name);
            }
            catch (std::invalid_argument)
            {
                addAttribute(name, defValue); // may throw std::runtime_error
                return getAttribute((T*)NULL, name); // may throw std::invalid_argument
            }
        };
        template <typename T>
            bool addAttribute(const std::string &name, const T &value) //throw (std::runtime_error)
        {
            if (hasAttribute(name))
                return false;
            else
            {
                EventAttributeBase *att = EventAttributeBase::create(typeid(T)); // may throw std::runtime_error
                attributes[name] = att;
                return setAttribute(name, value);
            }
        };
        template <typename T>
            bool setAttribute(const std::string &name, const T &value) //throw (std::runtime_error)
        {
            if (!hasAttribute(name))
                attributes[name] = EventAttributeBase::create(typeid(T)); // may throw std::runtime_error
            EventAttribute<T> *att = dynamic_cast<EventAttribute<T>*>(attributes[name]);
            if (att)
                att->set(value);
            return (att != NULL);
        };

    public:
        double time;
        static Event null;
    private:
        AttributeMap attributes;
    };

    OPENTRACKER_API std::istream& operator>>(std::istream &in, ot::Event &event);
    OPENTRACKER_API std::ostream& operator<<(std::ostream &out, const ot::Event &event);

} // namespace ot

#endif

/*
 * ------------------------------------------------------------
 *   End of Event.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:
 * ------------------------------------------------------------
 */

---