195 lines
9.6 KiB
XML
195 lines
9.6 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.4" xml:lang="en-US">
|
|
<compounddef id="classtrio_1_1Readable" kind="class" language="C++" prot="public" abstract="yes">
|
|
<compoundname>trio::Readable</compoundname>
|
|
<derivedcompoundref refid="classtrio_1_1BoundedIOStream" prot="public" virt="non-virtual">trio::BoundedIOStream</derivedcompoundref>
|
|
<derivedcompoundref refid="classtrio_1_1anonymous__namespace_02MemoryStreamImpl_8cpp_03_1_1MemoryReader" prot="public" virt="non-virtual">trio::anonymous_namespace{MemoryStreamImpl.cpp}::MemoryReader</derivedcompoundref>
|
|
<includes refid="Concepts_8h" local="no">Concepts.h</includes>
|
|
<sectiondef kind="public-func">
|
|
<memberdef kind="function" id="classtrio_1_1Readable_1a134ad61b17c812f7aa2d912fc96d36f9" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
|
|
<type>std::size_t</type>
|
|
<definition>virtual std::size_t trio::Readable::read</definition>
|
|
<argsstring>(char *destination, std::size_t size)=0</argsstring>
|
|
<name>read</name>
|
|
<qualifiedname>trio::Readable::read</qualifiedname>
|
|
<reimplementedby refid="classtrio_1_1FileStreamImpl_1abf0a546ad27b383f94b94e58a9210845">read</reimplementedby>
|
|
<reimplementedby refid="classtrio_1_1MemoryMappedFileStreamFallback_1a864b9b75d23fe1ba0ea258b373bdddd2">read</reimplementedby>
|
|
<reimplementedby refid="classtrio_1_1anonymous__namespace_02MemoryStreamImpl_8cpp_03_1_1MemoryReader_1a38427a9a781125a6561b3028fe6ecde5">read</reimplementedby>
|
|
<reimplementedby refid="classtrio_1_1MemoryStreamImpl_1a4f661e5c8c728e64bef2b19f5e16cfa9">read</reimplementedby>
|
|
<param>
|
|
<type>char *</type>
|
|
<declname>destination</declname>
|
|
</param>
|
|
<param>
|
|
<type>std::size_t</type>
|
|
<declname>size</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Read bytes from stream into the given buffer. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para><parameterlist kind="param"><parameteritem>
|
|
<parameternamelist>
|
|
<parametername>destination</parametername>
|
|
</parameternamelist>
|
|
<parameterdescription>
|
|
<para>Destination buffer into which the data is going to be read from the stream. </para>
|
|
</parameterdescription>
|
|
</parameteritem>
|
|
<parameteritem>
|
|
<parameternamelist>
|
|
<parametername>size</parametername>
|
|
</parameternamelist>
|
|
<parameterdescription>
|
|
<para>Number of bytes to read from stream. </para>
|
|
</parameterdescription>
|
|
</parameteritem>
|
|
</parameterlist>
|
|
<simplesect kind="return"><para>Number of bytes read. </para>
|
|
</simplesect>
|
|
</para>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="C:/source/MetaHuman-DNA-Calibration/dnacalib/DNACalib/include/trio/Concepts.h" line="25" column="29"/>
|
|
<referencedby refid="classtrio_1_1FileStreamImpl_1a876dfedc5ad235e338e53b6ab80d087d" compoundref="FileStreamImpl_8cpp" startline="172" endline="198">trio::FileStreamImpl::write</referencedby>
|
|
<referencedby refid="classtrio_1_1anonymous__namespace_02MemoryStreamImpl_8cpp_03_1_1MemoryWriter_1a9c1479f6c1a5db074cd8a280f03afab5" compoundref="MemoryStreamImpl_8cpp" startline="55" endline="59">trio::anonymous_namespace{MemoryStreamImpl.cpp}::MemoryWriter::write</referencedby>
|
|
<referencedby refid="classtrio_1_1MemoryStreamImpl_1ac83e4c44edeca8b430aec1fe554fc350" compoundref="MemoryStreamImpl_8cpp" startline="151" endline="169">trio::MemoryStreamImpl::write</referencedby>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtrio_1_1Readable_1ae7272a2547bb33c20c9b37493491c6c1" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
|
|
<type>std::size_t</type>
|
|
<definition>virtual std::size_t trio::Readable::read</definition>
|
|
<argsstring>(Writable *destination, std::size_t size)=0</argsstring>
|
|
<name>read</name>
|
|
<qualifiedname>trio::Readable::read</qualifiedname>
|
|
<reimplementedby refid="classtrio_1_1FileStreamImpl_1a6ea1c44150f144f5b632d4c32f62f08c">read</reimplementedby>
|
|
<reimplementedby refid="classtrio_1_1MemoryMappedFileStreamFallback_1a4d270f7f74be83be888cb550f71de656">read</reimplementedby>
|
|
<reimplementedby refid="classtrio_1_1anonymous__namespace_02MemoryStreamImpl_8cpp_03_1_1MemoryReader_1a4d05920810106ba6bc9e22ab23b7f939">read</reimplementedby>
|
|
<reimplementedby refid="classtrio_1_1MemoryStreamImpl_1a1b9085ee7ff1210ca46142414cadbedc">read</reimplementedby>
|
|
<param>
|
|
<type><ref refid="classtrio_1_1Writable" kindref="compound">Writable</ref> *</type>
|
|
<declname>destination</declname>
|
|
</param>
|
|
<param>
|
|
<type>std::size_t</type>
|
|
<declname>size</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Read bytes from this stream into the given stream. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para><parameterlist kind="param"><parameteritem>
|
|
<parameternamelist>
|
|
<parametername>destination</parametername>
|
|
</parameternamelist>
|
|
<parameterdescription>
|
|
<para>Destination stream into which the data is going to be read from this stream. </para>
|
|
</parameterdescription>
|
|
</parameteritem>
|
|
<parameteritem>
|
|
<parameternamelist>
|
|
<parametername>size</parametername>
|
|
</parameternamelist>
|
|
<parameterdescription>
|
|
<para>Number of bytes to read from stream. </para>
|
|
</parameterdescription>
|
|
</parameteritem>
|
|
</parameterlist>
|
|
<simplesect kind="return"><para>Number of bytes read. </para>
|
|
</simplesect>
|
|
</para>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="C:/source/MetaHuman-DNA-Calibration/dnacalib/DNACalib/include/trio/Concepts.h" line="35" column="29"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="protected-func">
|
|
<memberdef kind="function" id="classtrio_1_1Readable_1a49421a76a150a17207dc2d896d73d7a7" prot="protected" static="no" const="no" explicit="no" inline="no" virt="virtual">
|
|
<type></type>
|
|
<definition>trio::Readable::~Readable</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>~Readable</name>
|
|
<qualifiedname>trio::Readable::~Readable</qualifiedname>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="C:/source/MetaHuman-DNA-Calibration/dnacalib/DNACalib/include/trio/Concepts.h" line="38" column="17"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inheritancegraph>
|
|
<node id="2">
|
|
<label>trio::BoundedIOStream</label>
|
|
<link refid="classtrio_1_1BoundedIOStream"/>
|
|
<childnode refid="1" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
<node id="3">
|
|
<label>trio::FileStream</label>
|
|
<link refid="classtrio_1_1FileStream"/>
|
|
<childnode refid="2" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
<node id="4">
|
|
<label>trio::FileStreamImpl</label>
|
|
<link refid="classtrio_1_1FileStreamImpl"/>
|
|
<childnode refid="3" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
<node id="5">
|
|
<label>trio::MemoryMappedFileStream</label>
|
|
<link refid="classtrio_1_1MemoryMappedFileStream"/>
|
|
<childnode refid="2" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
<node id="6">
|
|
<label>trio::MemoryMappedFileStreamFallback</label>
|
|
<link refid="classtrio_1_1MemoryMappedFileStreamFallback"/>
|
|
<childnode refid="5" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
<node id="7">
|
|
<label>trio::MemoryStream</label>
|
|
<link refid="classtrio_1_1MemoryStream"/>
|
|
<childnode refid="2" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
<node id="8">
|
|
<label>trio::MemoryStreamImpl</label>
|
|
<link refid="classtrio_1_1MemoryStreamImpl"/>
|
|
<childnode refid="7" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
<node id="1">
|
|
<label>trio::Readable</label>
|
|
<link refid="classtrio_1_1Readable"/>
|
|
</node>
|
|
<node id="9">
|
|
<label>trio::anonymous_namespace{MemoryStreamImpl.cpp}::MemoryReader</label>
|
|
<link refid="classtrio_1_1anonymous__namespace_02MemoryStreamImpl_8cpp_03_1_1MemoryReader"/>
|
|
<childnode refid="1" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
</inheritancegraph>
|
|
<collaborationgraph>
|
|
<node id="1">
|
|
<label>trio::Readable</label>
|
|
<link refid="classtrio_1_1Readable"/>
|
|
</node>
|
|
</collaborationgraph>
|
|
<location file="C:/source/MetaHuman-DNA-Calibration/dnacalib/DNACalib/include/trio/Concepts.h" line="14" column="1" bodyfile="C:/source/MetaHuman-DNA-Calibration/dnacalib/DNACalib/include/trio/Concepts.h" bodystart="14" bodyend="40"/>
|
|
<listofallmembers>
|
|
<member refid="classtrio_1_1Readable_1a134ad61b17c812f7aa2d912fc96d36f9" prot="public" virt="pure-virtual"><scope>trio::Readable</scope><name>read</name></member>
|
|
<member refid="classtrio_1_1Readable_1ae7272a2547bb33c20c9b37493491c6c1" prot="public" virt="pure-virtual"><scope>trio::Readable</scope><name>read</name></member>
|
|
<member refid="classtrio_1_1Readable_1a49421a76a150a17207dc2d896d73d7a7" prot="protected" virt="virtual"><scope>trio::Readable</scope><name>~Readable</name></member>
|
|
</listofallmembers>
|
|
</compounddef>
|
|
</doxygen>
|