Metahuman_DNA_Calibration/docs/doxygen/build/xml/classdnac_1_1RemoveJointCommand.xml

<?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.9.4" xml:lang="en-US">
  <compounddef id="classdnac_1_1RemoveJointCommand" kind="class" language="C++" prot="public">
    <compoundname>dnac::RemoveJointCommand</compoundname>
    <basecompoundref refid="classdnac_1_1Command" prot="public" virt="non-virtual">dnac::Command</basecompoundref>
    <includes refid="RemoveJointCommand_8h" local="no">RemoveJointCommand.h</includes>
    <innerclass refid="classdnac_1_1RemoveJointCommand_1_1Impl" prot="public">dnac::RemoveJointCommand::Impl</innerclass>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classdnac_1_1RemoveJointCommand_1ac214810ee65523bf323f84e99d3ff600" prot="private" static="no" mutable="no">
        <type><ref refid="classpma_1_1ScopedPtr" kindref="compound">ScopedPtr</ref>&lt; <ref refid="classdnac_1_1RemoveJointCommand_1_1Impl" kindref="compound">Impl</ref> &gt;</type>
        <definition>ScopedPtr&lt;Impl&gt; dnac::RemoveJointCommand::pImpl</definition>
        <argsstring></argsstring>
        <name>pImpl</name>
        <qualifiedname>dnac::RemoveJointCommand::pImpl</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/RemoveJointCommand.h" line="41" column="19" bodyfile="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/RemoveJointCommand.h" bodystart="41" bodyend="-1"/>
        <referencedby refid="classdnac_1_1RemoveJointCommand_1a9c09b3455bd03440fb5f2ea9673da59b" compoundref="RemoveJointCommand_8cpp" startline="38" endline="42">RemoveJointCommand</referencedby>
        <referencedby refid="classdnac_1_1RemoveJointCommand_1ad6739f4b570e0703123de4cc25ef23ae" compoundref="RemoveJointCommand_8cpp" startline="52" endline="54">run</referencedby>
        <referencedby refid="classdnac_1_1RemoveJointCommand_1a173f7f4e6eb7eb8e15b12dca57115cd0" compoundref="RemoveJointCommand_8cpp" startline="48" endline="50">setJointIndex</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classdnac_1_1RemoveJointCommand_1aafcfe032a3fc5eea9f5d444cf6d9a247" prot="public" static="no" const="no" explicit="yes" inline="no" virt="non-virtual">
        <type><ref refid="dnacalib_2Defs_8h_1a582ed0de52e12122ce3c978581df8113" kindref="member">DNACAPI</ref></type>
        <definition>dnac::RemoveJointCommand::RemoveJointCommand</definition>
        <argsstring>(MemoryResource *memRes=nullptr)</argsstring>
        <name>RemoveJointCommand</name>
        <qualifiedname>dnac::RemoveJointCommand::RemoveJointCommand</qualifiedname>
        <param>
          <type><ref refid="classpma_1_1MemoryResource" kindref="compound">MemoryResource</ref> *</type>
          <declname>memRes</declname>
          <defval>nullptr</defval>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/RemoveJointCommand.h" line="20" column="26" bodyfile="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/src/dnacalib/commands/RemoveJointCommand.cpp" bodystart="35" bodyend="36"/>
      </memberdef>
      <memberdef kind="function" id="classdnac_1_1RemoveJointCommand_1a9c09b3455bd03440fb5f2ea9673da59b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="dnacalib_2Defs_8h_1a582ed0de52e12122ce3c978581df8113" kindref="member">DNACAPI</ref></type>
        <definition>dnac::RemoveJointCommand::RemoveJointCommand</definition>
        <argsstring>(std::uint16_t jointIndex, MemoryResource *memRes=nullptr)</argsstring>
        <name>RemoveJointCommand</name>
        <qualifiedname>dnac::RemoveJointCommand::RemoveJointCommand</qualifiedname>
        <param>
          <type>std::uint16_t</type>
          <declname>jointIndex</declname>
        </param>
        <param>
          <type><ref refid="classpma_1_1MemoryResource" kindref="compound">MemoryResource</ref> *</type>
          <declname>memRes</declname>
          <defval>nullptr</defval>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/RemoveJointCommand.h" line="21" column="17" bodyfile="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/src/dnacalib/commands/RemoveJointCommand.cpp" bodystart="38" bodyend="42"/>
        <references refid="classdnac_1_1RemoveJointCommand_1ac214810ee65523bf323f84e99d3ff600" compoundref="RemoveJointCommand_8h" startline="41">pImpl</references>
      </memberdef>
      <memberdef kind="function" id="classdnac_1_1RemoveJointCommand_1a30ad4b9a2126b1bc80be69dd58de37cf" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="dnacalib_2Defs_8h_1a582ed0de52e12122ce3c978581df8113" kindref="member">DNACAPI</ref></type>
        <definition>dnac::RemoveJointCommand::~RemoveJointCommand</definition>
        <argsstring>()</argsstring>
        <name>~RemoveJointCommand</name>
        <qualifiedname>dnac::RemoveJointCommand::~RemoveJointCommand</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/RemoveJointCommand.h" line="23" column="17"/>
      </memberdef>
      <memberdef kind="function" id="classdnac_1_1RemoveJointCommand_1ab7ab91a3af90d995341caf7a365e8949" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>dnac::RemoveJointCommand::RemoveJointCommand</definition>
        <argsstring>(const RemoveJointCommand &amp;)=delete</argsstring>
        <name>RemoveJointCommand</name>
        <qualifiedname>dnac::RemoveJointCommand::RemoveJointCommand</qualifiedname>
        <param>
          <type>const <ref refid="classdnac_1_1RemoveJointCommand" kindref="compound">RemoveJointCommand</ref> &amp;</type>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/RemoveJointCommand.h" line="25" column="9"/>
      </memberdef>
      <memberdef kind="function" id="classdnac_1_1RemoveJointCommand_1a8c2a44fe02ab0cd68ce2a00abda0b2e9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classdnac_1_1RemoveJointCommand" kindref="compound">RemoveJointCommand</ref> &amp;</type>
        <definition>RemoveJointCommand &amp; dnac::RemoveJointCommand::operator=</definition>
        <argsstring>(const RemoveJointCommand &amp;)=delete</argsstring>
        <name>operator=</name>
        <qualifiedname>dnac::RemoveJointCommand::operator=</qualifiedname>
        <param>
          <type>const <ref refid="classdnac_1_1RemoveJointCommand" kindref="compound">RemoveJointCommand</ref> &amp;</type>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/RemoveJointCommand.h" line="26" column="28"/>
      </memberdef>
      <memberdef kind="function" id="classdnac_1_1RemoveJointCommand_1a9e1095219dadde92870a1604ebec38e4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="dnacalib_2Defs_8h_1a582ed0de52e12122ce3c978581df8113" kindref="member">DNACAPI</ref></type>
        <definition>dnac::RemoveJointCommand::RemoveJointCommand</definition>
        <argsstring>(RemoveJointCommand &amp;&amp;)</argsstring>
        <name>RemoveJointCommand</name>
        <qualifiedname>dnac::RemoveJointCommand::RemoveJointCommand</qualifiedname>
        <param>
          <type><ref refid="classdnac_1_1RemoveJointCommand" kindref="compound">RemoveJointCommand</ref> &amp;&amp;</type>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/RemoveJointCommand.h" line="28" column="17"/>
      </memberdef>
      <memberdef kind="function" id="classdnac_1_1RemoveJointCommand_1a3b625a593e76d3e66eb541d87e38b1a9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="dnacalib_2Defs_8h_1a582ed0de52e12122ce3c978581df8113" kindref="member">DNACAPI</ref> <ref refid="classdnac_1_1RemoveJointCommand" kindref="compound">RemoveJointCommand</ref> &amp;</type>
        <definition>RemoveJointCommand &amp; dnac::RemoveJointCommand::operator=</definition>
        <argsstring>(RemoveJointCommand &amp;&amp;)</argsstring>
        <name>operator=</name>
        <qualifiedname>dnac::RemoveJointCommand::operator=</qualifiedname>
        <param>
          <type><ref refid="classdnac_1_1RemoveJointCommand" kindref="compound">RemoveJointCommand</ref> &amp;&amp;</type>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/RemoveJointCommand.h" line="29" column="36"/>
      </memberdef>
      <memberdef kind="function" id="classdnac_1_1RemoveJointCommand_1a173f7f4e6eb7eb8e15b12dca57115cd0" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="dnacalib_2Defs_8h_1a582ed0de52e12122ce3c978581df8113" kindref="member">DNACAPI</ref> void</type>
        <definition>void dnac::RemoveJointCommand::setJointIndex</definition>
        <argsstring>(std::uint16_t jointIndex)</argsstring>
        <name>setJointIndex</name>
        <qualifiedname>dnac::RemoveJointCommand::setJointIndex</qualifiedname>
        <param>
          <type>std::uint16_t</type>
          <declname>jointIndex</declname>
        </param>
        <briefdescription>
<para>Method for setting the index of the joint to remove. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>jointIndex</parametername>
</parameternamelist>
<parameterdescription>
<para>The index of the joint. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/RemoveJointCommand.h" line="36" column="22" bodyfile="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/src/dnacalib/commands/RemoveJointCommand.cpp" bodystart="48" bodyend="50"/>
        <references refid="classdnac_1_1RemoveJointCommand_1ac214810ee65523bf323f84e99d3ff600" compoundref="RemoveJointCommand_8h" startline="41">pImpl</references>
      </memberdef>
      <memberdef kind="function" id="classdnac_1_1RemoveJointCommand_1ad6739f4b570e0703123de4cc25ef23ae" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type><ref refid="dnacalib_2Defs_8h_1a582ed0de52e12122ce3c978581df8113" kindref="member">DNACAPI</ref> void</type>
        <definition>void dnac::RemoveJointCommand::run</definition>
        <argsstring>(DNACalibDNAReader *output) override</argsstring>
        <name>run</name>
        <qualifiedname>dnac::RemoveJointCommand::run</qualifiedname>
        <reimplements refid="classdnac_1_1Command_1a204ca2536a334f4eb83c66e09ef3ecee">run</reimplements>
        <param>
          <type><ref refid="classdnac_1_1DNACalibDNAReader" kindref="compound">DNACalibDNAReader</ref> *</type>
          <declname>output</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/RemoveJointCommand.h" line="37" column="22" bodyfile="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/src/dnacalib/commands/RemoveJointCommand.cpp" bodystart="52" bodyend="54"/>
        <references refid="classdnac_1_1RemoveJointCommand_1ac214810ee65523bf323f84e99d3ff600" compoundref="RemoveJointCommand_8h" startline="41">pImpl</references>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para><ref refid="classdnac_1_1RemoveJointCommand" kindref="compound">RemoveJointCommand</ref> is used to remove a joint. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="2">
        <label>dnac::Command</label>
        <link refid="classdnac_1_1Command"/>
      </node>
      <node id="1">
        <label>dnac::RemoveJointCommand</label>
        <link refid="classdnac_1_1RemoveJointCommand"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="3">
        <label>pma::ScopedPtr&lt; dnac::RemoveJointCommand::Impl &gt;</label>
        <link refid="classpma_1_1ScopedPtr"/>
        <childnode refid="4" relation="private-inheritance">
        </childnode>
        <childnode refid="5" relation="usage">
          <edgelabel>-ptr</edgelabel>
        </childnode>
        <childnode refid="7" relation="template-instance">
          <edgelabel>&lt; dnac::RemoveJointCommand::Impl &gt;</edgelabel>
        </childnode>
      </node>
      <node id="2">
        <label>dnac::Command</label>
        <link refid="classdnac_1_1Command"/>
      </node>
      <node id="1">
        <label>dnac::RemoveJointCommand</label>
        <link refid="classdnac_1_1RemoveJointCommand"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
        <childnode refid="3" relation="usage">
          <edgelabel>-pImpl</edgelabel>
        </childnode>
      </node>
      <node id="9">
        <label>pma::ScopedPtr&lt; T, TDestroyer &gt;::inspect&lt; T &gt;</label>
        <link refid="structpma_1_1ScopedPtr_1_1inspect"/>
        <childnode refid="6" relation="template-instance">
          <edgelabel>&lt; T &gt;</edgelabel>
        </childnode>
      </node>
      <node id="5">
        <label>pma::ScopedPtr&lt; T, TDestroyer &gt;::inspect&lt; dnac::RemoveJointCommand::Impl &gt;</label>
        <link refid="structpma_1_1ScopedPtr_1_1inspect"/>
        <childnode refid="6" relation="template-instance">
          <edgelabel>&lt; dnac::RemoveJointCommand::Impl &gt;</edgelabel>
        </childnode>
      </node>
      <node id="7">
        <label>pma::ScopedPtr&lt; T, TDestroyer &gt;</label>
        <link refid="classpma_1_1ScopedPtr"/>
        <childnode refid="8" relation="private-inheritance">
        </childnode>
        <childnode refid="9" relation="usage">
          <edgelabel>-ptr</edgelabel>
        </childnode>
      </node>
      <node id="6">
        <label>pma::ScopedPtr&lt; T, TDestroyer &gt;::inspect&lt; U &gt;</label>
        <link refid="structpma_1_1ScopedPtr_1_1inspect"/>
      </node>
      <node id="8">
        <label>typename DefaultInstanceDestroyer&lt;T&gt;::type</label>
      </node>
      <node id="4">
        <label>typename DefaultInstanceDestroyer&lt;dnac::RemoveJointCommand::Impl &gt;::type</label>
      </node>
    </collaborationgraph>
    <location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/RemoveJointCommand.h" line="18" column="1" bodyfile="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/RemoveJointCommand.h" bodystart="18" bodyend="43"/>
    <listofallmembers>
      <member refid="classdnac_1_1RemoveJointCommand_1a8c2a44fe02ab0cd68ce2a00abda0b2e9" prot="public" virt="non-virtual"><scope>dnac::RemoveJointCommand</scope><name>operator=</name></member>
      <member refid="classdnac_1_1RemoveJointCommand_1a3b625a593e76d3e66eb541d87e38b1a9" prot="public" virt="non-virtual"><scope>dnac::RemoveJointCommand</scope><name>operator=</name></member>
      <member refid="classdnac_1_1RemoveJointCommand_1ac214810ee65523bf323f84e99d3ff600" prot="private" virt="non-virtual"><scope>dnac::RemoveJointCommand</scope><name>pImpl</name></member>
      <member refid="classdnac_1_1RemoveJointCommand_1aafcfe032a3fc5eea9f5d444cf6d9a247" prot="public" virt="non-virtual"><scope>dnac::RemoveJointCommand</scope><name>RemoveJointCommand</name></member>
      <member refid="classdnac_1_1RemoveJointCommand_1a9c09b3455bd03440fb5f2ea9673da59b" prot="public" virt="non-virtual"><scope>dnac::RemoveJointCommand</scope><name>RemoveJointCommand</name></member>
      <member refid="classdnac_1_1RemoveJointCommand_1ab7ab91a3af90d995341caf7a365e8949" prot="public" virt="non-virtual"><scope>dnac::RemoveJointCommand</scope><name>RemoveJointCommand</name></member>
      <member refid="classdnac_1_1RemoveJointCommand_1a9e1095219dadde92870a1604ebec38e4" prot="public" virt="non-virtual"><scope>dnac::RemoveJointCommand</scope><name>RemoveJointCommand</name></member>
      <member refid="classdnac_1_1RemoveJointCommand_1ad6739f4b570e0703123de4cc25ef23ae" prot="public" virt="virtual"><scope>dnac::RemoveJointCommand</scope><name>run</name></member>
      <member refid="classdnac_1_1RemoveJointCommand_1a173f7f4e6eb7eb8e15b12dca57115cd0" prot="public" virt="non-virtual"><scope>dnac::RemoveJointCommand</scope><name>setJointIndex</name></member>
      <member refid="classdnac_1_1Command_1a61be18c56cbef51019c8f7b1f752518c" prot="public" virt="virtual"><scope>dnac::RemoveJointCommand</scope><name>~Command</name></member>
      <member refid="classdnac_1_1RemoveJointCommand_1a30ad4b9a2126b1bc80be69dd58de37cf" prot="public" virt="non-virtual"><scope>dnac::RemoveJointCommand</scope><name>~RemoveJointCommand</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>