blob: 6278b43e9bb5ce431deabc2b84b44789443549d1 [file] [log] [blame]
<html><head><title>Factory Component and Object Wrappers</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="CSection"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="Factory_Component_and_Object_Wrappers" href="../../../../src/base/uvm_registry.svh">Factory Component and Object Wrappers</a></h1><div class=CBody><p>This section defines the proxy component and object classes used by the factory.</p>
<!--START_ND_SUMMARY index=0-->
<div class=Summary><div class=STitle>Contents</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable>
<!-- index=0 -->
<tr class="SMain"><td class=SEntry><a href="#Factory_Component_and_Object_Wrappers" >Factory Component and Object Wrappers</a></td><td class=SDescription>This section defines the proxy component and object classes used by the factory.</td></tr>
<!-- index=1 -->
<tr class="SSMethod SMarked"><td class=SEntry><a href="#uvm_component_registry#(T,Tname)" >uvm_component_registry#(T,Tname)</a></td><td class=SDescription>Implementation of uvm_component_registry#(T,Tname), as defined by section 8.2.3.1 of 1800.2-2017.</td></tr>
<!-- index=4 -->
<tr class="SSMethod"><td class=SEntry><a href="#uvm_object_registry#(T,Tname)" >uvm_object_registry#(T,Tname)</a></td><td class=SDescription>Implementation of uvm_object_registry#(T,Tname), as defined by section 8.2.4.1 of 1800.2-2017.</td></tr>
<!-- index=7 -->
<tr class="SSMethod SMarked"><td class=SEntry><a href="#uvm_abstract_component_registry#(T,Tname)" >uvm_abstract_component_registry#(T,Tname)</a></td><td class=SDescription>Implementation of uvm_abstract_component_registry#(T,Tname), as defined by section 8.2.5.1.1 of 1800.2-2017.</td></tr>
<!-- index=10 -->
<tr class="SSMethod"><td class=SEntry><a href="#uvm_abstract_object_registry#(T,Tname)" >uvm_abstract_object_registry#(T,Tname)</a></td><td class=SDescription>Implementation of uvm_abstract_object_registry#(T,Tname), as defined by section 8.2.5.2.1 of 1800.2-2017.</td></tr></table></div></div><!--END_ND_SUMMARY-->
</div></div></div>
<!--CONTENT index=1 -->
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="uvm_component_registry#(T,Tname)" href="../../../../src/base/uvm_registry.svh">uvm_component_registry#(T,Tname)</a></h2><div class=CBody><p>Implementation of uvm_component_registry#(T,Tname), as defined by section 8.2.3.1 of 1800.2-2017.</p>
<!--START_ND_SUMMARY index=1-->
<div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable>
<!-- index=1 -->
<tr class="SClass"><td colspan=2 class=SEntry><a href="#uvm_component_registry#(T,Tname)" >uvm_component_registry#(T,Tname)</a></td></tr>
<tr class=SMain><td colspan=2 class=SWideDescription>Implementation of uvm_component_registry#(T,Tname), as defined by section 8.2.3.1 of 1800.2-2017.</td></tr>
<!-- index=2 -->
<tr class="SGroup SIndent1"><td class=SEntry><a href="#uvm_component_registry#(T,Tname).Methods" >Methods</a></td><td class=SDescription></td></tr>
<!-- index=3 -->
<tr class="SMethod SIndent2"><td class=SEntry><a href="#uvm_component_registry#(T,Tname).set_type_alias" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">set_type_alias</a></td><td class=SDescription>Sets a type alias for this wrapper in the default factory.</td></tr></table></div></div><!--END_ND_SUMMARY-->
</div></div></div>
<!--CONTENT index=2 -->
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="uvm_component_registry#(T,Tname).Methods" href="../../../../src/base/uvm_registry.svh">Methods</a></h3></div></div>
<!--CONTENT index=3 -->
<div class="CMethod"><div class=CTopic><h3 class=CTitle><a name="uvm_component_registry#(T,Tname).set_type_alias" href="../../../../src/base/uvm_registry.svh">set_type_alias</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>static function bit set_type_alias(</td> </tr><tr><td>&nbsp;&nbsp;&nbsp;</td> <td class=PType nowrap>string&nbsp;</td>
<td class=PParameter nowrap width=100%>alias_name</td>
</tr>
<tr>
<td class=PAfterParameters colspan=3>)</td></tr>
</table></td></tr>
</table></blockquote>
<div class=CBody><p>Sets a type alias for this wrapper in the default factory.</p><p>If this wrapper is not yet registered with a factory (see &lt;uvm_factory::register&gt;), then the alias is deferred until registration occurs.</p><p>@uvm-contrib This API is being considered for potential contribution to 1800.2</p></div></div></div>
<!--CONTENT index=4 -->
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="uvm_object_registry#(T,Tname)" href="../../../../src/base/uvm_registry.svh">uvm_object_registry#(T,Tname)</a></h2><div class=CBody><p>Implementation of uvm_object_registry#(T,Tname), as defined by section 8.2.4.1 of 1800.2-2017.</p>
<!--START_ND_SUMMARY index=4-->
<div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable>
<!-- index=4 -->
<tr class="SClass"><td colspan=2 class=SEntry><a href="#uvm_object_registry#(T,Tname)" >uvm_object_registry#(T,Tname)</a></td></tr>
<tr class=SMain><td colspan=2 class=SWideDescription>Implementation of uvm_object_registry#(T,Tname), as defined by section 8.2.4.1 of 1800.2-2017.</td></tr>
<!-- index=5 -->
<tr class="SGroup SIndent1"><td class=SEntry><a href="#uvm_object_registry#(T,Tname).Methods" >Methods</a></td><td class=SDescription></td></tr>
<!-- index=6 -->
<tr class="SMethod SIndent2"><td class=SEntry><a href="#uvm_object_registry#(T,Tname).set_type_alias" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">set_type_alias</a></td><td class=SDescription>Sets a type alias for this wrapper in the default factory.</td></tr></table></div></div><!--END_ND_SUMMARY-->
</div></div></div>
<!--CONTENT index=5 -->
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="uvm_object_registry#(T,Tname).Methods" href="../../../../src/base/uvm_registry.svh">Methods</a></h3></div></div>
<!--CONTENT index=6 -->
<div class="CMethod"><div class=CTopic><h3 class=CTitle><a name="uvm_object_registry#(T,Tname).set_type_alias" href="../../../../src/base/uvm_registry.svh">set_type_alias</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>static function bit set_type_alias(</td> </tr><tr><td>&nbsp;&nbsp;&nbsp;</td> <td class=PType nowrap>string&nbsp;</td>
<td class=PParameter nowrap width=100%>alias_name</td>
</tr>
<tr>
<td class=PAfterParameters colspan=3>)</td></tr>
</table></td></tr>
</table></blockquote>
<div class=CBody><p>Sets a type alias for this wrapper in the default factory.</p><p>If this wrapper is not yet registered with a factory (see &lt;uvm_factory::register&gt;), then the alias is deferred until registration occurs.</p><p>@uvm-contrib This API is being considered for potential contribution to 1800.2</p></div></div></div>
<!--CONTENT index=7 -->
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="uvm_abstract_component_registry#(T,Tname)" href="../../../../src/base/uvm_registry.svh">uvm_abstract_component_registry#(T,Tname)</a></h2><div class=CBody><p>Implementation of uvm_abstract_component_registry#(T,Tname), as defined by section 8.2.5.1.1 of 1800.2-2017.</p>
<!--START_ND_SUMMARY index=7-->
<div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable>
<!-- index=7 -->
<tr class="SClass"><td colspan=2 class=SEntry><a href="#uvm_abstract_component_registry#(T,Tname)" >uvm_abstract_component_registry#(T,Tname)</a></td></tr>
<tr class=SMain><td colspan=2 class=SWideDescription>Implementation of uvm_abstract_component_registry#(T,Tname), as defined by section 8.2.5.1.1 of 1800.2-2017.</td></tr>
<!-- index=8 -->
<tr class="SGroup SIndent1"><td class=SEntry><a href="#uvm_abstract_component_registry#(T,Tname).Methods" >Methods</a></td><td class=SDescription></td></tr>
<!-- index=9 -->
<tr class="SMethod SIndent2"><td class=SEntry><a href="#uvm_abstract_component_registry#(T,Tname).set_type_alias" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">set_type_alias</a></td><td class=SDescription>Sets a type alias for this wrapper in the default factory.</td></tr></table></div></div><!--END_ND_SUMMARY-->
</div></div></div>
<!--CONTENT index=8 -->
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="uvm_abstract_component_registry#(T,Tname).Methods" href="../../../../src/base/uvm_registry.svh">Methods</a></h3></div></div>
<!--CONTENT index=9 -->
<div class="CMethod"><div class=CTopic><h3 class=CTitle><a name="uvm_abstract_component_registry#(T,Tname).set_type_alias" href="../../../../src/base/uvm_registry.svh">set_type_alias</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>static function bit set_type_alias(</td> </tr><tr><td>&nbsp;&nbsp;&nbsp;</td> <td class=PType nowrap>string&nbsp;</td>
<td class=PParameter nowrap width=100%>alias_name</td>
</tr>
<tr>
<td class=PAfterParameters colspan=3>)</td></tr>
</table></td></tr>
</table></blockquote>
<div class=CBody><p>Sets a type alias for this wrapper in the default factory.</p><p>If this wrapper is not yet registered with a factory (see &lt;uvm_factory::register&gt;), then the alias is deferred until registration occurs.</p><p>@uvm-contrib This API is being considered for potential contribution to 1800.2</p></div></div></div>
<!--CONTENT index=10 -->
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="uvm_abstract_object_registry#(T,Tname)" href="../../../../src/base/uvm_registry.svh">uvm_abstract_object_registry#(T,Tname)</a></h2><div class=CBody><p>Implementation of uvm_abstract_object_registry#(T,Tname), as defined by section 8.2.5.2.1 of 1800.2-2017.</p>
<!--START_ND_SUMMARY index=10-->
<div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable>
<!-- index=10 -->
<tr class="SClass"><td colspan=2 class=SEntry><a href="#uvm_abstract_object_registry#(T,Tname)" >uvm_abstract_object_registry#(T,Tname)</a></td></tr>
<tr class=SMain><td colspan=2 class=SWideDescription>Implementation of uvm_abstract_object_registry#(T,Tname), as defined by section 8.2.5.2.1 of 1800.2-2017.</td></tr>
<!-- index=11 -->
<tr class="SGroup SIndent1"><td class=SEntry><a href="#uvm_abstract_object_registry#(T,Tname).Methods" >Methods</a></td><td class=SDescription></td></tr>
<!-- index=12 -->
<tr class="SMethod SIndent2"><td class=SEntry><a href="#uvm_abstract_object_registry#(T,Tname).set_type_alias" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">set_type_alias</a></td><td class=SDescription>Sets a type alias for this wrapper in the default factory.</td></tr></table></div></div><!--END_ND_SUMMARY-->
</div></div></div>
<!--CONTENT index=11 -->
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="uvm_abstract_object_registry#(T,Tname).Methods" href="../../../../src/base/uvm_registry.svh">Methods</a></h3></div></div>
<!--CONTENT index=12 -->
<div class="CMethod"><div class=CTopic><h3 class=CTitle><a name="uvm_abstract_object_registry#(T,Tname).set_type_alias" href="../../../../src/base/uvm_registry.svh">set_type_alias</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>static function bit set_type_alias(</td> </tr><tr><td>&nbsp;&nbsp;&nbsp;</td> <td class=PType nowrap>string&nbsp;</td>
<td class=PParameter nowrap width=100%>alias_name</td>
</tr>
<tr>
<td class=PAfterParameters colspan=3>)</td></tr>
</table></td></tr>
</table></blockquote>
<div class=CBody><p>Sets a type alias for this wrapper in the default factory.</p><p>If this wrapper is not yet registered with a factory (see &lt;uvm_factory::register&gt;), then the alias is deferred until registration occurs.</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>static function bit set_type_alias(</td> </tr><tr><td>&nbsp;&nbsp;&nbsp;</td> <td class=PType nowrap>string&nbsp;</td>
<td class=PParameter nowrap width=100%>alias_name</td>
</tr>
<tr>
<td class=PAfterParameters colspan=3>)</td></tr>
</table></td></tr>
</table></blockquote>
Sets a type alias for this wrapper in the default factory.</div></div><div class=CToolTip id="tt2"><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>static function bit set_type_alias(</td> </tr><tr><td>&nbsp;&nbsp;&nbsp;</td> <td class=PType nowrap>string&nbsp;</td>
<td class=PParameter nowrap width=100%>alias_name</td>
</tr>
<tr>
<td class=PAfterParameters colspan=3>)</td></tr>
</table></td></tr>
</table></blockquote>
Sets a type alias for this wrapper in the default factory.</div></div><div class=CToolTip id="tt3"><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>static function bit set_type_alias(</td> </tr><tr><td>&nbsp;&nbsp;&nbsp;</td> <td class=PType nowrap>string&nbsp;</td>
<td class=PParameter nowrap width=100%>alias_name</td>
</tr>
<tr>
<td class=PAfterParameters colspan=3>)</td></tr>
</table></td></tr>
</table></blockquote>
Sets a type alias for this wrapper in the default factory.</div></div><div class=CToolTip id="tt4"><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>static function bit set_type_alias(</td> </tr><tr><td>&nbsp;&nbsp;&nbsp;</td> <td class=PType nowrap>string&nbsp;</td>
<td class=PParameter nowrap width=100%>alias_name</td>
</tr>
<tr>
<td class=PAfterParameters colspan=3>)</td></tr>
</table></td></tr>
</table></blockquote>
Sets a type alias for this wrapper in the default factory.</div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>