DigitalSpaces::DIStringPairList Struct Reference
[Lists]

#include <ContainerInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.

Inherited by DigitalSpaces::DIStringPairListImpl.

---

Detailed Description

A collection of string pairs that can be iterated through.

The implementation needs to keep an internal state, of which of its entries is "current".

Public Member Functions
void	Restart ()
	Resets "current" to the first item.
const char *	GetCurrentLeft ()
	Gets the left half of the "current" entry.
const char *	GetCurrentRight ()
	Gets the right half of the "current" entry.
bool	Advance ()
	Advances "current".
bool	AtEnd ()
	Check if "current" is past the end of the list.
unsigned int	Size ()
	Returns the length of the list.
bool	Empty ()
	Check if the list is empty.
void	PushBack (const char *left, const char *right)
	Appends a pair of strings to the list.
void	Clear ()
	Removes all items from the list.

---

Member Function Documentation

void DigitalSpaces::DIStringPairList::Restart

(

)

Resets "current" to the first item.

Reimplemented in DigitalSpaces::DIStringPairListImpl.

const char* DigitalSpaces::DIStringPairList::GetCurrentLeft

(

)

Gets the left half of the "current" entry.

Reimplemented in DigitalSpaces::DIStringPairListImpl.

const char* DigitalSpaces::DIStringPairList::GetCurrentRight

(

)

Gets the right half of the "current" entry.

Reimplemented in DigitalSpaces::DIStringPairListImpl.

bool DigitalSpaces::DIStringPairList::Advance

(

)

Advances "current".

Returns:

False if at the end of the list. In this case, the result from GetCurrent is undefined.

Reimplemented in DigitalSpaces::DIStringPairListImpl.

bool DigitalSpaces::DIStringPairList::AtEnd

(

)

Check if "current" is past the end of the list.

This will be the same as checking if Advance has returned false. If true, GetCurrent returns undefined answers.

Returns:

True if at the end of the list, false if not.

Reimplemented in DigitalSpaces::DIStringPairListImpl.

unsigned int DigitalSpaces::DIStringPairList::Size

(

)

Returns the length of the list.

Reimplemented in DigitalSpaces::DIStringPairListImpl.

bool DigitalSpaces::DIStringPairList::Empty

(

)

Check if the list is empty.

Depending on the implementation, this may be faster then calling Size and comparing to zero, particularly in cases where the list is not empty.

Reimplemented in DigitalSpaces::DIStringPairListImpl.

void DigitalSpaces::DIStringPairList::PushBack	(	const char *	left,
		const char *	right
	)

Appends a pair of strings to the list.

Reimplemented in DigitalSpaces::DIStringPairListImpl.

void DigitalSpaces::DIStringPairList::Clear

(

)

Removes all items from the list.

Reimplemented in DigitalSpaces::DIStringPairListImpl.

---

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

• CoreInterfaces/ContainerInterfaces.h