# uvm_copier

Implementation of the uvm_copier class, as defined in section 16.6 of 1800.2-2020

Summary

uvm_copier
Implementation of the uvm_copier class, as defined in section 16.6 of 1800.2-2020
Methods |
get_num_copies | Returns the number of times the rhs has been copied to a unique lhs
get_first_copy |
get_next_copy |
get_last_copy |
get_prev_copy |

### Methods

### get_num_copies

> function int unsigned get_num_copies(
> | uvm_object | rhs
> )

Returns the number of times the rhs has been copied to a unique lhs

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

### get_first_copy

>     function int get_first_copy(uvm_object rhs, ref uvm_object lhs)

assigns to the lhs the value of the first (smallest) object that was copied from the rhs. It returns 0 if the rhs hasn’t been copied; otherwise, it returns 1.

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

### get_next_copy

>     function int get_next_copy(uvm_object rhs, ref uvm_object lhs)

finds the smallest object that was copied from the rhs whose value is greater than the given lhs object argument. If there is a next entry, the lhs is assigned the value of the next object, and the function returns 1. Otherwise, the lhs is unchanged, and the function returns 0.

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

### get_last_copy

>     function int get_last_copy(uvm_object rhs, ref uvm_object lhs)

assigns to the lhs the value of the last (largest) object that was copied from the rhs. It returns 0 if the rhs hasn’t been copied; otherwise, it returns 1.

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

### get_prev_copy

>     function int get_prev_copy(uvm_object rhs, ref uvm_object lhs)

finds the largest object that was copied from the rhs whose value is smaller than the given lhs object argument. If there is a previous entry, the lhs is assigned the value of the previous object, and the function returns 1. Otherwise, the lhs is unchanged, and the function returns 0.

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

> function int unsigned get_num_copies(
> | uvm_object | rhs
> )

Returns the number of times the rhs has been copied to a unique lhs