GenericQueue.GetFromStart (METH) ¶ METHOD FINAL GetFromStart : POINTER TO BYTE Returns a pointer to the n-th element, or 0 if the queue has less than n+1 elements. The pointer is valid until the next call to RemoveFirst. task-safety: call from consumer task only InOut: Scope Name Type Input n UDINT Return GetFromStart POINTER TO BYTE
GenericQueue.Init (METH) ¶ METHOD FINAL Init : BOOL Initializes the queue. task-safety: the application has to make sure that no other task - is calling one of the queue’s methods when this method is called - calls one of the queue’s methods during the call of this method InOut: Scope Name Type Comment Input pD POINTER TO BYTE Data array, must be properly aligned for the element to be stored udiElementSize UDINT The element size, may be 1 or an even number >= 2 udiSizeDataBytes UDINT The size of the data array in bytes. Must be at least 2*udiElementSize. Return Init BOOL
GenericQueue.GetIdxFromPtr (METH) ¶ METHOD FINAL GetIdxFromPtr : BOOL Returns the index in the queue, given the pointer to an element. Returns FALSE if the element is not an element in the queue or does not point to an element start. Not task safe! InOut: Scope Name Type Input p POINTER TO BYTE Return GetIdxFromPtr BOOL Output idx UDINT
GenericQueue.IsEmpty (METH) ¶ METHOD FINAL IsEmpty : BOOL Returns whether the queue is currently empty. task-safety: may be called from both tasks InOut: Scope Name Type Return IsEmpty BOOL
GenericQueue.NumElems (METH) ¶ METHOD FINAL NumElems : UDINT Returns the number of elements currently in the queue. task-safety: may be called from both tasks InOut: Scope Name Type Return NumElems UDINT
GenericQueue.RemoveAll (METH) ¶ METHOD FINAL RemoveAll Removes all elements of the queue and resets the end of data flag. Invalidates the pointer returned by a prior call to GetFirst. task-safety: call from consumer task only
GenericQueue.RemoveFirst (METH) ¶ METHOD FINAL RemoveFirst : BOOL Removes the first element of the queue. Invalidates the pointer returned by a prior call to GetFirst. task-safety: call from consumer task only InOut: Scope Name Type Return RemoveFirst BOOL
GenericQueue.RemoveLast (METH) ¶ METHOD FINAL RemoveLast : BOOL Removes the last element of the queue. task-safety: not task-safe InOut: Scope Name Type Return RemoveLast BOOL
GenericQueue.Reset (METH) ¶ METHOD FINAL Reset
GenericQueue.SetEndOfData (METH) ¶ METHOD PUBLIC FINAL SetEndOfData Marks the end of data flag of the queue. task-safety: call from producer task only