blob: 0a2842b8d2cbae3a07d16c1bc2d5d389131bcda4 [file] [log] [blame]
<html><head><title>uvm_copier</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><script language=JavaScript src="../../javascript/main.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version Development Release 01-12-2008 (1.35 base) -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<!--TOP - START OF CONTENT-->
<div id=Content>
<!--CONTENT index=0 -->
<div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="uvm_copier" href="../../../../src/base/uvm_copier.svh">uvm_copier</a></h1><div class=CBody><p>Implementation of the uvm_copier class, as defined in section 16.6.1 of 1800.2-2017</p>
<!--START_ND_SUMMARY index=0-->
<div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable>
<!-- index=0 -->
<tr class="SClass"><td colspan=2 class=SEntry><a href="#uvm_copier" >uvm_copier</a></td></tr>
<tr class=SMain><td colspan=2 class=SWideDescription>Implementation of the uvm_copier class, as defined in section 16.6.1 of 1800.2-2017</td></tr>
<!-- index=1 -->
<tr class="SGroup SIndent1"><td class=SEntry><a href="#uvm_copier.Methods" >Methods</a></td><td class=SDescription></td></tr>
<!-- index=2 -->
<tr class="SMethod SIndent2"><td class=SEntry><a href="#uvm_copier.get_num_copies" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">get_num_copies</a></td><td class=SDescription>Returns the number of times the <i>rhs</i> has been copied to a unique <i>lhs</i></td></tr>
<!-- index=3 -->
<tr class="SMethod SIndent2 SMarked"><td class=SEntry><a href="#uvm_copier.get_first_copy" >get_first_copy</a></td><td class=SDescription></td></tr>
<!-- index=4 -->
<tr class="SMethod SIndent2 SMarked"><td class=SEntry><a href="#uvm_copier.get_next_copy" >get_next_copy</a></td><td class=SDescription></td></tr>
<!-- index=5 -->
<tr class="SMethod SIndent2 SMarked"><td class=SEntry><a href="#uvm_copier.get_last_copy" >get_last_copy</a></td><td class=SDescription></td></tr>
<!-- index=6 -->
<tr class="SMethod SIndent2 SMarked"><td class=SEntry><a href="#uvm_copier.get_prev_copy" >get_prev_copy</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY-->
</div></div></div>
<!--CONTENT index=1 -->
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="uvm_copier.Methods" href="../../../../src/base/uvm_copier.svh">Methods</a></h3></div></div>
<!--CONTENT index=2 -->
<div class="CMethod"><div class=CTopic><h3 class=CTitle><a name="uvm_copier.get_num_copies" href="../../../../src/base/uvm_copier.svh">get_num_copies</a></h3>
<blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype>
<tr><td><table border=0 cellspacing=0 cellpadding=0><tr>
<td class=PBeforeParameters colspan=3>function int unsigned get_num_copies(</td> </tr><tr><td>&nbsp;&nbsp;&nbsp;</td> <td class=PType nowrap>uvm_object&nbsp;</td>
<td class=PParameter nowrap width=100%>rhs</td>
</tr>
<tr>
<td class=PAfterParameters colspan=3>)</td></tr>
</table></td></tr>
</table></blockquote>
<div class=CBody><p>Returns the number of times the <i>rhs</i> has been copied to a unique <i>lhs</i></p><p>@uvm-contrib This API is being considered for potential contribution to 1800.2</p></div></div></div>
<!--CONTENT index=3 -->
<div class="CMethod"><div class=CTopic><h3 class=CTitle><a name="uvm_copier.get_first_copy" href="../../../../src/base/uvm_copier.svh">get_first_copy</a></h3><div class=CBody><blockquote><pre>function int get_first_copy(uvm_object rhs, ref uvm_object lhs)</pre></blockquote><p>assigns to the <i>lhs</i> the value of the first (smallest) object that was copied from the <i>rhs</i>.&nbsp; It returns 0 if the <i>rhs</i> hasn&rsquo;t been copied; otherwise, it returns 1.</p><p>@uvm-contrib This API is being considered for potential contribution to 1800.2</p></div></div></div>
<!--CONTENT index=4 -->
<div class="CMethod"><div class=CTopic><h3 class=CTitle><a name="uvm_copier.get_next_copy" href="../../../../src/base/uvm_copier.svh">get_next_copy</a></h3><div class=CBody><blockquote><pre>function int get_next_copy(uvm_object rhs, ref uvm_object lhs)</pre></blockquote><p>finds the smallest object that was copied from the <i>rhs</i> whose value is greater than the given <i>lhs</i> object argument.&nbsp; If there is a next entry, the <i>lhs</i> is assigned the value of the next object, and the function returns 1.&nbsp; Otherwise, the <i>lhs</i> is unchanged, and the function returns 0.</p><p>@uvm-contrib This API is being considered for potential contribution to 1800.2</p></div></div></div>
<!--CONTENT index=5 -->
<div class="CMethod"><div class=CTopic><h3 class=CTitle><a name="uvm_copier.get_last_copy" href="../../../../src/base/uvm_copier.svh">get_last_copy</a></h3><div class=CBody><blockquote><pre>function int get_last_copy(uvm_object rhs, ref uvm_object lhs)</pre></blockquote><p>assigns to the <i>lhs</i> the value of the last (largest) object that was copied from the <i>rhs</i>.&nbsp; It returns 0 if the <i>rhs</i> hasn&rsquo;t been copied; otherwise, it returns 1.</p><p>@uvm-contrib This API is being considered for potential contribution to 1800.2</p></div></div></div>
<!--CONTENT index=6 -->
<div class="CMethod"><div class=CTopic><h3 class=CTitle><a name="uvm_copier.get_prev_copy" href="../../../../src/base/uvm_copier.svh">get_prev_copy</a></h3><div class=CBody><blockquote><pre>function int get_prev_copy(uvm_object rhs, ref uvm_object lhs)</pre></blockquote><p>finds the largest object that was copied from the <i>rhs</i> whose value is smaller than the given <i>lhs</i> object argument.&nbsp; If there is a previous entry, the <i>lhs</i> is assigned the value of the previous object, and the function returns 1.&nbsp; Otherwise, the <i>lhs</i> is unchanged, and the function returns 0.</p><p>@uvm-contrib This API is being considered for potential contribution to 1800.2</p></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CMethod>
<blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype>
<tr><td><table border=0 cellspacing=0 cellpadding=0><tr>
<td class=PBeforeParameters colspan=3>function int unsigned get_num_copies(</td> </tr><tr><td>&nbsp;&nbsp;&nbsp;</td> <td class=PType nowrap>uvm_object&nbsp;</td>
<td class=PParameter nowrap width=100%>rhs</td>
</tr>
<tr>
<td class=PAfterParameters colspan=3>)</td></tr>
</table></td></tr>
</table></blockquote>
Returns the number of times the <i>rhs</i> has been copied to a unique <i>lhs</i></div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>