cl_syoscb_queue_iterator_std Class Reference

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

Inheritance diagram for cl_syoscb_queue_iterator_std:
Inheritance graph
[legend]
Collaboration diagram for cl_syoscb_queue_iterator_std:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual bit previous ()
 Iterator API: See cl_syoscb_queue_iterator_base for details
virtual bit first ()
 Iterator API: See cl_syoscb_queue_iterator_base for details
virtual bit last ()
 Iterator API: Moves the iterator to the last item in the queue.
virtual int unsigned get_idx ()
 Iterator API: See cl_syoscb_queue_iterator_base for details
virtual cl_syoscb_item get_item ()
 Iterator API: See cl_syoscb_queue_iterator_base for details
virtual bit is_done ()
 Iterator API: See cl_syoscb_queue_iterator_base for details
virtual bit set_queue (cl_syoscb_queue owner)
 Iterator API: See cl_syoscb_queue_iterator_base for details
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.
virtual bit set_queue (cl_syoscb_queue owner)
 Iterator API: Sets releated queue

Detailed Description

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

Definition at line 2 of file cl_syoscb_queue_iterator_std.svh.


Member Function Documentation

virtual bit cl_syoscb_queue_iterator_std::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 from cl_syoscb_queue_iterator_base.

virtual bit cl_syoscb_queue_iterator_std::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 from cl_syoscb_queue_iterator_base.

virtual bit cl_syoscb_queue_iterator_std::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 from cl_syoscb_queue_iterator_base.

bit cl_syoscb_queue_iterator_std::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 from cl_syoscb_queue_iterator_base.

Definition at line 62 of file cl_syoscb_queue_iterator_std.svh.

virtual bit cl_syoscb_queue_iterator_std::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 from cl_syoscb_queue_iterator_base.


The documentation for this class was generated from the following file:
 All Classes Functions Variables

Project: SyoSil ApS UVM Scoreboard, Revision: 1.0.2.2

Copyright 2014-2015 SyoSil ApS
All Rights Reserved Worldwide

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
doxygen
Doxygen Version: 1.6.1
IDV SV Filter Version: 2.6.2
Wed Jul 29 14:03:56 2015
Find a documentation bug? Report bugs to: bugs.intelligentdv.com Project: DoxygenFilterSV