# uvm_sequencer_base

The library implements some public API beyond what is documented in 1800.2. It also modifies some API described erroneously in 1800.2.

Summary

uvm_sequencer_base
The library implements some public API beyond what is documented in 1800.2.
Methods |
unlock |
ungrab |
Macros |
UVM_DISABLE_AUTO_ITEM_RECORDING | Performs the same function as the 1800.2 define UVM_DISABLE_RECORDING, globally turning off automatic item recording when defined by the user.
Methods |
disable_auto_item_recording | Disables auto_item_recording
is_auto_item_recording_enabled | Returns 1 is auto_item_recording is enabled, otherwise 0

### Methods

### unlock

>     extern virtual function void unlock(uvm_sequence_base sequence_ptr);

Implementation of unlock, as defined in P1800.2-2017 section 15.3.2.12.

NOTE: unlock is documented in error as a virtual task, whereas it is implemented as a virtual function.

@uvm-contrib This API is being considered for potential contribution to 1800.2

### ungrab

>     extern virtual function void ungrab(uvm_sequence_base sequence_ptr);

Implementation of ungrab, as defined in P1800.2-2017 section 15.3.2.13.

NOTE: ungrab is documented in error as a virtual task, whereas it is implemented as a virtual function.

@uvm-contrib This API is being considered for potential contribution to 1800.2

### Macros

### UVM_DISABLE_AUTO_ITEM_RECORDING

Performs the same function as the 1800.2 define UVM_DISABLE_RECORDING, globally turning off automatic item recording when defined by the user. Provided for backward compatibility.

@uvm-contrib This API is being considered for potential contribution to 1800.2

### Methods

### disable_auto_item_recording

> virtual function void disable_auto_item_recording()

Disables auto_item_recording

This function is the implementation of the uvm_sqr_if_base::disable_auto_item_recording() method detailed in IEEE1800.2 section 15.2.1.2.10

This function is implemented here to allow <uvm_push_sequencer#(REQ,RSP)> and <uvm_push_driver#(REQ,RSP)> access to the call.

@uvm-contrib This API is being considered for potential contribution to 1800.2

### is_auto_item_recording_enabled

> virtual function bit is_auto_item_recording_enabled()

Returns 1 is auto_item_recording is enabled, otherwise 0

This function is the implementation of the uvm_sqr_if_base::is_auto_item_recording_enabled() method detailed in IEEE1800.2 section 15.2.1.2.11

This function is implemented here to allow <uvm_push_sequencer#(REQ,RSP)> and <uvm_push_driver#(REQ,RSP)> access to the call.

@uvm-contrib This API is being considered for potential contribution to 1800.2

> virtual function void disable_auto_item_recording()

Disables auto_item_recording

> virtual function bit is_auto_item_recording_enabled()

Returns 1 is auto_item_recording is enabled, otherwise 0