AMPS.Client.BookmarkRingBuffer.Entry Class Reference

Represents a single entry in an array of bookmarks More...

Public Member Functions
	Entry ()
	Initializes a new instance of the Entry class. More...
Entry	setBookmark (Field f)
	Sets the bookmark for the entry. More...
BookmarkField	getBookmark ()
	Gets the bookmark field of the entry. More...
Entry	setIndex (long index)
	Sets the index of the Entry in the Entry array. More...
long	getIndex ()
	Gets the index of the Entry in the Entry array. More...
bool	isActive ()
	Gets the active value of the Entry. More...
Entry	setActive (bool active)
	Sets the activity status for the entry. More...
override string	ToString ()
	Converts the Entry to a string. Returns a string representation of the entry. More...

Detailed Description

Represents a single entry in an array of bookmarks

Constructor & Destructor Documentation

Entry()

AMPS.Client.BookmarkRingBuffer.Entry.Entry ( )

inline

Initializes a new instance of the Entry class.

Member Function Documentation

getBookmark()

BookmarkField AMPS.Client.BookmarkRingBuffer.Entry.getBookmark ( )

inline

Gets the bookmark field of the entry.

Returns

The bookmark field of the Entry.

getIndex()

long AMPS.Client.BookmarkRingBuffer.Entry.getIndex ( )

inline

Gets the index of the Entry in the Entry array.

Returns

The index of the Entry.

isActive()

bool AMPS.Client.BookmarkRingBuffer.Entry.isActive ( )

inline

Gets the active value of the Entry.

Returns

The active value of the Entry, True if the entry is active, false otherwise.

setActive()

Entry AMPS.Client.BookmarkRingBuffer.Entry.setActive ( bool  active )

inline

Sets the activity status for the entry.

Parameters

active

The new value of active.

Returns

The current entry for method chaining.

setBookmark()

Entry AMPS.Client.BookmarkRingBuffer.Entry.setBookmark ( Field  f )

inline

Sets the bookmark for the entry.

Parameters

f	The field to set as the bookmark.

Returns

This instance (i.e., the current entry).

setIndex()

Entry AMPS.Client.BookmarkRingBuffer.Entry.setIndex ( long  index )

inline

Sets the index of the Entry in the Entry array.

Parameters

index

The index to be set.

Returns

The current entry.

ToString()

override string AMPS.Client.BookmarkRingBuffer.Entry.ToString ( )

inline

Converts the Entry to a string. Returns a string representation of the entry.

Returns

The converted Entry. A string containing the index, bookmark, and activity status.

---

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

• AMPS.Client/BookmarkRingBuffer.cs