civ/hot-step-cpp-ROCm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
876886a39a280430aa6d171c2ad1fefaf1eb4ad8
hot-step-cpp-ROCm/engine/vendor/vst3sdk/doc/vstinterfaces/classSteinberg_1_1ITest.html
T
civ 876886a39a Initial release
2026-08-16 18:24:52 +07:00

326 lines
19 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>VST 3 Interfaces: ITest Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="smtg_extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">VST 3 Interfaces<span id="projectnumber">&#160;VST 3.8</span>
</div>
<div id="projectbrief">SDK for developing VST plug-in</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('classSteinberg_1_1ITest.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classSteinberg_1_1ITest-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ITest Class Reference<span class="mlabels"><span class="mlabel abstract">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;itest.h&gt;</code></p>
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for ITest:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classSteinberg_1_1ITest__inherit__graph.png" border="0" usemap="#aITest_inherit__map" alt="Inheritance graph"/></div>
<map name="aITest_inherit__map" id="aITest_inherit__map">
<area shape="rect" title=" " alt="" coords="26,155,136,277"/>
<area shape="rect" target="_parent" href="../vstsdk/classSteinberg_1_1Vst_1_1TestBase.html" title=" " alt="" coords="5,325,157,562"/>
<area shape="poly" title=" " alt="" coords="84,292,84,325,79,325,79,292"/>
<area shape="rect" target="_parent" href="../base/classSteinberg_1_1FUnknown.html" title=" " alt="" coords="27,5,136,107"/>
<area shape="poly" title=" " alt="" coords="84,122,84,156,79,156,79,122"/>
<area shape="rect" target="_parent" href="../vstsdk/classSteinberg_1_1Vst_1_1TestEnh.html" title=" " alt="" coords="7,610,156,809"/>
<area shape="poly" title=" " alt="" coords="84,577,84,610,79,610,79,577"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af060cf05dd752b63abfc8a0cb51205c0" id="r_af060cf05dd752b63abfc8a0cb51205c0"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af060cf05dd752b63abfc8a0cb51205c0">setup</a> ()=0</td></tr>
<tr class="memdesc:af060cf05dd752b63abfc8a0cb51205c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">called immediately before the test is actually run. <br /></td></tr>
<tr class="separator:af060cf05dd752b63abfc8a0cb51205c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4400a8b9f2e353b65a2fba78883ca820" id="r_a4400a8b9f2e353b65a2fba78883ca820"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4400a8b9f2e353b65a2fba78883ca820">run</a> (<a class="el" href="classSteinberg_1_1ITestResult.html">ITestResult</a> *testResult)=0</td></tr>
<tr class="memdesc:a4400a8b9f2e353b65a2fba78883ca820"><td class="mdescLeft">&#160;</td><td class="mdescRight">execute the test. <br /></td></tr>
<tr class="separator:a4400a8b9f2e353b65a2fba78883ca820"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47a53344d6db1006db6f4008102ae437" id="r_a47a53344d6db1006db6f4008102ae437"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a47a53344d6db1006db6f4008102ae437">teardown</a> ()=0</td></tr>
<tr class="memdesc:a47a53344d6db1006db6f4008102ae437"><td class="mdescLeft">&#160;</td><td class="mdescRight">called after the test has run. <br /></td></tr>
<tr class="separator:a47a53344d6db1006db6f4008102ae437"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1976089a2200980e907b3b3532a11f48" id="r_a1976089a2200980e907b3b3532a11f48"><td class="memItemLeft" align="right" valign="top">virtual const <a class="elRef" href="../base/group__smtgtypedef.html#gaa9eb7d301130a7771343735bef461579">char</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1976089a2200980e907b3b3532a11f48">getDescription</a> ()</td></tr>
<tr class="memdesc:a1976089a2200980e907b3b3532a11f48"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to provide information about the performed testcase. <br /></td></tr>
<tr class="separator:a1976089a2200980e907b3b3532a11f48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classSteinberg_1_1FUnknown"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classSteinberg_1_1FUnknown')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../base/classSteinberg_1_1FUnknown.html">FUnknown</a></td></tr>
<tr class="memitem:a4199134d0669bfa92b7419dac14c01a7 inherit pub_methods_classSteinberg_1_1FUnknown" id="r_a4199134d0669bfa92b7419dac14c01a7"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="../base/group__smtgtypedef.html#ga902761e005a6252e538c766de48fc957">tresult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="elRef" href="../base/classSteinberg_1_1FUnknown.html#a4199134d0669bfa92b7419dac14c01a7">queryInterface</a> (const <a class="elRef" href="../base/group__pluginBase.html#ga6935af93744bfe4ecc455f274ef1ec36">TUID</a> _iid, void **obj)=0</td></tr>
<tr class="separator:a4199134d0669bfa92b7419dac14c01a7 inherit pub_methods_classSteinberg_1_1FUnknown"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa3c5a2a5410d41153d7f5e3f4e0a635 inherit pub_methods_classSteinberg_1_1FUnknown" id="r_aaa3c5a2a5410d41153d7f5e3f4e0a635"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="../base/group__smtgtypedef.html#gacbd4acd0d29e2d6c43104827f77d9cd2">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="elRef" href="../base/classSteinberg_1_1FUnknown.html#aaa3c5a2a5410d41153d7f5e3f4e0a635">addRef</a> ()=0</td></tr>
<tr class="separator:aaa3c5a2a5410d41153d7f5e3f4e0a635 inherit pub_methods_classSteinberg_1_1FUnknown"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58847c78bf6142f01ce214c2802cb146 inherit pub_methods_classSteinberg_1_1FUnknown" id="r_a58847c78bf6142f01ce214c2802cb146"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="../base/group__smtgtypedef.html#gacbd4acd0d29e2d6c43104827f77d9cd2">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="elRef" href="../base/classSteinberg_1_1FUnknown.html#a58847c78bf6142f01ce214c2802cb146">release</a> ()=0</td></tr>
<tr class="separator:a58847c78bf6142f01ce214c2802cb146 inherit pub_methods_classSteinberg_1_1FUnknown"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:ae78a44399218c930be44d3aa46521d0e" id="r_ae78a44399218c930be44d3aa46521d0e"><td class="memItemLeft" align="right" valign="top">static const <a class="elRef" href="../base/classSteinberg_1_1FUID.html">FUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae78a44399218c930be44d3aa46521d0e">iid</a></td></tr>
<tr class="separator:ae78a44399218c930be44d3aa46521d0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_static_attribs_classSteinberg_1_1FUnknown"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_static_attribs_classSteinberg_1_1FUnknown')"><img src="closed.png" alt="-"/>&#160;Static Public Attributes inherited from <a class="el" href="../base/classSteinberg_1_1FUnknown.html">FUnknown</a></td></tr>
<tr class="memitem:a07978c93295b03d09c4bc97aa12e9c60 inherit pub_static_attribs_classSteinberg_1_1FUnknown" id="r_a07978c93295b03d09c4bc97aa12e9c60"><td class="memItemLeft" align="right" valign="top">static const <a class="elRef" href="../base/classSteinberg_1_1FUID.html">FUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="elRef" href="../base/classSteinberg_1_1FUnknown.html#a07978c93295b03d09c4bc97aa12e9c60">iid</a></td></tr>
<tr class="separator:a07978c93295b03d09c4bc97aa12e9c60 inherit pub_static_attribs_classSteinberg_1_1FUnknown"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af060cf05dd752b63abfc8a0cb51205c0" name="af060cf05dd752b63abfc8a0cb51205c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af060cf05dd752b63abfc8a0cb51205c0">&#9670;&#160;</a></span>setup()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool setup </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>called immediately before the test is actually run. </p>
<p>Usually this will be used to setup the test environment. </p><dl class="section return"><dt>Returns</dt><dd>true upon success </dd></dl>
<p>Implemented in <a class="elRef" href="../vstsdk/classSteinberg_1_1Vst_1_1TestBase.html#a9b4ec98f480506d062a27f0eef17374e">TestBase</a>, and <a class="elRef" href="../vstsdk/classSteinberg_1_1Vst_1_1TestEnh.html#a9b4ec98f480506d062a27f0eef17374e">TestEnh</a>.</p>
</div>
</div>
<a id="a4400a8b9f2e353b65a2fba78883ca820" name="a4400a8b9f2e353b65a2fba78883ca820"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4400a8b9f2e353b65a2fba78883ca820">&#9670;&#160;</a></span>run()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool run </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classSteinberg_1_1ITestResult.html">ITestResult</a> *</td> <td class="paramname"><span class="paramname"><em>testResult</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>execute the test. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">testResult</td><td>: points to a test result where the test can (optionally) add an error message. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true upon success </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classSteinberg_1_1ITestResult.html" title="Test Result message logger [host imp] When a test is called, a pointer to an ITestResult is passed in...">ITestResult</a> </dd></dl>
<p>Implemented in <a class="elRef" href="../vstsdk/classSteinberg_1_1Vst_1_1TestBase.html#a61757a2824b38b279c3be2ed20ccddeb">TestBase</a>.</p>
</div>
</div>
<a id="a47a53344d6db1006db6f4008102ae437" name="a47a53344d6db1006db6f4008102ae437"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47a53344d6db1006db6f4008102ae437">&#9670;&#160;</a></span>teardown()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool teardown </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>called after the test has run. </p>
<p>This method shall be used to deconstruct a test environment that has been setup with <a class="el" href="#af060cf05dd752b63abfc8a0cb51205c0" title="called immediately before the test is actually run.">ITest::setup</a> (). </p><dl class="section return"><dt>Returns</dt><dd>true upon success </dd></dl>
<p>Implemented in <a class="elRef" href="../vstsdk/classSteinberg_1_1Vst_1_1TestBase.html#a3d1fb91255e41edeeaee8794cd488720">TestBase</a>, and <a class="elRef" href="../vstsdk/classSteinberg_1_1Vst_1_1TestEnh.html#a3d1fb91255e41edeeaee8794cd488720">TestEnh</a>.</p>
</div>
</div>
<a id="a1976089a2200980e907b3b3532a11f48" name="a1976089a2200980e907b3b3532a11f48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1976089a2200980e907b3b3532a11f48">&#9670;&#160;</a></span>getDescription()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="elRef" href="../base/group__smtgtypedef.html#gaa9eb7d301130a7771343735bef461579">char</a> * getDescription </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This function is used to provide information about the performed testcase. </p>
<p>What is done, what is validated and what has to be prepared before executing the test (in case of half-automated tests). </p><dl class="section return"><dt>Returns</dt><dd>null terminated string upon success, zero otherwise </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ae78a44399218c930be44d3aa46521d0e" name="ae78a44399218c930be44d3aa46521d0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae78a44399218c930be44d3aa46521d0e">&#9670;&#160;</a></span>iid</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="elRef" href="../base/classSteinberg_1_1FUID.html">FUID</a> iid</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<html>
<head>
<title>Empty</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="Author" content="Steinberg">
</head>
<body>
<br/>
<hr width="100%" size="2" align="left" />
<div align=right>
Copyright &copy;<span id="year"></span> <a href="http://www.steinberg.net" target="_blank"><u>Steinberg Media Technologies GmbH</u></a>.
All Rights Reserved. This documentation is under this <a href="http://www.steinberg.net/sdklicenses" target="_blank"><u>license</u></a>.
</div>
<script>
document.querySelector("#year").textContent = new Date().getFullYear();
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink