INOS
Public Member Functions | Protected Attributes | Friends | List of all members
CINOSProcessImageChannel Class Referenceabstract
Inheritance diagram for CINOSProcessImageChannel:
Inheritance graph
[legend]

Public Member Functions

const char * GetName ()
 
void Rename (const char *apName)
 
uint16 GetNumber ()
 
CINOSProcessImage * GetParent ()
 
virtual ICACHE void Set (real64 arValue)
 
virtual ICACHE void SetControl (real64 arValue)
 
virtual ICACHE real64 Get ()
 
virtual void SetEnabled (bool abValue)
 
virtual bool GetEnabled ()
 
virtual void SetSimulated (bool abValue)
 
virtual bool GetSimulated ()
 
virtual void SetConfig (uint32 auConfig, uint32 auMask, uint32 auOffset=0)
 
virtual uint32 GetConfig (uint32 auOffset=0)
 
virtual void * GetConfigAdr (uint32 auOffset=0)
 
uintid RegisterHook (tpHook apHook, intid aiId, char *apUnit=0, uint32 auCharacteristics=0xffff, real32 arLower=real32(1.2345), real32 arUpper=real32(1.2345), tpHook apInvHook=NULL)
 register channel hook
 
uintid RegisterLastHook (tpHook apHook, intid aiId)
 
void UnRegisterHook (uintid auHookId)
 Unregister channel hook.
 
SINOSProcessImageChannelHook * GetFirstHookDescriptor ()
 Get first hook descriptor.
 
SINOSProcessImageChannelHook * GetLastHookDescriptor ()
 Get last hook descriptor.
 
bool IsHooked ()
 Check if this channel has a hook or not.
 
virtual void RegisterBusHook (uintid &auHookId, void *apHandler, void *apObject=0, int32 aiOrder=DF_INOS_BUS_HOOK_ORDER_DEFAULT)
 Register hook and return hook id. The registered function will be called in the context of the corresponding fieldbus task.
 
virtual void UnRegisterBusHook (uintid auHookId)
 unregister a previously registered bus hook
 
virtual uint32 GetCycleTimeNs ()
 
virtual uint16 GetCycleNumber ()
 
virtual void SetCycleNumber (uint16 auCycleNumber, uint8 auBusId=CINOSBus::GetFirstBus() ->GetId(), CINOSBusJob *apBusJob=0)
 
virtual uint16 GetCycleId ()=0
 
virtual void SetCycleId (uint16 auCycleId, uint8 auBusId, CINOSBusPortHandler *apBusPortHandler)
 
virtual void UpdateCycleId (uint16 auCycleId)
 
virtual uint8 GetBusId ()=0
 
virtual CINOSBusJob * GetBusJob ()
 
virtual CINOSBusPortHandler * GetBusPortHandler ()
 
virtual uint32 GetOversampling ()
 
virtual uint32 GetArrayLength ()
 
virtual bool IsRaw32 ()
 
virtual bool IsRaw ()
 
virtual void IwasMoved (uint32 auToNumber)
 
virtual void SetDescription (const char *apDescription)
 
 CINOSProcessImageChannel (const char *apName, uint16 auNumber, uint8 auParent)
 
CINCOObject * GetRegister ()
 
int operator< (const CINOSProcessImageChannel &aChannel) const
 
int operator== (const CINOSProcessImageChannel &aChannel) const
 
int operator< (const char *apName) const
 
int operator== (const char *apName) const
 

Protected Attributes

const char * m_pName
 
const char * m_pIncoName
 
uint16 m_uNumber
 
uint16 m_uParent
 
CINCOObject * m_pRegister
 
SINOSProcessImageChannelHook * m_pFirstHook
 

Friends

class CINOSProcessImage
 
class CINOSAdcChannels
 
class CINOSDacChannels
 
class CINOSPosChannels
 
class CINOSBusPortHandlerAdc
 
class CINOSBusPortHandlerDac
 

Constructor & Destructor Documentation

◆ CINOSProcessImageChannel()

CINOSProcessImageChannel::CINOSProcessImageChannel ( const char *  apName,
uint16  auNumber,
uint8  auParent 
)
Parameters
apNameIf the poitner is "on the stack" of the current task, the CTOR creates a deep copy of it. Otherwise, this CTOR takes ownership of it (i.e. if the name has been allocated on the heap, the caller mustn't delete it).

Member Function Documentation

◆ IsHooked()

bool CINOSProcessImageChannel::IsHooked ( )
inline

Check if this channel has a hook or not.

Returns
True if at least one hook is defined.

◆ RegisterBusHook()

virtual void CINOSProcessImageChannel::RegisterBusHook ( uintid &  auHookId,
void *  apHandler,
void *  apObject = 0,
int32  aiOrder = DF_INOS_BUS_HOOK_ORDER_DEFAULT 
)
virtual

Register hook and return hook id. The registered function will be called in the context of the corresponding fieldbus task.

Parameters
auHookIdOutput parameter set to the unique 'hook id', used to disable, enable and unregister this hook. This value will be non-zero on success.
apHandlerPointer to function to be called
apObjectPointer to object instance if apHandler is a class method
aiOrderRequested order, see DF_INOS_BUS_HOOK_ORDER_DEFAULT

◆ RegisterLastHook()

uintid CINOSProcessImageChannel::RegisterLastHook ( tpHook  apHook,
intid  aiId 
)

register last channel hook (the system guarantees, that this hook is always the last in the chain)

The documentation for this class was generated from the following file: