cinosdacchannel.h

Go to the documentation of this file.

//******************************************************************************
//******************************************************************************
 
#ifndef INC_CINOSDACCHANNEL_H
#define INC_CINOSDACCHANNEL_H
 
//------------------------------------------------------------------------------
// defines
//------------------------------------------------------------------------------
//
//
//------------------------------------------------------------------------------
// includes
//------------------------------------------------------------------------------
//
// system
//
// C++
//
// project
//
//------------------------------------------------------------------------------
// class definition
//------------------------------------------------------------------------------
//
class CINOSDacChannel : public CINOSProcessImageValue
{
    //--- user interface ---------------------------------------------------
 
    // public member functions
    public :
        ICACHE virtual void Set(real64 arValue) override;
            //; set channel to arValue
        ICACHE virtual real64 Get() override;
            //; get value of channel
        ICACHE real64 GetValue();
            //; return actual channel value (mV, °C, ...) [real32]
        ICACHE real64 GetValue64();
            //; return actual channel value (mV, °C, ...) [real32]
        real32 GetRawValue(uint32 auStage=0);
            //; return raw value before hook number 'auStage'
        #if defined(INOS_PROCESSIMAGE_OVERWRITE)
        ICACHE void SetValue(real64 arValue, bool abOverwrite = false);
            //; set channel to afValue
            //; (abOverwrite=true -> value always set, abOverwrite=false -> value
            //; set if channel is NOT in overwrite mode)
        ICACHE void SetValueChecked(real64 arValue, bool abOverwrite = false);
            //; set channel to afValue, limiting it to the allowed range
            //; (abOverwrite=true -> value always set, abOverwrite=false -> value
            //; set if channel is NOT in overwrite mode)
        ICACHE void SetValue64(real64 arValue, bool abOverwrite = false);
            //; set channel to afValue
            //; (abOverwrite=true -> value always set, abOverwrite=false -> value
            //; set if channel is NOT in overwrite mode)
        #else
        ICACHE void SetValue(real64 arValue);
            //; set channel to afValue
        ICACHE void SetValueChecked(real64 arValue);
            //; set channel to afValue, limiting it to the allowed range
        ICACHE void SetValue64(real64 arValue);
            //; set channel to afValue
        #endif
        void SetRange(uint8 auRange);
            //; set channel range
        uint8 GetRange();
            //; get channel range
 
        real64 GetMinValue();
            //; get minimum allowed value
        real64 GetMaxValue();
            //; get maximum allowed value
        void SetMinValue(real64 arMinimum);
            //; set minimum allowed value
        void SetMaxValue(real64 arMaximum);
            //; set maximum allowed value
 
    //--- internals --------------------------------------------------------
 
    // constructor / destructor
    public:
        CINOSDacChannel (const char* apName, uint16 auNumber,   char* apUnit="mV",
            uint16 auCharacteristics=defCharShowFix + SHOW_DIGIT(3),
            real64 arLower=REAL64(-10500.0),
            real64 arUpper=REAL64(+10500.0),
            uint16 auType=defType_real32, uint16 auArrayLength=1,
            const char* apComboListData=0   // "key0;text0;key1;text1;...": if given
                // (together with auType==defType_uint32), the channel is
                // registered as an enum combo (see CreateINCOEnumCombo())
                // instead of a plain number
            );
        void SetupChannel (uint16 auNumber, char* apUnit, uint16 auCharacteristics,
            real64 arLower, real64 arUpper, uint16 auType, uint16 auArrayLength,
            const char* apComboListData=0 );
        void ConvertToReal (uint16 auNumber, char* apUnit, uint16 auCharacteristics,
            real64 arLower, real64 arUpper, uint16 auType, uint16 auArrayLength );
 
    // protected members
    protected:
        real64 m_rMinValue;
        real64 m_rMaxValue;
};
 
//
//------------------------------------------------------------------------------
// class CINCOProcessImageDac
//------------------------------------------------------------------------------
 
class CINCOProcessImageDac : public CINCOreal32
{
    // constructor
    public:
        CINCOProcessImageDac(const char* apName, uint16 auNumber, real32 arLower, 
            real32 arUpper, char* apUnit, uint16 auCharacteristics);
 
    // public member functions
    public:
        virtual long Get(void* aDest, long& maxLength, long aIndex=0, long aOffset=0) override;
        virtual long Put(void* aSource, long aIndex=0, long aOffset=0) override;
        virtual long GetProperty(void* aDest, char* aName, long aIndex=0,
            long aOffset=0, long* apMaxLength=0, CINCOObject* apParent=0) override;
 
        virtual long GetType() override;
 
        virtual uint64 GetCharacteristics() override;
 
    // protected members
    protected :
        uint16 m_uNumber;
            // channel number
            
    // allow dynamic object handling (new/delete)
    DECLARE_DYNAMIC(CINCOProcessImageDac);
};
 
//------------------------------------------------------------------------------
// class CINCOProcessImageDac_int32
//------------------------------------------------------------------------------
 
class CINCOProcessImageDac_int32 : public CINCOint32
{
    // constructor
    public:
        CINCOProcessImageDac_int32(const char* apName, uint16 auNumber, int32 aiLower, 
            int32 aiUpper, char* apUnit, uint16 auCharacteristics);
 
    // public member functions
    public:
        virtual long Get(void* aDest, long& maxLength, long aIndex=0, long aOffset=0) override;
        virtual long Put(void* aSource, long aIndex=0, long aOffset=0) override;
 
    // protected members
    protected :
        uint16 m_uNumber;
            // channel number
            
    // allow dynamic object handling (new/delete)
    DECLARE_DYNAMIC(CINCOProcessImageDac_int32);
};
 
//------------------------------------------------------------------------------
// class CINCOProcessImageDac_uint32
//------------------------------------------------------------------------------
 
class CINCOProcessImageDac_uint32 : public CINCOuint32
{
    // constructor
    public:
        CINCOProcessImageDac_uint32(const char* apName, uint16 auNumber, uint32 auLower, 
            uint32 auUpper, char* apUnit, uint16 auCharacteristics);
 
    // public member functions
    public:
        virtual long Get(void* aDest, long& maxLength, long aIndex=0, long aOffset=0) override;
        virtual long Put(void* aSource, long aIndex=0, long aOffset=0) override;
 
    // protected members
    protected :
        uint16 m_uNumber;
            // channel number
            
    // allow dynamic object handling (new/delete)
    DECLARE_DYNAMIC(CINCOProcessImageDac_uint32);
};
 
//------------------------------------------------------------------------------
// class CINCOProcessImageDac_combo
//------------------------------------------------------------------------------
//
// Same as CINCOProcessImageDac_uint32, but displays/edits the raw channel
// value as an enum combo (see CreateINCOEnumCombo()) instead of a plain
// number - e.g. for an IODD SimpleDatatype with SingleValue enumerations,
// where each raw value (0, 1, 2, ...) has a corresponding text.
 
class CINCOProcessImageDac_combo : public CINCOuint32combo
{
    // constructor
    public:
        CINCOProcessImageDac_combo(const char* apName, uint16 auNumber,
            const char* apComboListData, uint32 auLower, uint32 auUpper, char* apUnit,
            uint16 auCharacteristics);
 
    // public member functions
    public:
        virtual long Get(void* aDest, long& maxLength, long aIndex=0, long aOffset=0) override;
        virtual long Put(void* aSource, long aIndex=0, long aOffset=0) override;
 
    // protected members
    protected :
        uint16 m_uNumber;
            // channel number
 
    // allow dynamic object handling (new/delete)
    DECLARE_DYNAMIC(CINCOProcessImageDac_combo);
};
 
//------------------------------------------------------------------------------
// class CINCOProcessImageDac_real64
//------------------------------------------------------------------------------
 
class CINCOProcessImageDac_real64 : public CINCOreal64
{
    // constructor
    public:
        CINCOProcessImageDac_real64(const char* apName, uint16 auNumber, real64 arLower, 
            real64 arUpper, char* apUnit, uint16 auCharacteristics);
 
    // public member functions
    public:
        // item address = (long) pData + aIndex*sizeof(item) + aOffset
        virtual long Put(void* aSource, long aIndex=0, long aOffset=0) override;
 
    // protected members
    protected :
        uint16 m_uNumber;
            // channel number
            
    // allow dynamic object handling (new/delete)
    DECLARE_DYNAMIC(CINCOProcessImageDac_real64);
};
 
//------------------------------------------------------------------------------
// end of file
//------------------------------------------------------------------------------
 
#endif  // INC_CINOSDACCHANNEL_H