cinosbit.h

Go to the documentation of this file.

//******************************************************************************
//******************************************************************************
 
#ifndef INC_CINOSBIT_H
#define INC_CINOSBIT_H
 
//
//------------------------------------------------------------------------------
// defines
//------------------------------------------------------------------------------
//
//
//------------------------------------------------------------------------------
// includes
//------------------------------------------------------------------------------
//
// system
//
// C++
//
// project
#include <cinosprocessimagechannel.h>
//
//------------------------------------------------------------------------------
// class definition
//------------------------------------------------------------------------------
//
class CINOSBit : public CINOSProcessImageChannel
{
    //--- user interface ---------------------------------------------------
 
    // public member functions
    public :
        ICACHE virtual void Set(real64 arValue) override;
            //; set channel to arValue
        ICACHE virtual void SetControl(real64 arValue) override;
            //; set channel to arValue
        ICACHE virtual real64 Get() override;
            //; get value of channel
        #if defined(INOS_PROCESSIMAGE_OVERWRITE)
        bool Set(bool abOverwrite = false);
            //; set bit and return the value before ('Test and Set')
            //; (abOverwrite=true -> bit always set, abOverwrite=false -> bit set
            //; if channel is NOT in overwrite mode)
        bool Clear(bool abOverwrite = false);
            //; clear bit and return the value before
            //; (abOverwrite=true -> bit always cleared, abOverwrite=false ->
            //; bit cleared if channel is NOT in overwrite mode)
        #else
        bool Set();
            //; set bit and return the value before ('Test and Set')
        bool Clear();
            //; clear bit and return the value before
        #endif
        bool SetEx(uint16 auIndex);
            //; set array based bit and return value before (no fancy things like
            //; overwrite, sync objects, ... available)
        bool SetLatched();
            //; set latched bit and return the value before ('Test and Set')
        bool ClearEx(uint16 auIndex);
            //; clear array based bit and return value before (no fancy things like
            //; overwrite, sync objects, ... available)
        bool ClearLatched();
            //; clear latched bit and return the value before ('Test and Set')
        bool Test();
            //; test bit
        bool TestEx(uint16 auIndex);
            //; test array based bit
        bool TestLatched();
            //; test latched bit
        uint32 WaitForSet(uint32 aTimeout=INOS_WAIT_FOREVER);
            //; wait max. aTimeout usec for bit set
            //; return value == 0 -> timeout, != 0 -> time waited for bit (in usec)
        uint32 WaitForCleared(uint32 aTimeout=INOS_WAIT_FOREVER);
            //; wait max. aTimeout usec for bit cleared
            //; return value == 0 -> timeout, != 0 -> time waited for bit (in usec)
        void SetFilter(uint16 auFilter);
            //; set filter value (ticks) -> only valid for digital inputs
        uint16 GetFilter()
            //; get filter value -> only valid for digital inputs
            { return dat.inp.m_uFilter;};
        void SetInverted(bool abInverted);
            //; set filter value (ticks) -> only valid for digital inputs
        bool GetInverted();
            //; get filter value -> only valid for digital inputs
        virtual uint8 GetBusId() override;
            //; return bus id the channel belongs to
        void ConvertToReal(uint16 auNewNumber);
            // convert bit from simulated to real
        virtual CINOSBusPortHandler* GetBusPortHandler() override;
            //; return pointer to the according bus port (or 0 if not available)
        virtual void IwasMoved(uint32 auToNumber) override;
            //; called whenever a channel was moved to a new number
        virtual uint32 GetArrayLength() override;
            //; get channel array length
        virtual uint16 GetCycleId() override;
            //; return bus cycle id the channel is updated (needed to be
            //; able to register bus hook in the correct cycle/core)
 
    //--- internals --------------------------------------------------------
 
    friend class CINOSBits;
    friend class CINOSBitSetEvent;
    friend class CINOSBitClearedEvent;
    friend class CINOSOutPwm;
    
    // constructor / destructor
    public:
        CINOSBit (const char* apName, uint16 auNumber, uint8 auParent,
            uint16 auArrayLength=1);
            //; object constructor
 
        virtual void SetBusPortHandler(CINOSBusPortHandler* apBusPortHandler);
            //; set pointer to the according bus port handler
 
    // protected members
    protected:
#ifndef DOXYGEN_USER_BUILD
        #ifndef INOS_NO_BIT_EVENT_SUPPORT
        CINOSEvent* m_pSetEvent;
            //; pointer to set event
        CINOSEvent* m_pClrEvent;
            //; pointer to clear event
        uint8 m_uSetEvents;
            //; set events counter
        uint8 m_uClrEvents;
            //; clear events counter
        #endif
        CINOSBusPortHandler* m_pBusPortHandler;
            //; pointer to bus port handler. May be NULL.
        union {
            struct {
                uint16 m_uFilter;
                    //; filter value (ticks)
                uint16 m_uCount;
                    //; actual filter counter
            } inp;
            struct {
                float m_rValue;
            } out;
        } dat;
#endif      
};
 
//
//------------------------------------------------------------------------------
// class CINCOProcessImageBit
//------------------------------------------------------------------------------
 
class CINCOProcessImageBit : public CINCObit
{
    // constructor
    public:
        CINCOProcessImageBit(
            const char* apName, uint16 auNumber, uint8 auParent
            );
 
    // public member functions
    public:
        virtual long Put(void* aSource, long aIndex=0, long aOffset=0);
        virtual long Get(void* aDest, long& maxLength, long aIndex=0, long aOffset=0);
        virtual long GetProperty(void* aDest, char* aName, long aIndex,
            long aOffset, long* apMaxLength, CINCOObject* apParent);
 
    // protected members
    protected :
        uint8 m_uParent;
            // index of parent image
            
    // allow dynamic object handling (new/delete)
    DECLARE_DYNAMIC(CINCOProcessImageBit);
};
 
 
//
//------------------------------------------------------------------------------
// class CINCOProcessImageBitInverted
//------------------------------------------------------------------------------
 
class CINCOProcessImageBitInverted : public CINCObit
{
    // constructor
    public:
        CINCOProcessImageBitInverted(
            const char* apName, void* apData, uint16 auNumber, uint8 auParent);
 
    // public member functions
    public:
        virtual long Put(void* aSource, long aIndex=0, long aOffset=0);
        virtual long Get(void* aDest, long& maxLength, long aIndex=0, long aOffset=0);
 
    private:
        const uint8 m_uParent;
 
    // allow dynamic object handling (new/delete)
    DECLARE_DYNAMIC(CINCOProcessImageBitInverted);
};
 
//------------------------------------------------------------------------------
// end of file
//------------------------------------------------------------------------------
 
#endif  // INC_CINOSBIT_H