Frame Helpers

The following inline functions are provided to assist in moving single data values into and out of a Frame using a Frame Iterator.

static inline void rogue::interfaces::stream::toFrame(rogue::interfaces::stream::FrameIterator &iter, uint32_t size, void *src)

Inline helper function to copy values to a frame iterator.

This helper function copies from the passed data pointer into the Frame at the iterator position. The iterator is incremented by the copy size.

Parameters:

• iter – FrameIterator at position to copy the data to

• size – The number of bytes to copy

• src – Pointer to data source

static inline void rogue::interfaces::stream::fromFrame(rogue::interfaces::stream::FrameIterator &iter, uint32_t size, void *dst)

Inline helper function to copy values from a frame iterator.

This helper function copies data Frame at the iterator location into the passed data pointer. The iterator is updated by byte copy size.

Parameters:

• iter – FrameIterator at position to copy the data from

• size – The number of bytes to copy

• dst – Pointer to data destination

static inline void rogue::interfaces::stream::copyFrame(rogue::interfaces::stream::FrameIterator &srcIter, uint32_t size, rogue::interfaces::stream::FrameIterator &dstIter)

Inline helper function to copy frame data between frames.

This helper function copies data from the source Frame at the iterator location into the dest frame at the iterator location. Both iterators are updated by byte copy size.

Parameters:

• srcIter – FrameIterator at position to copy the data from

• size – The number of bytes to copy

• dstIter – FrameIterator at position to copy the data to