cinosprocessimagevalue.h

Go to the documentation of this file.

//******************************************************************************
//******************************************************************************
 
#ifndef INC_CINOSPROCESSIMAGEVALUE_H
#define INC_CINOSPROCESSIMAGEVALUE_H
 
//------------------------------------------------------------------------------
// defines
//------------------------------------------------------------------------------
//
//
//------------------------------------------------------------------------------
// includes
//------------------------------------------------------------------------------
//
// system
//
// C++
//
// project
//
//------------------------------------------------------------------------------
// class definition
//------------------------------------------------------------------------------
//
class CINOSProcessImageValue : public CINOSProcessImageChannel
{
    //--- user interface ---------------------------------------------------
 
    // public member functions
    public :
        virtual uint16 GetCycleNumber() override;
            //; 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) override;
            //; 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() override;
            //; 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) override;
            //; 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 uint8 GetBusId() override;
            //; return bus id the channel belongs to (needed to be
            //; able to register bus hook)
        virtual CINOSBusJob* GetBusJob() override;
            //; return pointer to the according bus job (or 0 if not available)
        virtual void GetUnit(char* apUnit, uint32 auSize);
            //; get channel unit
        virtual uint32  GetCharacteristics();
            //; get inco characteristics
        virtual real64  GetMinimum();
            //; get inco minimum
        virtual real64  GetMaximum();
            //; get inco maximum
        template<class T> T GetValueEx(uint32 auIndex = 0)
            //; return value in the requested form (calling this method is only
            //; useful if the caller exactly knows about the type of the channel)
            { return *((T*)m_pValue+auIndex); };
        template<class T> void SetValueEx(T aValue, uint32 auIndex = 0)
            //; return value in the requested form (calling this method is only
            //; useful if the caller exactly knows about the type of the channel)
            { *((T*)m_pValue+auIndex) = aValue; };
        
    //--- internals --------------------------------------------------------
 
    // constructor / destructor
    public :
        CINOSProcessImageValue (const char* apName, uint32 auNumber, uint8 auParent,
            uint16 auArrayLength);
            //; object constructor
 
    // protected members
    protected :
        void* m_pValue;     
};
 
//
//------------------------------------------------------------------------------
// global variables
//------------------------------------------------------------------------------
//
//
//------------------------------------------------------------------------------
// end of file
//------------------------------------------------------------------------------
 
#endif  // INC_CINOSPROCESSIMAGEVALUE_H