AgentDescriptor.h

Go to the documentation of this file.

/************************************************************************
* Verve                                                                 *
* Copyright (C) 2004-2006                                               *
* Tyler Streeter  tylerstreeter@gmail.com                               *
* All rights reserved.                                                  *
* Web: http://verve-agents.sourceforge.net                              *
*                                                                       *
* This library is free software; you can redistribute it and/or         *
* modify it under the terms of EITHER:                                  *
*   (1) 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. The text of the GNU Lesser      *
*       General Public License is included with this library in the     *
*       file license-LGPL.txt.                                          *
*   (2) The BSD-style license that is included with this library in     *
*       the file license-BSD.txt.                                       *
*                                                                       *
* 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 files    *
* license-LGPL.txt and license-BSD.txt for more details.                *
************************************************************************/

#ifndef VERVE_AGENT_DESCRIPTOR_H
#define VERVE_AGENT_DESCRIPTOR_H

#include "Globals.h"

namespace verve
{
        struct ContinuousSensorDescriptor
        {
                ContinuousSensorDescriptor()
                {
                        isCircular = false;
                }

                bool isCircular;
        };

        struct DiscreteSensorDescriptor
        {
                DiscreteSensorDescriptor()
                {
                        numOptions = 0;
                }

                unsigned int numOptions;
        };

        class AgentDescriptor
        {
        public:
                VERVE_DECL AgentDescriptor();

                VERVE_DECL AgentDescriptor(const AgentDescriptor& desc);
                
                VERVE_DECL virtual ~AgentDescriptor();

                VERVE_DECL virtual void VERVE_CALL addDiscreteSensor(
                        unsigned int numOptions);

                VERVE_DECL virtual unsigned int VERVE_CALL 
                        getNumDiscreteSensors()const;

                VERVE_DECL virtual unsigned int VERVE_CALL 
                        getDiscreteSensorNumOptions(unsigned int i)const;

                VERVE_DECL virtual void VERVE_CALL addContinuousSensor(
                        bool isCircular = false);

                VERVE_DECL virtual unsigned int VERVE_CALL 
                        getNumContinuousSensors()const;

                VERVE_DECL virtual bool VERVE_CALL 
                        getContinuousSensorIsCircular(unsigned int i)const;

                VERVE_DECL virtual void VERVE_CALL setNumOutputs(
                        unsigned int numOutputs);

                VERVE_DECL virtual unsigned int VERVE_CALL getNumOutputs()const;

                VERVE_DECL virtual void VERVE_CALL setContinuousSensorResolution(
                        unsigned int resolution);

                VERVE_DECL virtual unsigned int VERVE_CALL 
                        getContinuousSensorResolution()const;

                VERVE_DECL virtual void VERVE_CALL setDynamicRBFEnabled(
                        bool enabled);

                VERVE_DECL virtual bool VERVE_CALL isDynamicRBFEnabled()const;

                VERVE_DECL virtual void VERVE_CALL setArchitecture(
                        AgentArchitecture arch);

                VERVE_DECL virtual AgentArchitecture VERVE_CALL getArchitecture()const;

                VERVE_DECL virtual void VERVE_CALL setMaxNumPlanningSteps(
                        unsigned int steps);

                VERVE_DECL virtual unsigned int VERVE_CALL 
                        getMaxNumPlanningSteps()const;

                VERVE_DECL virtual void VERVE_CALL setPlanningUncertaintyThreshold(
                        real threshold);

                VERVE_DECL virtual real VERVE_CALL 
                        getPlanningUncertaintyThreshold()const;

        private:
                std::vector<DiscreteSensorDescriptor> mDiscreteSensors;

                std::vector<ContinuousSensorDescriptor> mContinuousSensors;

                unsigned int mNumOutputs;

                unsigned int mContinuousSensorResolution;

                bool mDynamicRBFEnabled;

                AgentArchitecture mAgentArchitecture;

                unsigned int mMaxNumPlanningSteps;

                real mPlanningUncertaintyThreshold;
        };
}

#endif

---