242 lines
13 KiB
XML
242 lines
13 KiB
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.1" xml:lang="en-US">
|
|
<compounddef id="classtf_1_1TaskView" kind="class" language="C++" prot="public">
|
|
<compoundname>tf::TaskView</compoundname>
|
|
<includes refid="task_8hpp" local="no">taskflow/core/task.hpp</includes>
|
|
<sectiondef kind="friend">
|
|
<memberdef kind="friend" id="classtf_1_1TaskView_1a763b2f90bc53f92d680a635fe28e858e" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>class</type>
|
|
<definition>friend class Executor</definition>
|
|
<argsstring></argsstring>
|
|
<name>Executor</name>
|
|
<param>
|
|
<type><ref refid="classtf_1_1Executor" kindref="compound">Executor</ref></type>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/task.hpp" line="565" column="3" bodyfile="taskflow/core/task.hpp" bodystart="565" bodyend="-1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="private-attrib">
|
|
<memberdef kind="variable" id="classtf_1_1TaskView_1a05d718be8be0374448b570276709bedb" prot="private" static="no" mutable="no">
|
|
<type>const Node &</type>
|
|
<definition>const Node& tf::TaskView::_node</definition>
|
|
<argsstring></argsstring>
|
|
<name>_node</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/task.hpp" line="621" column="16" bodyfile="taskflow/core/task.hpp" bodystart="621" bodyend="-1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="public-func">
|
|
<memberdef kind="function" id="classtf_1_1TaskView_1ac8cd58171de8ab4865e3c3f142db2db1" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
|
|
<type>const <ref refid="cpp/string/basic_string" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::string</ref> &</type>
|
|
<definition>const std::string & tf::TaskView::name</definition>
|
|
<argsstring>() const</argsstring>
|
|
<name>name</name>
|
|
<briefdescription>
|
|
<para>queries the name of the task </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/task.hpp" line="572" column="23" bodyfile="taskflow/core/task.hpp" bodystart="629" bodyend="631"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1TaskView_1aff16d269ac75cffa55a312593f20d30d" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
|
|
<type>size_t</type>
|
|
<definition>size_t tf::TaskView::num_successors</definition>
|
|
<argsstring>() const</argsstring>
|
|
<name>num_successors</name>
|
|
<briefdescription>
|
|
<para>queries the number of successors of the task </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/task.hpp" line="577" column="12" bodyfile="taskflow/core/task.hpp" bodystart="649" bodyend="651"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1TaskView_1acc4e2bef464e8fbb5706cefdf482a24f" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
|
|
<type>size_t</type>
|
|
<definition>size_t tf::TaskView::num_dependents</definition>
|
|
<argsstring>() const</argsstring>
|
|
<name>num_dependents</name>
|
|
<briefdescription>
|
|
<para>queries the number of predecessors of the task </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/task.hpp" line="582" column="12" bodyfile="taskflow/core/task.hpp" bodystart="634" bodyend="636"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1TaskView_1ac7bcb9cb1ee8f020de56fdbf8e651388" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
|
|
<type>size_t</type>
|
|
<definition>size_t tf::TaskView::num_strong_dependents</definition>
|
|
<argsstring>() const</argsstring>
|
|
<name>num_strong_dependents</name>
|
|
<briefdescription>
|
|
<para>queries the number of strong dependents of the task </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/task.hpp" line="587" column="12" bodyfile="taskflow/core/task.hpp" bodystart="639" bodyend="641"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1TaskView_1ad1ddd9a7e68a81feee1785ece99e58f5" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
|
|
<type>size_t</type>
|
|
<definition>size_t tf::TaskView::num_weak_dependents</definition>
|
|
<argsstring>() const</argsstring>
|
|
<name>num_weak_dependents</name>
|
|
<briefdescription>
|
|
<para>queries the number of weak dependents of the task </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/task.hpp" line="592" column="12" bodyfile="taskflow/core/task.hpp" bodystart="644" bodyend="646"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1TaskView_1a3cb647dc0064b5d11e0c87226c47f8f8" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename V</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>void</type>
|
|
<definition>void tf::TaskView::for_each_successor</definition>
|
|
<argsstring>(V &&visitor) const</argsstring>
|
|
<name>for_each_successor</name>
|
|
<param>
|
|
<type>V &&</type>
|
|
<declname>visitor</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>applies an visitor callable to each successor of the task </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/task.hpp" line="598" column="10" bodyfile="taskflow/core/task.hpp" bodystart="675" bodyend="679"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1TaskView_1a55651e26436bfc2499cadaca4a24e48d" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename V</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>void</type>
|
|
<definition>void tf::TaskView::for_each_dependent</definition>
|
|
<argsstring>(V &&visitor) const</argsstring>
|
|
<name>for_each_dependent</name>
|
|
<param>
|
|
<type>V &&</type>
|
|
<declname>visitor</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>applies an visitor callable to each dependents of the task </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/task.hpp" line="604" column="10" bodyfile="taskflow/core/task.hpp" bodystart="683" bodyend="687"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1TaskView_1aa20d7b5796064c3ab194e6d7ebe2adb1" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
|
|
<type><ref refid="namespacetf_1a1355048578785a80414707ff308b395a" kindref="member">TaskType</ref></type>
|
|
<definition>TaskType tf::TaskView::type</definition>
|
|
<argsstring>() const</argsstring>
|
|
<name>type</name>
|
|
<briefdescription>
|
|
<para>queries the task type </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/task.hpp" line="609" column="14" bodyfile="taskflow/core/task.hpp" bodystart="654" bodyend="666"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1TaskView_1abe95eb9e866cd7b8137d5e8ca5deace6" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
|
|
<type>size_t</type>
|
|
<definition>size_t tf::TaskView::hash_value</definition>
|
|
<argsstring>() const</argsstring>
|
|
<name>hash_value</name>
|
|
<briefdescription>
|
|
<para>obtains a hash value of the underlying node </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/task.hpp" line="614" column="12" bodyfile="taskflow/core/task.hpp" bodystart="669" bodyend="671"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="private-func">
|
|
<memberdef kind="function" id="classtf_1_1TaskView_1ad19afa391850d49513c4280439fc50ee" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
|
|
<type></type>
|
|
<definition>tf::TaskView::TaskView</definition>
|
|
<argsstring>(const Node &)</argsstring>
|
|
<name>TaskView</name>
|
|
<param>
|
|
<type>const Node &</type>
|
|
<defname>node</defname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/task.hpp" line="618" column="5" bodyfile="taskflow/core/task.hpp" bodystart="625" bodyend="626"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1TaskView_1ae85861fa894c206e800a9e5d4ee45cbf" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type></type>
|
|
<definition>tf::TaskView::TaskView</definition>
|
|
<argsstring>(const TaskView &)=default</argsstring>
|
|
<name>TaskView</name>
|
|
<param>
|
|
<type>const <ref refid="classtf_1_1TaskView" kindref="compound">TaskView</ref> &</type>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/task.hpp" line="619" column="5"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<briefdescription>
|
|
<para>class to access task information from the observer interface </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<location file="taskflow/core/task.hpp" line="563" column="1" bodyfile="taskflow/core/task.hpp" bodystart="563" bodyend="622"/>
|
|
<listofallmembers>
|
|
<member refid="classtf_1_1TaskView_1a05d718be8be0374448b570276709bedb" prot="private" virt="non-virtual"><scope>tf::TaskView</scope><name>_node</name></member>
|
|
<member refid="classtf_1_1TaskView_1a763b2f90bc53f92d680a635fe28e858e" prot="private" virt="non-virtual"><scope>tf::TaskView</scope><name>Executor</name></member>
|
|
<member refid="classtf_1_1TaskView_1a55651e26436bfc2499cadaca4a24e48d" prot="public" virt="non-virtual"><scope>tf::TaskView</scope><name>for_each_dependent</name></member>
|
|
<member refid="classtf_1_1TaskView_1a3cb647dc0064b5d11e0c87226c47f8f8" prot="public" virt="non-virtual"><scope>tf::TaskView</scope><name>for_each_successor</name></member>
|
|
<member refid="classtf_1_1TaskView_1abe95eb9e866cd7b8137d5e8ca5deace6" prot="public" virt="non-virtual"><scope>tf::TaskView</scope><name>hash_value</name></member>
|
|
<member refid="classtf_1_1TaskView_1ac8cd58171de8ab4865e3c3f142db2db1" prot="public" virt="non-virtual"><scope>tf::TaskView</scope><name>name</name></member>
|
|
<member refid="classtf_1_1TaskView_1acc4e2bef464e8fbb5706cefdf482a24f" prot="public" virt="non-virtual"><scope>tf::TaskView</scope><name>num_dependents</name></member>
|
|
<member refid="classtf_1_1TaskView_1ac7bcb9cb1ee8f020de56fdbf8e651388" prot="public" virt="non-virtual"><scope>tf::TaskView</scope><name>num_strong_dependents</name></member>
|
|
<member refid="classtf_1_1TaskView_1aff16d269ac75cffa55a312593f20d30d" prot="public" virt="non-virtual"><scope>tf::TaskView</scope><name>num_successors</name></member>
|
|
<member refid="classtf_1_1TaskView_1ad1ddd9a7e68a81feee1785ece99e58f5" prot="public" virt="non-virtual"><scope>tf::TaskView</scope><name>num_weak_dependents</name></member>
|
|
<member refid="classtf_1_1TaskView_1ad19afa391850d49513c4280439fc50ee" prot="private" virt="non-virtual"><scope>tf::TaskView</scope><name>TaskView</name></member>
|
|
<member refid="classtf_1_1TaskView_1ae85861fa894c206e800a9e5d4ee45cbf" prot="private" virt="non-virtual"><scope>tf::TaskView</scope><name>TaskView</name></member>
|
|
<member refid="classtf_1_1TaskView_1aa20d7b5796064c3ab194e6d7ebe2adb1" prot="public" virt="non-virtual"><scope>tf::TaskView</scope><name>type</name></member>
|
|
</listofallmembers>
|
|
</compounddef>
|
|
</doxygen>
|