cl_syoscb_queue_iterator_base Class Reference

Queue iterator base class defining the iterator API used for iterating queues. More...

Inheritance diagram for cl_syoscb_queue_iterator_base:

[legend]

Collaboration diagram for cl_syoscb_queue_iterator_base:

[legend]

List of all members.

Public Member Functions
virtual bit	previous ()
	Iterator API: Moves the iterator to the previous item in the queue.
virtual bit	first ()
	Iterator API: Moves the iterator to the first item in the queue.
virtual bit	last ()
	Iterator API: Moves the iterator to the last item in the queue.
virtual int unsigned	get_idx ()
	Iterator API: Returns the current index
virtual cl_syoscb_item	get_item ()
	Iterator API: Returns the current cl_syoscb_item object at the current index
virtual bit	is_done ()
	Iterator API: Returns 1'b0 as long as the iterator has not reached the end.
protected cl_syoscb_queue	get_queue ()
	Iterator API: Returns releated queue
virtual bit	set_queue (cl_syoscb_queue owner)
	Iterator API: Sets releated queue
Protected Attributes
cl_syoscb_queue	owner
	The owner of this iterator.
int unsigned	position = 0
	Current position in the queue.

---

Detailed Description

Queue iterator base class defining the iterator API used for iterating queues.

Definition at line 2 of file cl_syoscb_queue_iterator_base.svh.

---

Member Function Documentation

bit cl_syoscb_queue_iterator_base::first

(

)

[virtual]

Iterator API: Moves the iterator to the first item in the queue.

It shall return 1'b0 if there is no first item (Queue is empty).

Reimplemented in cl_syoscb_queue_iterator_std, and cl_syoscb_queue_iterator_std.

Definition at line 56 of file cl_syoscb_queue_iterator_base.svh.

bit cl_syoscb_queue_iterator_base::is_done

(

)

[virtual]

Iterator API: Returns 1'b0 as long as the iterator has not reached the end.

When the iterator has reached the end then it returns 1'b1.

Reimplemented in cl_syoscb_queue_iterator_std, and cl_syoscb_queue_iterator_std.

Definition at line 82 of file cl_syoscb_queue_iterator_base.svh.

bit cl_syoscb_queue_iterator_base::last

(

)

[virtual]

Iterator API: Moves the iterator to the last item in the queue.

It shall return 1'b0 if there is no last item (Queue is empty).

Reimplemented in cl_syoscb_queue_iterator_std, and cl_syoscb_queue_iterator_std.

Definition at line 63 of file cl_syoscb_queue_iterator_base.svh.

bit cl_syoscb_queue_iterator_base::previous

(

)

[virtual]

Iterator API: Moves the iterator to the previous item in the queue.

It shall return 1'b0 if there is no previous item, e.g. when it is either empty or the iterator has reached the very beginning of the queue.

Reimplemented in cl_syoscb_queue_iterator_std, and cl_syoscb_queue_iterator_std.

Definition at line 49 of file cl_syoscb_queue_iterator_base.svh.

---

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

• cl_syoscb_queue_iterator_base.svh