<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.14">
  <compounddef id="classCisOutput" kind="class" language="C++" prot="public">
    <compoundname>CisOutput</compoundname>
    <derivedcompoundref refid="classCisAsciiFileOutput" prot="public" virt="non-virtual">CisAsciiFileOutput</derivedcompoundref>
    <derivedcompoundref refid="classCisObjOutput" prot="public" virt="non-virtual">CisObjOutput</derivedcompoundref>
    <derivedcompoundref refid="classCisPlyOutput" prot="public" virt="non-virtual">CisPlyOutput</derivedcompoundref>
    <includes refid="CisInterface_8hpp" local="no">CisInterface.hpp</includes>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classCisOutput_1aeaa19426ff87e34bf3761ca6b351e8a0" prot="private" static="no" mutable="no">
        <type>cisOutput_t</type>
        <definition>cisOutput_t CisOutput::_pi</definition>
        <argsstring></argsstring>
        <name>_pi</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="139" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="139" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classCisOutput_1acbe5281010e3dd4617006a03d9c6c06c" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>CisOutput::CisOutput</definition>
        <argsstring>(const char *name)</argsstring>
        <name>CisOutput</name>
        <param>
          <type>const char *</type>
          <declname>name</declname>
        </param>
        <briefdescription>
<para>Constructor for <ref refid="classCisOutput" kindref="compound">CisOutput</ref>. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">name</parametername>
</parameternamelist>
<parameterdescription>
<para>constant character pointer to name of output queue. This should be the argument to an output driver in the yaml specification file. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="147" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="147" bodyend="147"/>
      </memberdef>
      <memberdef kind="function" id="classCisOutput_1a276eaee68d97cba54726752784d6c4df" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>CisOutput::CisOutput</definition>
        <argsstring>(const char *name, const char *fmt)</argsstring>
        <name>CisOutput</name>
        <param>
          <type>const char *</type>
          <declname>name</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>fmt</declname>
        </param>
        <briefdescription>
<para>Constructor for <ref refid="classCisOutput" kindref="compound">CisOutput</ref> with format. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">name</parametername>
</parameternamelist>
<parameterdescription>
<para>constant character pointer to name of output queue. This should be the argument to an output driver in the yaml specification file. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">fmt</parametername>
</parameternamelist>
<parameterdescription>
<para>character pointer to format string for formatting variables. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="155" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="155" bodyend="155"/>
      </memberdef>
      <memberdef kind="function" id="classCisOutput_1abf373bf8e55beb4b32d558463b134a51" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>CisOutput::CisOutput</definition>
        <argsstring>(cisOutput_t x)</argsstring>
        <name>CisOutput</name>
        <param>
          <type>cisOutput_t</type>
          <declname>x</declname>
        </param>
        <briefdescription>
<para>Empty constructor for inheritance. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="158" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="158" bodyend="158"/>
      </memberdef>
      <memberdef kind="function" id="classCisOutput_1af977def262b778702e06277f5d50f102" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>void</type>
        <definition>void CisOutput::_destroy_pi</definition>
        <argsstring>()</argsstring>
        <name>_destroy_pi</name>
        <briefdescription>
<para>Alias to allow freeing of underlying C struct at the class level. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="163" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="163" bodyend="163"/>
      </memberdef>
      <memberdef kind="function" id="classCisOutput_1a7dc7c92d8c50f61075d1ef0cf0dfce8f" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>CisOutput::~CisOutput</definition>
        <argsstring>()</argsstring>
        <name>~CisOutput</name>
        <briefdescription>
<para>Destructor for <ref refid="classCisOutput" kindref="compound">CisOutput</ref>. See cis_free in <ref refid="CisInterface_8h_source" kindref="compound">CisInterface.h</ref> for details. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="169" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="169" bodyend="169"/>
      </memberdef>
      <memberdef kind="function" id="classCisOutput_1a173ffd20bb1ce255ba95562caa220d6a" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>cisOutput_t</type>
        <definition>cisOutput_t CisOutput::pi</definition>
        <argsstring>()</argsstring>
        <name>pi</name>
        <briefdescription>
<para>Return the cisOutput_t structure. </para>        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>cisOutput_t structure underlying the class. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="175" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="175" bodyend="177"/>
      </memberdef>
      <memberdef kind="function" id="classCisOutput_1a38322e95e9743e4b5b5d4c529d13031e" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>int</type>
        <definition>int CisOutput::send</definition>
        <argsstring>(const char *data, const size_t len)</argsstring>
        <name>send</name>
        <param>
          <type>const char *</type>
          <declname>data</declname>
        </param>
        <param>
          <type>const size_t</type>
          <declname>len</declname>
        </param>
        <briefdescription>
<para>Send a message smaller than CIS_MSG_MAX to the output queue. If the message is larger than CIS_MSG_MAX an error code will be returned. See cis_send in <ref refid="CisInterface_8h_source" kindref="compound">CisInterface.h</ref> for details. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">data</parametername>
</parameternamelist>
<parameterdescription>
<para>character pointer to message that should be sent. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">len</parametername>
</parameternamelist>
<parameterdescription>
<para>size_t length of message to be sent. </para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>int 0 if send succesfull, -1 if send unsuccessful. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="187" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="187" bodyend="189"/>
      </memberdef>
      <memberdef kind="function" id="classCisOutput_1ad30d4a8e64e7a9b7033cddf4a3aef9de" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>int</type>
        <definition>int CisOutput::send</definition>
        <argsstring>(const int nargs,...)</argsstring>
        <name>send</name>
        <param>
          <type>const int</type>
          <declname>nargs</declname>
        </param>
        <param>
          <type>...</type>
        </param>
        <briefdescription>
<para>Format and send a message smaller than CIS_MSG_MAX to the output queue. See cisSend from <ref refid="CisInterface_8h_source" kindref="compound">CisInterface.h</ref> for details. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">nargs</parametername>
</parameternamelist>
<parameterdescription>
<para>int Number of arguments being passed. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">...</parametername>
</parameternamelist>
<parameterdescription>
<para>arguments for formatting. <linebreak/>
</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>integer specifying if the send was succesful. Values &gt;= 0 indicate success. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="199" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="199" bodyend="210"/>
      </memberdef>
      <memberdef kind="function" id="classCisOutput_1a794b0e4d24de72339faab690554db4d3" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>int</type>
        <definition>int CisOutput::send_nolimit</definition>
        <argsstring>(const char *data, const size_t len)</argsstring>
        <name>send_nolimit</name>
        <param>
          <type>const char *</type>
          <declname>data</declname>
        </param>
        <param>
          <type>const size_t</type>
          <declname>len</declname>
        </param>
        <briefdescription>
<para>Send a message larger than CIS_MSG_MAX to the output queue. See cis_send_nolimit in <ref refid="CisInterface_8h_source" kindref="compound">CisInterface.h</ref> for details. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">data</parametername>
</parameternamelist>
<parameterdescription>
<para>character pointer to message that should be sent. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">len</parametername>
</parameternamelist>
<parameterdescription>
<para>size_t length of message to be sent. </para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>int 0 if send succesfull, -1 if send unsuccessful. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="219" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="219" bodyend="221"/>
      </memberdef>
      <memberdef kind="function" id="classCisOutput_1a5b7e84b70352f3a5f99650184a076564" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>int</type>
        <definition>int CisOutput::send_nolimit</definition>
        <argsstring>(const int nargs,...)</argsstring>
        <name>send_nolimit</name>
        <param>
          <type>const int</type>
          <declname>nargs</declname>
        </param>
        <param>
          <type>...</type>
        </param>
        <briefdescription>
<para>Format and send a message larger than CIS_MSG_MAX to the output queue. See cisSend from <ref refid="CisInterface_8h_source" kindref="compound">CisInterface.h</ref> for details. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">nargs</parametername>
</parameternamelist>
<parameterdescription>
<para>int Number of arguments being passed. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">...</parametername>
</parameternamelist>
<parameterdescription>
<para>arguments for formatting. <linebreak/>
</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>integer specifying if the send was succesful. Values &gt;= 0 indicate success. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="231" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="231" bodyend="242"/>
      </memberdef>
      <memberdef kind="function" id="classCisOutput_1a083fb17afbb3c03f103929850506e545" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>int</type>
        <definition>int CisOutput::send_eof</definition>
        <argsstring>()</argsstring>
        <name>send_eof</name>
        <briefdescription>
<para>Send EOF message to output file, closing it. </para>        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>int 0 if send was succesfull. All other values indicate errors. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="248" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="248" bodyend="248"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>C++ interface to cisOutput_t functionality. </para>    </briefdescription>
    <detaileddescription>
<para>The <ref refid="classCisOutput" kindref="compound">CisOutput</ref> class is a basic wrapper around the C cisOutput_t structure and associated functions from the <ref refid="CisInterface_8h_source" kindref="compound">CisInterface.h</ref> header. It provides the user with C++ style access to basic output via an IPC queue. </para>    </detaileddescription>
    <inheritancegraph>
      <node id="108">
        <label>CisObjOutput</label>
        <link refid="classCisObjOutput"/>
        <childnode refid="101" relation="public-inheritance">
        </childnode>
      </node>
      <node id="109">
        <label>CisPlyOutput</label>
        <link refid="classCisPlyOutput"/>
        <childnode refid="101" relation="public-inheritance">
        </childnode>
      </node>
      <node id="102">
        <label>CisAsciiFileOutput</label>
        <link refid="classCisAsciiFileOutput"/>
        <childnode refid="101" relation="public-inheritance">
        </childnode>
      </node>
      <node id="105">
        <label>CisAsciiFileOutput_local</label>
        <link refid="classCisAsciiFileOutput__local"/>
        <childnode refid="102" relation="public-inheritance">
        </childnode>
      </node>
      <node id="106">
        <label>CisAsciiTableOutput</label>
        <link refid="classCisAsciiTableOutput"/>
        <childnode refid="102" relation="public-inheritance">
        </childnode>
      </node>
      <node id="103">
        <label>CisAsciiArrayOutput</label>
        <link refid="classCisAsciiArrayOutput"/>
        <childnode refid="102" relation="public-inheritance">
        </childnode>
      </node>
      <node id="101">
        <label>CisOutput</label>
        <link refid="classCisOutput"/>
      </node>
      <node id="104">
        <label>CisAsciiArrayOutput_local</label>
        <link refid="classCisAsciiArrayOutput__local"/>
        <childnode refid="102" relation="public-inheritance">
        </childnode>
      </node>
      <node id="107">
        <label>CisAsciiTableOutput_local</label>
        <link refid="classCisAsciiTableOutput__local"/>
        <childnode refid="102" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="138" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="138" bodyend="249"/>
    <listofallmembers>
      <member refid="classCisOutput_1af977def262b778702e06277f5d50f102" prot="public" virt="non-virtual"><scope>CisOutput</scope><name>_destroy_pi</name></member>
      <member refid="classCisOutput_1aeaa19426ff87e34bf3761ca6b351e8a0" prot="private" virt="non-virtual"><scope>CisOutput</scope><name>_pi</name></member>
      <member refid="classCisOutput_1acbe5281010e3dd4617006a03d9c6c06c" prot="public" virt="non-virtual"><scope>CisOutput</scope><name>CisOutput</name></member>
      <member refid="classCisOutput_1a276eaee68d97cba54726752784d6c4df" prot="public" virt="non-virtual"><scope>CisOutput</scope><name>CisOutput</name></member>
      <member refid="classCisOutput_1abf373bf8e55beb4b32d558463b134a51" prot="public" virt="non-virtual"><scope>CisOutput</scope><name>CisOutput</name></member>
      <member refid="classCisOutput_1a173ffd20bb1ce255ba95562caa220d6a" prot="public" virt="non-virtual"><scope>CisOutput</scope><name>pi</name></member>
      <member refid="classCisOutput_1a38322e95e9743e4b5b5d4c529d13031e" prot="public" virt="non-virtual"><scope>CisOutput</scope><name>send</name></member>
      <member refid="classCisOutput_1ad30d4a8e64e7a9b7033cddf4a3aef9de" prot="public" virt="non-virtual"><scope>CisOutput</scope><name>send</name></member>
      <member refid="classCisOutput_1a083fb17afbb3c03f103929850506e545" prot="public" virt="non-virtual"><scope>CisOutput</scope><name>send_eof</name></member>
      <member refid="classCisOutput_1a794b0e4d24de72339faab690554db4d3" prot="public" virt="non-virtual"><scope>CisOutput</scope><name>send_nolimit</name></member>
      <member refid="classCisOutput_1a5b7e84b70352f3a5f99650184a076564" prot="public" virt="non-virtual"><scope>CisOutput</scope><name>send_nolimit</name></member>
      <member refid="classCisOutput_1a7dc7c92d8c50f61075d1ef0cf0dfce8f" prot="public" virt="non-virtual"><scope>CisOutput</scope><name>~CisOutput</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
