cinosposchannel.h

Go to the documentation of this file.

//******************************************************************************
//******************************************************************************
 
#ifndef INC_CINOSPOSCHANNEL_H
#define INC_CINOSPOSCHANNEL_H
 
//------------------------------------------------------------------------------
// defines
//------------------------------------------------------------------------------
//
//
//------------------------------------------------------------------------------
// includes
//------------------------------------------------------------------------------
//
// system
//
// C++
//
// project
//
//------------------------------------------------------------------------------
// type definition
//------------------------------------------------------------------------------
//
typedef int32 (*tpPosHook)(int32, intid);
//
//------------------------------------------------------------------------------
// class definition
//------------------------------------------------------------------------------
//
class CINOSBusJob;
class CINOSPosChannel : 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 int32 GetPosition();
            //; return actual position
        #if defined(INOS_PROCESSIMAGE_OVERWRITE)
        ICACHE void SetPosition(int32 aiValue, bool abOverwrite = true);
            //; set channel to aiValue
            //; (abOverwrite=true -> value always set, abOverwrite=false -> value
            //; set if channel is NOT in overwrite mode)
        #else
        ICACHE void SetPosition(int32 aiValue);
            //; set channel to aiValue
        #endif
        ICACHE int32 GetPositionDelta();
            //; return delta to last GetPosition or last GetPositionDelta
        ICACHE int32 GetRawOffset();
            //; return raw position offset
        ICACHE void SetRawOffset(int32 aiOffset);
            //; set raw position offset
        ICACHE int32 GetRawPosition(uint32 auStage=0);
            //; return raw position before hook number 'auStage'
        ICACHE real32 GetControl();
            //; get channel control (100% = 28672, -100% = - 28672)
        ICACHE virtual void SetControl(real64 arValue) override;
            //; set channel control to afValue
        ICACHE real32 GetSerror();
            //; get channel S error [inc]
        ICACHE void SetSerror(real32 arValue);
            //; set channel S error to arValue
        ICACHE void SetValue(real32 arValue);
            //; set channel control to arValue * 2.8672 -> takes +-10000.0 mV
        ICACHE bool GetSyncEnable();
            //; return state of 'sync enable' output
        ICACHE void SetSyncEnable(bool abValue);
            //; set 'sync enable' output to abValue
        ICACHE bool GetAxisEnable();
            //; return 'axis enable' output
        ICACHE void SetAxisEnable(bool abValue);
            //; set 'axis enable' output to abValue
        ICACHE bool GetSynced();
            //; return state of 'synced' input
        ICACHE bool GetZeroImpuls();
            //; return state of 'zero impuls' input
        ICACHE bool GetAxisEnabled();
            //; return state of 'axis enabled' input
        ICACHE bool GetInverted();  
            //; return true if the channel-direction is inverted
        ICACHE void SetInverted(bool abValue);
            //; set the channel-direction   
        ICACHE void SetCalibEnabled(bool abValue);  
            //; set channel calibration enabled flag
        ICACHE bool GetCalibEnabled();  
            //; return true if the channel calibration enabled
 
        void RegisterHook(tpPosHook apPosHook, int32 aiId, char* apUnit=0,
            uint32 auCharacteristics=DF_INOS_IMAGE_CHN_DEF_CHAR,
            int32 aiLower=DF_INOS_IMAGE_CHN_DEF_INT,
            int32 aiUpper=DF_INOS_IMAGE_CHN_DEF_INT
            );
            //; register channel hook
 
    //--- internals --------------------------------------------------------
 
    // constructor / destructor
    public:
        //; object constructor
        CINOSPosChannel (const char* apName, uint16 auNumber, uint16 auArrayLength=1);
        void SetupChannel (uint16 auNumber, uint16 auArrayLength );
        void ConvertToReal (uint16 auNumber, uint16 auArrayLength );
    
    // protected members
    protected:
        int32 m_iOldPosition;
            //; last got position (needed for GetPositionDelta)
};
 
//
//------------------------------------------------------------------------------
// global variables
//------------------------------------------------------------------------------
//
//
//------------------------------------------------------------------------------
// end of file
//------------------------------------------------------------------------------
 
#endif  // INC_CINOSPOSCHANNEL_H