SMC_GSentenceQueue.GetSentenceFromStart (METH) ¶ METHOD GetSentenceFromStart : POINTER TO SMC_GSentence Returns a pointer to the n-th sentence, or 0 if the queue has less than n+1 elements. The pointer is valid until the next call to RemoveFirst. Only to be called safely from the reading thread, or when it is made sure that no elements are removed concurrently. InOut: Scope Name Type Input n UDINT Return GetSentenceFromStart POINTER TO SMC_GSentence
SMC_GSentenceQueue.GetSentenceIterator (METH) ¶ METHOD GetSentenceIterator : BOOL Initializes a sentence iterator for the entire queue. Attention: the iterator is only valid until a sentence is removed from the queue. InOut: Scope Name Type Comment Return GetSentenceIterator BOOL Inout iterator SMC_GSentence_Iterator Out: the iterator
SMC_GSentenceQueue.Init (METH) ¶ METHOD Init : BOOL Initializes the queue with default buffer sizes (sentence capacity = 1). InOut: Scope Name Type Comment Inout Const prgName STRING(255) The name of the program or subprogram. This is usually the full path of the CNC file. E.g. for the file with full path ‘/some/dir/name.cnc’. Return Init BOOL
SMC_GSentenceQueue.InitP (METH) ¶ METHOD InitP : BOOL Initializes the queue with user-defined buffers. See also method SMC_GSentenceQueue.SetPointers . InOut: Scope Name Type Comment Inout Const prgName STRING(255) The name of the program or subprogram. This is usually the full path of the CNC file. E.g. for the file with full path ‘/some/dir/name.cnc’. Input pBufSentences POINTER TO SMC_GSentence Pointer to the sentence buffer nSizeBufSentences UDINT Size of the sentence buffer in bytes. Must hold at least 2 sentences. pBufGWords POINTER TO SMC_GWord Pointer to the gword buffer nSizeBufGWords UDINT Size of the G-Word buffer in bytes. Must hold at least 64 gwords. pBufGExpTokens POINTER TO SMC_GExpression_Token Pointer to the expression token buffer nSizeBufGExpTokens UDINT Size of the expression token buffer in bytes. Must hold at least 128 expressions. pBufAddData POINTER TO BYTE Pointer to the additional data buffer nSizeBufAddData UDINT Size of the additional data buffer in bytes. Must hold at least 256 bytes. Return InitP BOOL
SMC_GSentenceQueue.ResetJumpTarget (METH) ¶ METHOD ResetJumpTarget
SMC_GSentenceQueue.SentenceCapacity (METH) ¶ METHOD SentenceCapacity : UDINT The maximum number of sentences that can be stored in the queue InOut: Scope Name Type Return SentenceCapacity UDINT
SMC_GSentenceQueue.SentenceQueueFull (METH) ¶ METHOD SentenceQueueFull : BOOL Returns whether the sentence queue is full. InOut: Scope Name Type Return SentenceQueueFull BOOL
SMC_GSentenceQueue.SentenceSpaceLeft (METH) ¶ METHOD SentenceSpaceLeft : UDINT Returns how many elements may be appended to the queue. InOut: Scope Name Type Return SentenceSpaceLeft UDINT
SMC_GSentenceQueue.SetEndOfData (METH) ¶ METHOD PUBLIC SetEndOfData Marks the end of data flag of the queue.
SMC_GSentenceQueue.SetPointers (METH) ¶ METHOD SetPointers : BOOL If user defined buffers are used (see SMC_GSentenceQueue.InitP ), the pointers should be refreshed each cycle (for online change). InOut: Scope Name Type Comment Return SetPointers BOOL Input pBufSentences POINTER TO SMC_GSentence Pointer to the sentence buffer pBufGWords POINTER TO SMC_GWord Size of the sentence buffer in bytes. Must hold at least 2 sentences. pBufGExpTokens POINTER TO SMC_GExpression_Token Pointer to the expression token buffer pBufAddData POINTER TO BYTE Pointer to the additional data buffer