Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-10-13 08:41:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
6d82d305b9
FairMQ/v1.4.33/classfair_1_1mq_1_1sdk_1_1DDSTopology.html
Alexey Rybalchenko 6d82d305b9 Add API docs for v1.4.33
2021-03-23 14:11:44 +01:00

260 lines
15 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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FairMQ: fair::mq::sdk::DDSTopology 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>
<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" />
</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FairMQ
&#160;<span id="projectnumber">1.4.33</span>
</div>
<div id="projectbrief">C++ Message Queuing Library and Framework</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>fair</b></li><li class="navelem"><a class="el" href="namespacefair_1_1mq.html">mq</a></li><li class="navelem"><b>sdk</b></li><li class="navelem"><a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSTopology.html">DDSTopology</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classfair_1_1mq_1_1sdk_1_1DDSTopology-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">fair::mq::sdk::DDSTopology Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Represents a DDS topology.
<a href="classfair_1_1mq_1_1sdk_1_1DDSTopology.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="DDSTopology_8h_source.html">fairmq/sdk/DDSTopology.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1sdk_1_1DDSTopology_1_1Impl.html">Impl</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a8f22b8b59b32efb837cae06d381e9d07"><td class="memItemLeft" align="right" valign="top"><a id="a8f22b8b59b32efb837cae06d381e9d07"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>Path</b> = boost::filesystem::path</td></tr>
<tr class="separator:a8f22b8b59b32efb837cae06d381e9d07"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3dd6d27021bf63a2e461469449714a17"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSTopology.html#a3dd6d27021bf63a2e461469449714a17">DDSTopology</a> (Path topoFile, <a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSEnvironment.html">DDSEnvironment</a> env=<a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSEnvironment.html">DDSEnvironment</a>())</td></tr>
<tr class="memdesc:a3dd6d27021bf63a2e461469449714a17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from file. <a href="classfair_1_1mq_1_1sdk_1_1DDSTopology.html#a3dd6d27021bf63a2e461469449714a17">More...</a><br /></td></tr>
<tr class="separator:a3dd6d27021bf63a2e461469449714a17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac241c7364cbe5be1981610b946343e7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSTopology.html#aac241c7364cbe5be1981610b946343e7">DDSTopology</a> (dds::topology_api::CTopology nativeTopology, <a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSEnvironment.html">DDSEnv</a> env={})</td></tr>
<tr class="memdesc:aac241c7364cbe5be1981610b946343e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct with already existing native DDS API objects. <a href="classfair_1_1mq_1_1sdk_1_1DDSTopology.html#aac241c7364cbe5be1981610b946343e7">More...</a><br /></td></tr>
<tr class="separator:aac241c7364cbe5be1981610b946343e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b3da42b8fff365b3a492c916f9c2867"><td class="memItemLeft" align="right" valign="top"><a id="a8b3da42b8fff365b3a492c916f9c2867"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSTopology.html#a8b3da42b8fff365b3a492c916f9c2867">GetEnv</a> () const -&gt; <a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSEnvironment.html">DDSEnvironment</a></td></tr>
<tr class="memdesc:a8b3da42b8fff365b3a492c916f9c2867"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get associated DDS environment. <br /></td></tr>
<tr class="separator:a8b3da42b8fff365b3a492c916f9c2867"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5c5394346bd4dd722980879146b092e"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSTopology.html#ad5c5394346bd4dd722980879146b092e">GetTopoFile</a> () const -&gt; Path</td></tr>
<tr class="memdesc:ad5c5394346bd4dd722980879146b092e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get path to DDS topology xml, if it is known. <a href="classfair_1_1mq_1_1sdk_1_1DDSTopology.html#ad5c5394346bd4dd722980879146b092e">More...</a><br /></td></tr>
<tr class="separator:ad5c5394346bd4dd722980879146b092e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7151111693b76058267c7d084276f86"><td class="memItemLeft" align="right" valign="top"><a id="ab7151111693b76058267c7d084276f86"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSTopology.html#ab7151111693b76058267c7d084276f86">GetNumRequiredAgents</a> () const -&gt; int</td></tr>
<tr class="memdesc:ab7151111693b76058267c7d084276f86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get number of required agents for this topology. <br /></td></tr>
<tr class="separator:ab7151111693b76058267c7d084276f86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fa1e51a0238c14f1a0fe1fccaa03f56"><td class="memItemLeft" align="right" valign="top"><a id="a8fa1e51a0238c14f1a0fe1fccaa03f56"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSTopology.html#a8fa1e51a0238c14f1a0fe1fccaa03f56">GetTasks</a> (const std::string &amp;=&quot;&quot;) const -&gt; std::vector&lt; <a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSTask.html">DDSTask</a> &gt;</td></tr>
<tr class="memdesc:a8fa1e51a0238c14f1a0fe1fccaa03f56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get list of tasks in this topology, optionally matching provided path. <br /></td></tr>
<tr class="separator:a8fa1e51a0238c14f1a0fe1fccaa03f56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add430aa66db65299ab95fc4da18fdee4"><td class="memItemLeft" align="right" valign="top"><a id="add430aa66db65299ab95fc4da18fdee4"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSTopology.html#add430aa66db65299ab95fc4da18fdee4">GetCollections</a> () const -&gt; std::vector&lt; <a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSCollection.html">DDSCollection</a> &gt;</td></tr>
<tr class="memdesc:add430aa66db65299ab95fc4da18fdee4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get list of tasks in this topology. <br /></td></tr>
<tr class="separator:add430aa66db65299ab95fc4da18fdee4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e475b519c2283b1c9326906d8d10906"><td class="memItemLeft" align="right" valign="top"><a id="a0e475b519c2283b1c9326906d8d10906"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSTopology.html#a0e475b519c2283b1c9326906d8d10906">GetName</a> () const -&gt; std::string</td></tr>
<tr class="memdesc:a0e475b519c2283b1c9326906d8d10906"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the topology. <br /></td></tr>
<tr class="separator:a0e475b519c2283b1c9326906d8d10906"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:af6425371a182a5891c1e0596de8c0606"><td class="memItemLeft" align="right" valign="top"><a id="af6425371a182a5891c1e0596de8c0606"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (std::ostream &amp;, const <a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSTopology.html">DDSTopology</a> &amp;) -&gt; std::ostream &amp;</td></tr>
<tr class="separator:af6425371a182a5891c1e0596de8c0606"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents a DDS topology. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3dd6d27021bf63a2e461469449714a17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3dd6d27021bf63a2e461469449714a17">&#9670;&nbsp;</a></span>DDSTopology() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">fair::mq::sdk::DDSTopology::DDSTopology </td>
<td>(</td>
<td class="paramtype">Path&#160;</td>
<td class="paramname"><em>topoFile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSEnvironment.html">DDSEnvironment</a>&#160;</td>
<td class="paramname"><em>env</em> = <code><a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSEnvironment.html">DDSEnvironment</a>()</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct from file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">topoFile</td><td>DDS topology xml file </td></tr>
<tr><td class="paramname">env</td><td>DDS environment </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aac241c7364cbe5be1981610b946343e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac241c7364cbe5be1981610b946343e7">&#9670;&nbsp;</a></span>DDSTopology() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">fair::mq::sdk::DDSTopology::DDSTopology </td>
<td>(</td>
<td class="paramtype">dds::topology_api::CTopology&#160;</td>
<td class="paramname"><em>nativeTopology</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classfair_1_1mq_1_1sdk_1_1DDSEnvironment.html">DDSEnv</a>&#160;</td>
<td class="paramname"><em>env</em> = <code>{}</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct with already existing native DDS API objects. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">nativeTopology</td><td>Existing and initialized CTopology </td></tr>
<tr><td class="paramname">env</td><td>Optional DDSEnv </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad5c5394346bd4dd722980879146b092e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5c5394346bd4dd722980879146b092e">&#9670;&nbsp;</a></span>GetTopoFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">auto fair::mq::sdk::DDSTopology::GetTopoFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const -&gt; Path</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get path to DDS topology xml, if it is known. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>fairmq/sdk/<a class="el" href="DDSTopology_8h_source.html">DDSTopology.h</a></li>
<li>fairmq/sdk/DDSTopology.cxx</li>
</ul>
</div><!-- contents -->
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
Reference in New Issue View Git Blame Copy Permalink