LATdataBufferIterator Class Reference

Application class demonstrating the use of the LDF iterators to call application-supplied methods back. More...

#include <LATdataBufferIterator.h>

Collaboration diagram for LATdataBufferIterator:

[legend]List of all members.

Public Member Functions
	LATdataBufferIterator (LATcomponentIterator *, bool swap=!DFC_BIG_ENDIAN)
	LATdataBufferIterator constructor.
	LATdataBufferIterator (LDBI_LATcontributionIterator *, bool swap=!DFC_BIG_ENDIAN)
	LATdataBufferIterator constructor.
	LATdataBufferIterator (LDBI_LATdatagramIterator *, bool swap=!DFC_BIG_ENDIAN)
	LATdataBufferIterator constructor.
int	iterate ()
	Reiterate over a buffer that has already been iterated over by LATdataBufferIterator::iterate(char* buffer, unsigned length).
int	iterate (char *buffer, unsigned length)
	Iterate over a given buffer of specified length. Byteswap by longwords in place according to the constructor swap value.
int	iterate (char *buffer, unsigned length, bool swap)
	Iterate over a given buffer of specified length. Byteswap by longwords in place if requested.

---

Detailed Description

Application class demonstrating the use of the LDF iterators to call application-supplied methods back.

---

Constructor & Destructor Documentation

LATdataBufferIterator::LATdataBufferIterator	(	LATcomponentIterator *	lci,
		bool	swap = !DFC_BIG_ENDIAN
	)			[inline]

LATdataBufferIterator constructor.

LATdataBufferIterator is a convenience class to allow simple invocation of iterators to parse data in supplied string buffers. This class provides applications access only to LATcontributions that are EBFevents, but not to unrecognized LATcontributions. A LATcomponentIterator instance is required to provide the virtual method resolution needed to handle subsystem data. A swapping option is provided to allow byte swapping of the buffer prior to iteratation, if needed.

Parameters:

	lci	- A pointer to a LATcomponentIterator instance
	swap	- Optional parameter indicating whether buffers should be byteswapped prior to being iterated over. The default value is True if the machine this code is running is not big endian and False otherwise.

LATdataBufferIterator::LATdataBufferIterator	(	LDBI_LATcontributionIterator *	lci,
		bool	swap = !DFC_BIG_ENDIAN
	)			[inline]

LATdataBufferIterator constructor.

LATdataBufferIterator is a convenience class to allow simple invocation of iterators to parse data in supplied string buffers. This class provides applications access to LATcontributions, both EBFevents and others. A LDBI_LATcontributionIterator instance is required to provide the virtual method resolution needed to handle subsystem data. A swapping option is provided to allow byte swapping of the buffer prior to iteratation, if needed.

Parameters:

	lci	- A pointer to a LDBI_LATcontributionIterator instance
	swap	- Optional parameter indicating whether buffers should be byteswapped prior to being iterated over. The default value is True if the machine this code is running is not big endian and False otherwise.

LATdataBufferIterator::LATdataBufferIterator	(	LDBI_LATdatagramIterator *	ldi,
		bool	swap = !DFC_BIG_ENDIAN
	)			[inline]

LATdataBufferIterator constructor.

LATdataBufferIterator is a convenience class to allow simple invocation of iterators to parse data in supplied string buffers. This class provides applications access to LATcontributions, both EBFevents and others. A LDBI_LATcontributionIterator instance is required to provide the virtual method resolution needed to handle subsystem data. A swapping option is provided to allow byte swapping of the buffer prior to iteratation, if needed.

Parameters:

	ldi	- A pointer to a LATdatagramIterator instance
	swap	- Optional parameter indicating whether buffers should be byteswapped prior to being iterated over. The default value is True if the machine this code is running is not big endian and False otherwise.

---

Member Function Documentation

int LATdataBufferIterator::iterate	(	char *	buffer,
		unsigned	length,
		bool	swap
	)			[inline]

Iterate over a given buffer of specified length. Byteswap by longwords in place if requested.

This method iterates over the datagrams in a string buffer of specified length, after possibly bytswapping the buffer by longwords in place first. Use this method to override the constructor swap argument. This allows iterating over the same buffer multiple times without swapping it each time.

Parameters:

	buffer	A string buffer containing LATdatagrams
	length	The length of the supplied string buffer
	swap	Forces the supplied buffer to be byteswapped in place, or not

Returns:

The result from iterating over the datagrams in the buffer

int LATdataBufferIterator::iterate	(	char *	buffer,
		unsigned	length
	)			[inline]

Iterate over a given buffer of specified length. Byteswap by longwords in place according to the constructor swap value.

This method iterates over the datagrams in a string buffer of specified length, after possibly bytswapping the buffer by longwords in place first.

Parameters:

	buffer	A string buffer containing LATdatagrams
	length	The length of the supplied string buffer

Returns:

The result from iterating over the datagrams in the buffer

int LATdataBufferIterator::iterate

(

)

[inline]

Reiterate over a buffer that has already been iterated over by LATdataBufferIterator::iterate(char* buffer, unsigned length).

Returns:

The result from iterating over the datagrams in the buffer

---

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

• LATdataBufferIterator.h

---