cinosprocessimagechannel.h

Go to the documentation of this file.

//******************************************************************************
//******************************************************************************
 
#ifndef INC_CINOSPROCESSIMAGECHANNEL_H
#define INC_CINOSPROCESSIMAGECHANNEL_H
 
//------------------------------------------------------------------------------
// defines
//------------------------------------------------------------------------------
//
#define DF_INOS_IMAGE_CHN_DEF_CHAR  0xffff      // default characteristics
#define DF_INOS_IMAGE_CHN_DEF_REAL  1.2345      // default real32 number
#define DF_INOS_IMAGE_CHN_DEF_INT   123456789   // default int32 number
//
//------------------------------------------------------------------------------
// includes
//------------------------------------------------------------------------------
//
// system
#include <inos.h>
#include <cinosbus.h>
//
// C++
//
// project
//
//
//------------------------------------------------------------------------------
// forward declarations
//------------------------------------------------------------------------------
class CINOSProcessImage;
class CINOSBusPortHandler;
class CINOSBusJob;
//
//------------------------------------------------------------------------------
// type definition
//------------------------------------------------------------------------------
//
typedef float (*tpHook)(float, intid);
typedef void (*tpConversion)(char*, uint32, intid);
//
//------------------------------------------------------------------------------
// structure definition
//------------------------------------------------------------------------------
//
struct SINOSProcessImageChannelHook {
    SINOSProcessImageChannelHook* m_pNext;
        //; pointer to next hook in chain
    tpHook m_pFunction;
        //; pointer to hook function
    tpHook m_pInvFunction;
        //; pointer to inverse hook function (used to convert value when writing back)
    tpConversion m_pConversion;
        //; pointer to hook function
    intid m_iId;
        //; hook id
    real32 m_rValue;
        //; raw value (before hook)
    char* m_pUnit;
        //; unit of raw value (before hook)
    real32 m_rLower;
        //; lower limit of raw value (before hook)
    real32 m_rUpper;
        //; upper limit of raw value (before hook)
    uint32 m_uCharacteristics;
        //; characteristics of raw value (before hook)
    enum {
        eFlgUnit = 0x00000001,
        eFlgMin = 0x00000002,
        eFlgMax = 0x00000004,
        eFlgChar = 0x00000008,
        eFlgLast = 0x00000010,  // last hook in chain
    };
    uint32 m_uFlags;
        //; flags which properties are hook specific
 
    // allow dynamic object handling (new/delete)
    DECLARE_DYNAMIC(SINOSProcessImageChannelHook);
};
 
//------------------------------------------------------------------------------
// class definition
//------------------------------------------------------------------------------
//
class CINOSProcessImageChannel
{
    //--- user interface ---------------------------------------------------
 
    // public member functions
    public :                          
        const char* GetName();
            //; return name of channel
        void Rename(const char* apName);
            //; renames this channel and updates the INCO registration
        uint16 GetNumber();
            //; return number of channel
        CINOSProcessImage* GetParent();
            //; get pointer to according process image
 
        ICACHE virtual void Set(real64 arValue)
            { };
        ICACHE virtual void SetControl(real64 arValue)
            { Set(arValue); };
            //; set channel to arValue
        ICACHE virtual real64 Get()
            { return REAL64(0.0);};
            //; get value of channel
 
        #if defined(INOS_PROCESSIMAGE_OVERWRITE)
        virtual void SetOverwrite(bool abValue);
            //; change the channel from real to overwrite mode if abValue = true
            //; or vice versa
        virtual bool GetOverwrite();
            //; get actual overwrite mode of channel
        #endif
 
        virtual void SetEnabled(bool abValue);
            //; enable channel if abValue = true or vice versa
        virtual bool GetEnabled();
            //; return true if channel is enabled
 
        virtual void SetSimulated(bool abValue);
            //; set simulation state
        virtual bool GetSimulated();
            //; get simulation state
 
        virtual void SetConfig(uint32 auConfig, uint32 auMask, uint32 auOffset=0);
            //; set config to auConfig (only bits set in auMask are affected)
        virtual uint32 GetConfig(uint32 auOffset=0);
            //; get config
        virtual void* GetConfigAdr(uint32 auOffset=0);
            //; get address of config
        
        uintid RegisterHook(tpHook apHook, intid aiId, char* apUnit=0,
            uint32 auCharacteristics=DF_INOS_IMAGE_CHN_DEF_CHAR,
            real32 arLower=real32(DF_INOS_IMAGE_CHN_DEF_REAL),
            real32 arUpper=real32(DF_INOS_IMAGE_CHN_DEF_REAL),
            tpHook apInvHook=NULL
            );
        uintid RegisterLastHook(tpHook apHook, intid aiId);
        void UnRegisterHook(uintid auHookId);
        SINOSProcessImageChannelHook* GetFirstHookDescriptor() {
            return m_pFirstHook;
        }
        SINOSProcessImageChannelHook* GetLastHookDescriptor();
 
        bool IsHooked() {
            return m_pFirstHook!=NULL;
        }
 
        virtual void RegisterBusHook(uintid& auHookId, void* apHandler, void* apObject = 0,
            int32 aiOrder = DF_INOS_BUS_HOOK_ORDER_DEFAULT);
        virtual void UnRegisterBusHook(uintid auHookId);
 
        virtual uint32 GetCycleTimeNs();
            //; return channel cycletime [ns]
        virtual uint16 GetCycleNumber()
            { return 0;};
            //; return bus subcycle number the channel is updated (needed to be
            //; able to register bus hook in the correct subcycle)
        virtual void SetCycleNumber(uint16 auCycleNumber, uint8 auBusId = CINOSBus::GetFirstBus()->GetId(),
            CINOSBusJob* apBusJob = 0){};
            //; set bus id and subcycle number the channel is updated (the field bus 
            //; driver has to set this number to inform all others who are 
            //; interested in)
        virtual uint16 GetCycleId() = 0;
            //; return bus cycle id the channel is updated (needed to be
            //; able to register bus hook in the correct cycle/core)
        virtual void SetCycleId(uint16 auCycleId, uint8 auBusId, CINOSBusPortHandler* apBusPortHandler){};
            //; set bus id and subcycle number the channel is updated (the field bus 
            //; driver has to set this number to inform all others who are 
            //; interested in)
        virtual void UpdateCycleId(uint16 auCycleId);
            //; update cycle id the channel is updated (this method is usually called
            //; from axis controllers to inform about downsampled controlling and possible
            //; other cores)
        virtual uint8 GetBusId() = 0;
            //; return bus id the channel belongs to (needed to be
            //; able to register bus hook)
        virtual CINOSBusJob* GetBusJob()
            { return 0;};
            //; return pointer to the according bus job (or 0 if not available)
        virtual CINOSBusPortHandler* GetBusPortHandler();
            //; return pointer to the according bus port (or 0 if not available)
        virtual uint32 GetOversampling();
            //; get channel oversampling (returns 0 if no oversampling)
        virtual uint32 GetArrayLength();
            //; get channel array length
        virtual bool IsRaw32();
            //; return true if value is a 'raw32' or 'raw32 inv ovr' value
        virtual bool IsRaw();
            //; return true if value is a 'raw' value
 
        #ifdef INOS_USE_CUSTOMER_IMAGE_DATA
        void* GetCustomerSpecificData() const;
            //; \return The pinter to the customer specific data (or NULL if
            //;  no such data are set).
        void SetCustomerSpecificData(void* apData);
            //; Sets apData to be the "customer specific data" of this 
            //; image channel. The function doesn't care about any 
            //; previously set customer specific data: The caller is 100% 
            //; responsible for freeing amy resource related to these data! 
            //; This class will never access the data in any way apart from
            //; initialization to NULL during object contstruction!
        #endif
 
        virtual void IwasMoved(uint32 auToNumber){};
            //; called whenever a channel was moved to a new number
        virtual void SetDescription(const char* apDescription);
            //; set channel description
 
    //--- internals --------------------------------------------------------
 
    friend class CINOSProcessImage;
    friend class CINOSAdcChannels;
    friend class CINOSDacChannels;
    friend class CINOSPosChannels;
    friend class CINOSBusPortHandlerAdc;
    friend class CINOSBusPortHandlerDac;
    
    // constructor / destructor
    public:
        CINOSProcessImageChannel (const char* apName, uint16 auNumber, uint8 auParent);
            //; object constructor
        virtual ~CINOSProcessImageChannel();
 
    // protected members
    protected:
        const char* m_pName;
            //; channel name
        const char* m_pIncoName;
            //; channel name in inco tree (e.g. if m_pName = "Z.InitMot" then
            //; m_pIncoName = "InitMot")
        uint16 m_uNumber;
            //; channel number
        uint16 m_uParent;
            //; index of parent process image
        CINCOObject* m_pRegister;
            //; inco registration of channel
        SINOSProcessImageChannelHook* m_pFirstHook;
            //; pointer to first hook in chain
        #ifdef INOS_USE_CUSTOMER_IMAGE_DATA
            //; from time to time, a customers may need to attach customer 
            //; specific data to a certain process channel (such as a Bit, DAC,
            //; ADC, etc.). One possiblity to add such data is to subclass e.g. 
            //; CINOSBit, and add new dt2 tables in order to create the 
            //; subclasses instances. Another way is to use this member.
        void* m_pCustomerSpecificData;
        #endif
 
    // public member functions but just for internal use
    public:
        CINCOObject* GetRegister();
            //; return pointer to inco registration of this channel
 
    // operators (needed to handle binary tree search)
    public:
        int operator < (const CINOSProcessImageChannel& aChannel) const
            { return (strcmp(m_pName, aChannel.m_pName)<0);}
        int operator == (const CINOSProcessImageChannel& aChannel) const
            { return (strcmp(m_pName, aChannel.m_pName)==0);}
        int operator < (const char* apName) const
            { return (strcmp(m_pName, apName)<0);}
        int operator == (const char* apName) const
            { return (strcmp(m_pName, apName)==0);}
};
 
//
//------------------------------------------------------------------------------
// global variables
//------------------------------------------------------------------------------
//
extern const char PROCESS_IMAGE_CHANNEL_DUMMY_NAME[];
//
//------------------------------------------------------------------------------
// end of file
//------------------------------------------------------------------------------
 
#endif  // INC_CINOSPROCESSIMAGECHANNEL_H