descriptions-manager.h

Go to the documentation of this file.

/*
        Aseba - an event-based framework for distributed robot control
        Copyright (C) 2007--2012:
                Stephane Magnenat <stephane at magnenat dot net>
                (http://stephane.magnenat.net)
                and other contributors, see authors.txt for details
        
        This program 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, version 3 of the License.
        
        This program 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 program. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef ASEBA_DESCRIPTIONS_MANAGER_H
#define ASEBA_DESCRIPTIONS_MANAGER_H

#include "msg.h"
#include <string>

namespace Aseba
{
        
        class DescriptionsManager
        {
        protected:
                struct NodeDescription: public TargetDescription
                {
                        NodeDescription();
                        NodeDescription(const TargetDescription& targetDescription);
                        
                        unsigned namedVariablesReceptionCounter; 
                        unsigned localEventsReceptionCounter; 
                        unsigned nativeFunctionReceptionCounter; 
                };
                typedef std::map<unsigned, NodeDescription> NodesDescriptionsMap;
                NodesDescriptionsMap nodesDescriptions; 
                
        public:
                virtual ~DescriptionsManager() {}
                
                void processMessage(const Message* message);
                
                std::wstring getNodeName(unsigned nodeId) const;
                unsigned getNodeId(const std::wstring& name, unsigned preferedId = 0, bool *ok = 0) const;
                const TargetDescription * const getDescription(unsigned nodeId, bool *ok = 0) const;
                unsigned getVariablePos(unsigned nodeId, const std::wstring& name, bool *ok = 0) const;
                unsigned getVariableSize(unsigned nodeId, const std::wstring& name, bool *ok = 0) const;
                void reset();
                
                // TODO: reverse lookup?
                // TODO: move bytecode sender manager here, rename class?
                
        protected:
                void checkIfNodeDescriptionComplete(unsigned id, const NodeDescription& description);
                
                virtual void nodeProtocolVersionMismatch(const std::wstring &nodeName, uint16 protocolVersion) { }
                
                virtual void nodeDescriptionReceived(unsigned nodeId) { }
        };
        
}

#endif