IOController_i.idl

/*
 * Copyright (c) 2015 Pavel Vainerman.
 *
 * 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 2.1.
 *
 * 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 Lesser 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 BaseIOController_i_IDL_
#define BaseIOController_i_IDL_
// --------------------------------------------------------------------------
#include "../UniSetTypes/UniSetTypes_i.idl"
#include "../UniSetTypes/UniSetManager_i.idl"
// --------------------------------------------------------------------------------------------------------------

interface IOController_i : UniSetManager_i
{
    // исключения

    exception NameNotFound
    {
        string err;
    };

    exception IOBadParam
    {
        string err;
    };

    exception Undefined
    {
        long value; // текущее значение (может быть специальным undefined_value)
    };

    struct SensorInfo
    {
        uniset::ObjectId id;    
        uniset::ObjectId node;  
    };

    long getValue(in uniset::ObjectId sid) raises(NameNotFound,Undefined);
    void setValue(in uniset::ObjectId sid, in long value,
                    in uniset::ObjectId sup_id) raises(NameNotFound,Undefined);

    // установка неопределённого состояния
    // (пока работает только для аналоговых датчиков)
    void setUndefinedState(in uniset::ObjectId sid, in boolean undefined, in uniset::ObjectId sup_id )
                            raises(NameNotFound);

    // "заморозка"/"разморозка" значения. set=true - выставить value и не менять, пока не будет вызван set=false
    void freezeValue(in uniset::ObjectId sid, in boolean set, in long value, in uniset::ObjectId sup_id ) raises(NameNotFound);

    UniversalIO::IOType getIOType(in uniset::ObjectId sid) raises(NameNotFound);

    // --- Интерфейс для конфигурирования ---

    long getRawValue( in uniset::ObjectId sid ) raises(NameNotFound);

    struct CalibrateInfo
    {
        long minRaw;      
        long maxRaw;      
        long minCal;      
        long maxCal;      
        short precision;  
    };

    void calibrate( in uniset::ObjectId sid, in CalibrateInfo ci, in uniset::ObjectId adminId ) raises(NameNotFound);
    CalibrateInfo getCalibrateInfo( in uniset::ObjectId sid ) raises(NameNotFound);

    // --- Интерфейс получения информации о всех датчиках ---
    struct SensorIOInfo
    {
        long value;                   
        boolean undefined;            
        boolean blocked;              
        boolean frozen;               
        long real_value;              
        UniversalIO::IOType type;     
        long priority;                
        IOController_i::SensorInfo si;
        long default_val;             
        CalibrateInfo ci;             
        unsigned long tv_sec;         
        unsigned long tv_nsec;        
        uniset::ObjectId supplier;    
        boolean dbignore;             
        uniset::ObjectId depend_sid;  
    };

    typedef sequence<SensorIOInfo> SensorInfoSeq;

    SensorInfoSeq getSensorsMap();
    SensorIOInfo getSensorIOInfo( in uniset::ObjectId sid ) raises(NameNotFound);

    // -- Функции работы со списком датчиков --

    SensorInfoSeq getSensorSeq( in uniset::IDSeq lst );

    struct OutInfo
    {
        SensorInfo si;    
        long value;       
    };

    typedef sequence<OutInfo> OutSeq;

    uniset::IDSeq setOutputSeq( in OutSeq lst, in uniset::ObjectId sup_id );


    struct ShortIOInfo
    {
        long value;

        // могут быть проблемы в 64bit-ных
        unsigned long tv_sec;    
        unsigned long tv_nsec;   
        uniset::ObjectId supplier; 
    };

    ShortIOInfo getTimeChange( in uniset::ObjectId sid ) raises(NameNotFound);


    struct ShortMap
    {
        UniversalIO::IOType type;
        long value;
        long id;
    };

    typedef sequence<ShortMap> ShortMapSeq;

    ShortMapSeq getSensors();
};

// --------------------------------------------------------------------------------------------------------------
interface IONotifyController_i : IOController_i
{
    exception BadRange
    {
    };

    void askSensor(in uniset::ObjectId sid, in uniset::ConsumerInfo ci, in UniversalIO::UIOCommand cmd ) raises(NameNotFound,IOBadParam);

    uniset::IDSeq askSensorsSeq( in uniset::IDSeq lst,
                                        in uniset::ConsumerInfo ci,
                                        in UniversalIO::UIOCommand cmd );


    enum ThresholdState
    {
        LowThreshold,       
        NormalThreshold,    
        HiThreshold         
    };

    struct ThresholdInfo
    {
        uniset::ThresholdId id;
        long hilimit;         
        long lowlimit;        
        ThresholdState state;
        unsigned long tv_sec;    
        unsigned long tv_nsec;   
        boolean invert;       
    };

    typedef sequence<ThresholdInfo> ThresholdInfoSeq;

    void askThreshold(in uniset::ObjectId sid, in uniset::ConsumerInfo ci, in uniset::ThresholdId tid,
                        in long lowLimit, in long hiLimit, in boolean invert,
                        in UniversalIO::UIOCommand cmd ) raises(NameNotFound, IOBadParam, BadRange);


    ThresholdInfo getThresholdInfo( in uniset::ObjectId sid, in uniset::ThresholdId tid ) raises(NameNotFound);

    struct ThresholdList
    {
        IOController_i::SensorInfo si;
        UniversalIO::IOType type;
        long value;
        ThresholdInfoSeq tlist;
    };

    typedef sequence<ThresholdList> ThresholdsListSeq;

    ThresholdList getThresholds( in uniset::ObjectId sid ) raises(NameNotFound);

    ThresholdsListSeq getThresholdsList();
};
// --------------------------------------------------------------------------
#endif