basedevice.h

Go to the documentation of this file.

/*******************************************************************************
  Copyright(c) 2011 Jasem Mutlaq. All rights reserved.
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Library General Public
 License version 2 as published by the Free Software Foundation.
 
 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
 Library General Public License for more details.
 
 You should have received a copy of the GNU Library General Public License
 along with this library; see the file COPYING.LIB.  If not, write to
 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 Boston, MA 02110-1301, USA.
*******************************************************************************/
 
#pragma once
 
#include "indibase.h"
#include "indiproperty.h"
#include "indiproperties.h"
#include "indiutility.h"
 
#include <string>
#include <vector>
#include <cstdint>
 
// #define MAXRBUF 2048 // #PS: defined in indibase.h
 
namespace INDI
{
 
class BaseDevicePrivate;
class BaseDevice
{
        DECLARE_PRIVATE(BaseDevice)
    public:
        typedef INDI::Properties Properties;
        // typedef std::vector<INDI::Property*> Properties;
 
        enum INDI_ERROR
        {
            INDI_DEVICE_NOT_FOUND    = -1, 
            INDI_PROPERTY_INVALID    = -2, 
            INDI_PROPERTY_DUPLICATED = -3, 
            INDI_DISPATCH_ERROR      = -4  
        };
 
        enum
        {
            INDI_ENABLED,
            INDI_DISABLED
        };
 
        enum DRIVER_INTERFACE
        {
            GENERAL_INTERFACE       = 0,         
            TELESCOPE_INTERFACE     = (1 << 0),  
            CCD_INTERFACE           = (1 << 1),  
            GUIDER_INTERFACE        = (1 << 2),  
            FOCUSER_INTERFACE       = (1 << 3),  
            FILTER_INTERFACE        = (1 << 4),  
            DOME_INTERFACE          = (1 << 5),  
            GPS_INTERFACE           = (1 << 6),  
            WEATHER_INTERFACE       = (1 << 7),  
            AO_INTERFACE            = (1 << 8),  
            DUSTCAP_INTERFACE       = (1 << 9),  
            LIGHTBOX_INTERFACE      = (1 << 10), 
            DETECTOR_INTERFACE      = (1 << 11), 
            ROTATOR_INTERFACE       = (1 << 12), 
            SPECTROGRAPH_INTERFACE  = (1 << 13), 
            CORRELATOR_INTERFACE    = (1 << 14), 
            AUX_INTERFACE           = (1 << 15), 
            SENSOR_INTERFACE        = SPECTROGRAPH_INTERFACE | DETECTOR_INTERFACE | CORRELATOR_INTERFACE
        };
    public:
        BaseDevice();
        virtual ~BaseDevice();
 
    public:
        INDI::PropertyView<INumber> *getNumber(const char *name) const;
        INDI::PropertyView<IText>   *getText(const char *name) const;
        INDI::PropertyView<ISwitch> *getSwitch(const char *name) const;
        INDI::PropertyView<ILight>  *getLight(const char *name) const;
        INDI::PropertyView<IBLOB>   *getBLOB(const char *name) const;
 
    public:
        IPState getPropertyState(const char *name) const;
        IPerm getPropertyPermission(const char *name) const;
 
    public:
        void registerProperty(void *p, INDI_PROPERTY_TYPE type);
 
        // #PS: will be deprecated / backward compatibility
        void registerProperty(ITextVectorProperty *property);
        void registerProperty(INumberVectorProperty *property);
        void registerProperty(ISwitchVectorProperty *property);
        void registerProperty(ILightVectorProperty *property);
        void registerProperty(IBLOBVectorProperty *property);
 
        void registerProperty(INDI::PropertyView<IText> *property);
        void registerProperty(INDI::PropertyView<INumber> *property);
        void registerProperty(INDI::PropertyView<ISwitch> *property);
        void registerProperty(INDI::PropertyView<ILight> *property);
        void registerProperty(INDI::PropertyView<IBLOB> *property);
 
        void registerProperty(INDI::Property &property);
 
        int removeProperty(const char *name, char *errmsg);
 
        void *getRawProperty(const char *name, INDI_PROPERTY_TYPE type = INDI_UNKNOWN) const;
 
        Property getProperty(const char *name, INDI_PROPERTY_TYPE type = INDI_UNKNOWN) const;
 
        Properties getProperties();
        const Properties getProperties() const;
 
    public:
        void addMessage(const std::string &msg);
        void checkMessage(XMLEle *root);
        void doMessage(XMLEle *msg);
 
        const std::string &messageQueue(size_t index) const;
 
        const std::string &lastMessage() const;
 
    public:
        bool isConnected() const;
 
        void setMediator(INDI::BaseMediator *mediator);
 
        INDI::BaseMediator *getMediator() const;
 
        void setDeviceName(const char *dev);
 
        const char *getDeviceName() const;
 
        bool isDeviceNameMatch(const char *otherName) const;
 
        bool isDeviceNameMatch(const std::string &otherName) const;
 
        const char *getDriverName() const;
 
        const char *getDriverExec() const;
 
        const char *getDriverVersion() const;
 
        virtual uint16_t getDriverInterface();
 
    public:
        bool buildSkeleton(const char *filename);
 
        int buildProp(XMLEle *root, char *errmsg, bool isDynamic = false);
 
        int setValue(XMLEle *root, char *errmsg);
 
        int setBLOB(IBLOBVectorProperty *pp, XMLEle *root, char *errmsg);
 
    protected:
        std::shared_ptr<BaseDevicePrivate> d_ptr;
        BaseDevice(BaseDevicePrivate &dd);
};
 
}