SyoSil ApS UVM Scoreboard  1.0.3.0
Public Member Functions | Private Attributes | List of all members
cl_syoscb_item Class Reference

The UVM scoreboard item which wraps uvm_sequence_item . More...

Inherits uvm_object, and uvm_object.

Public Member Functions

virtual string get_producer ()
 Item API: Returns the producer of the wrapped sequence item
 
virtual void set_producer (string producer)
 Item API: Sets the producer of the wrapped sequence item. More...
 
virtual uvm_sequence_item get_item ()
 Item API: Returns the wrapped uvm_sequence_item
 
virtual void set_item (uvm_sequence_item item)
 Item API: Sets the uvm_sequence_item wrapped by this wrapper item
 
virtual void set_insertion_index (longint unsigned ii)
 Item API: Gets the insertion index of the wrapped sequence item
 
virtual longint unsigned get_insertion_index ()
 Item API: Sets the insertion index of the wrapped sequence item
 
virtual void set_queue_index (longint qi)
 Item API: Sets the queue index of the wrapped sequence item
 
virtual longint get_queue_index ()
 Item API: Gets the queue index of the wrapped sequence item
 
virtual string convert2string ()
 Converts a cl_syoscb_item to a compact string representation. More...
 

Private Attributes

string producer
 Name of the producer that generated this seq. item.
 
uvm_sequence_item item
 Handle to the wrapped uvm_sequence_item.
 
longint unsigned insertion_index
 Insertion index N means that this is the N'th item inserted in that queue.
 
longint queue_index
 This item's position in the queue. More...
 

Detailed Description

The UVM scoreboard item which wraps uvm_sequence_item .

This ensures that future extensions to the UVM scoreboard will always be able to use all uvm_sequence_items from already existing testbenches etc. even though more META data is added to the wrapping item.

Definition at line 4 of file cl_syoscb_item.svh.

Member Function Documentation

◆ convert2string()

string cl_syoscb_item::convert2string ( )
virtual

Converts a cl_syoscb_item to a compact string representation.

Does this by simply returning the convert2string-implementation of the wrapped sequence item.

Note
Raises a warning if newlines are contained in the output, as this may make the output uglier

Definition at line 136 of file cl_syoscb_item.svh.

Referenced by cl_syoscb_queue_base::dump().

◆ set_producer()

void cl_syoscb_item::set_producer ( string  producer)
virtual

Item API: Sets the producer of the wrapped sequence item.

The validity of the producer name must be checked by the caller before setting it in this item.

Parameters
producerThe name of the producer of the wrapped seq. item.

Definition at line 97 of file cl_syoscb_item.svh.

References producer.

Referenced by cl_syoscb_queue_base::pre_add_item().

Member Data Documentation

◆ queue_index

longint cl_syoscb_item::queue_index
private

This item's position in the queue.

This field is only valid when the queue is dumped, as a queue index may change throughout simulation as items ahead of this item are removed from the queue.

Definition at line 20 of file cl_syoscb_item.svh.

Referenced by get_queue_index().


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

Project: SyoSil ApS UVM Scoreboard, Revision: 1.0.3.0

Copyright 2014-2022 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.8.14
Generated with IDV SV Filter Version: 2.6.3
Fri Sep 2 2022 14:41:06
Find a documentation bug? Report bugs to: scoreboard@syosil.com