Skip to content

Commit f2c6afd

Browse files
committed
Update C++ API docs from 8003d43
1 parent d54c8ee commit f2c6afd

17 files changed

Lines changed: 103 additions & 36 deletions

v0.9.0-latest/_sources/output/api/file_src_ifcparse_rocksdb_map_adapter.h.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,10 @@ Functions
8686

8787
- :ref:`exhale_function_rocksdb__map__adapter_8h_1aa3e2b83db1c4e055e9a861bfc4caaa12`
8888

89-
- :ref:`exhale_function_rocksdb__map__adapter_8h_1ad0db5cf73cc183adfdeee6cf674a7e41`
90-
9189
- :ref:`exhale_function_rocksdb__map__adapter_8h_1af9356a73aaf9a6fd745cc10e42efb9ef`
9290

91+
- :ref:`exhale_function_rocksdb__map__adapter_8h_1ad0db5cf73cc183adfdeee6cf674a7e41`
92+
9393
- :ref:`exhale_function_rocksdb__map__adapter_8h_1aae13c074030f58e82049824b8e482d48`
9494

9595
- :ref:`exhale_function_rocksdb__map__adapter_8h_1a330848d11df840c10611bcb59b937306`

v0.9.0-latest/_sources/output/api/namespace_ifcopenshell__geom__taxonomy.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Namespaces
1717
----------
1818

1919

20-
- :ref:`namespace_ifcopenshell__geom__taxonomy__@51`
20+
- :ref:`namespace_ifcopenshell__geom__taxonomy__@52`
2121

2222
- :ref:`namespace_ifcopenshell__geom__taxonomy__impl`
2323

v0.9.0-latest/_sources/output/api/namespace_ifcopenshell__geom__taxonomy__@51.rst.txt renamed to v0.9.0-latest/_sources/output/api/namespace_ifcopenshell__geom__taxonomy__@52.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

2-
.. _namespace_ifcopenshell__geom__taxonomy__@51:
2+
.. _namespace_ifcopenshell__geom__taxonomy__@52:
33

4-
Namespace ifcopenshell::geom::taxonomy::@51
4+
Namespace ifcopenshell::geom::taxonomy::@52
55
===========================================
66

77

v0.9.0-latest/_sources/output/api/program_listing_file_src_ifcparse_file.h.rst.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,10 @@ Program Listing for File file.h
313313
314314
std::vector<express::base> instances_by_reference(int reference_id);
315315
316+
#ifndef SWIG
317+
bool all_referencing_instances(int instance_id, const std::function<bool(uint32_t)>& pred);
318+
#endif
319+
316320
express::base instance_by_id(int instance_id);
317321
318322
express::base instance_by_guid(const std::string& global_id);

v0.9.0-latest/_sources/output/api/program_listing_file_src_ifcparse_storage.h.rst.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -489,6 +489,27 @@ Program Listing for File storage.h
489489
return n;
490490
}
491491
492+
// True iff pred accepts the source of every live record
493+
// referencing referenced_id. Stops at the first rejection.
494+
template <typename Pred>
495+
bool all_sources(uint32_t referenced_id, Pred&& pred) const {
496+
auto range = base_range(referenced_id);
497+
for (auto it = range.first; it != range.second; ++it) {
498+
if (!is_dead(*it) && !pred(it->source_id)) {
499+
return false;
500+
}
501+
}
502+
auto bucket = delta_.find(referenced_id);
503+
if (bucket != delta_.end()) {
504+
for (const auto& record : bucket->second) {
505+
if (!pred(record.source_id)) {
506+
return false;
507+
}
508+
}
509+
}
510+
return true;
511+
}
512+
492513
bool empty() const {
493514
return size() == 0;
494515
}

v0.9.0-latest/genindex.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -646,6 +646,8 @@ <h2 id="I">I</h2>
646646
<li><a href="output/api/classifcopenshell_1_1file.html#_CPPv4N12ifcopenshell4file10add_entityERKN7express4baseEi">ifcopenshell::file::add_entity (C++ function)</a>
647647
</li>
648648
<li><a href="output/api/classifcopenshell_1_1file.html#_CPPv4N12ifcopenshell4file12add_type_refERKN7express4baseE">ifcopenshell::file::add_type_ref (C++ function)</a>
649+
</li>
650+
<li><a href="output/api/classifcopenshell_1_1file.html#_CPPv4N12ifcopenshell4file25all_referencing_instancesEiRKNSt8functionIFb8uint32_tEEE">ifcopenshell::file::all_referencing_instances (C++ function)</a>
649651
</li>
650652
<li><a href="output/api/classifcopenshell_1_1file.html#_CPPv4N12ifcopenshell4file5batchEv">ifcopenshell::file::batch (C++ function)</a>
651653
</li>
@@ -5104,6 +5106,8 @@ <h2 id="I">I</h2>
51045106
<li><a href="output/api/classifcopenshell_1_1impl_1_1inverse__index.html#_CPPv4N12ifcopenshell4impl13inverse_indexE">ifcopenshell::impl::inverse_index (C++ class)</a>
51055107
</li>
51065108
<li><a href="output/api/classifcopenshell_1_1impl_1_1inverse__index.html#_CPPv4N12ifcopenshell4impl13inverse_index3addE8uint32_t8uint32_t8uint16_ti">ifcopenshell::impl::inverse_index::add (C++ function)</a>
5109+
</li>
5110+
<li><a href="output/api/classifcopenshell_1_1impl_1_1inverse__index.html#_CPPv4I0ENK12ifcopenshell4impl13inverse_index11all_sourcesEb8uint32_tRR4Pred">ifcopenshell::impl::inverse_index::all_sources (C++ function)</a>
51075111
</li>
51085112
<li><a href="output/api/classifcopenshell_1_1impl_1_1inverse__index.html#_CPPv4N12ifcopenshell4impl13inverse_index5beginEv">ifcopenshell::impl::inverse_index::begin (C++ function)</a>, <a href="output/api/classifcopenshell_1_1impl_1_1inverse__index.html#_CPPv4NK12ifcopenshell4impl13inverse_index5beginEv">[1]</a>
51095113
</li>

v0.9.0-latest/objects.inv

169 Bytes
Binary file not shown.

v0.9.0-latest/output/api/classifcopenshell_1_1file.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,12 @@ <h2>Class Documentation<a class="headerlink" href="#class-documentation" title="
237237
<dd><p>Returns all entities in the file that reference the id. </p>
238238
</dd></dl>
239239

240+
<dl class="cpp function">
241+
<dt class="sig sig-object cpp" id="_CPPv4N12ifcopenshell4file25all_referencing_instancesEiRKNSt8functionIFb8uint32_tEEE">
242+
<span id="_CPPv3N12ifcopenshell4file25all_referencing_instancesEiRKNSt8functionIFb8uint32_tEEE"></span><span id="_CPPv2N12ifcopenshell4file25all_referencing_instancesEiRKNSt8functionIFb8uint32_tEEE"></span><span class="target" id="classifcopenshell_1_1file_1abf9f34052ef956826c2dd63303c086e7"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">all_referencing_instances</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">instance_id</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">function</span></span><span class="p"><span class="pre">&lt;</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint32_t</span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">pred</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N12ifcopenshell4file25all_referencing_instancesEiRKNSt8functionIFb8uint32_tEEE" title="Link to this definition"></a><br /></dt>
243+
<dd><p>Returns whether pred accepts the id of every instance that references instance_id, stopping at the first one it rejects. Used by the Python wrapper’s helpers; a std::function can’t be exposed to Python itself. </p>
244+
</dd></dl>
245+
240246
<dl class="cpp function">
241247
<dt class="sig sig-object cpp" id="_CPPv4N12ifcopenshell4file14instance_by_idEi">
242248
<span id="_CPPv3N12ifcopenshell4file14instance_by_idEi"></span><span id="_CPPv2N12ifcopenshell4file14instance_by_idEi"></span><span id="ifcopenshell::file::instance_by_id__i"></span><span class="target" id="classifcopenshell_1_1file_1a477084071e914e4aac8b0efa3c161b2e"></span><span class="n"><span class="pre">express</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="classexpress_1_1base.html#_CPPv4N7express4baseE" title="express::base"><span class="n"><span class="pre">base</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">instance_by_id</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">instance_id</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N12ifcopenshell4file14instance_by_idEi" title="Link to this definition"></a><br /></dt>

v0.9.0-latest/output/api/classifcopenshell_1_1impl_1_1inverse__index.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,11 @@ <h2>Class Documentation<a class="headerlink" href="#class-documentation" title="
147147
<span id="_CPPv3NK12ifcopenshell4impl13inverse_index5countE8uint32_t"></span><span id="_CPPv2NK12ifcopenshell4impl13inverse_index5countE8uint32_t"></span><span id="ifcopenshell::impl::inverse_index::count__uint32_tC"></span><span class="target" id="classifcopenshell_1_1impl_1_1inverse__index_1a35d969c2571ed07377c336be36ff121f"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">count</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">referenced_id</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK12ifcopenshell4impl13inverse_index5countE8uint32_t" title="Link to this definition"></a><br /></dt>
148148
<dd></dd></dl>
149149

150+
<dl class="cpp function">
151+
<dt class="sig sig-object cpp" id="_CPPv4I0ENK12ifcopenshell4impl13inverse_index11all_sourcesEb8uint32_tRR4Pred">
152+
<span id="_CPPv3I0ENK12ifcopenshell4impl13inverse_index11all_sourcesE8uint32_tRR4Pred"></span><span id="_CPPv2I0ENK12ifcopenshell4impl13inverse_index11all_sourcesE8uint32_tRR4Pred"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre">&lt;</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Pred</span></span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="target" id="classifcopenshell_1_1impl_1_1inverse__index_1abf0a182a8978133c01ad8642a8763116"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">all_sources</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">referenced_id</span></span>, <a class="reference internal" href="#_CPPv4I0ENK12ifcopenshell4impl13inverse_index11all_sourcesEb8uint32_tRR4Pred" title="ifcopenshell::impl::inverse_index::all_sources::Pred"><span class="n"><span class="pre">Pred</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">pred</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4I0ENK12ifcopenshell4impl13inverse_index11all_sourcesEb8uint32_tRR4Pred" title="Link to this definition"></a><br /></dt>
153+
<dd></dd></dl>
154+
150155
<dl class="cpp function">
151156
<dt class="sig sig-object cpp" id="_CPPv4NK12ifcopenshell4impl13inverse_index5emptyEv">
152157
<span id="_CPPv3NK12ifcopenshell4impl13inverse_index5emptyEv"></span><span id="_CPPv2NK12ifcopenshell4impl13inverse_index5emptyEv"></span><span id="ifcopenshell::impl::inverse_index::emptyC"></span><span class="target" id="classifcopenshell_1_1impl_1_1inverse__index_1ada0ca21161d57656d30f01a451e7ce1e"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">empty</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK12ifcopenshell4impl13inverse_index5emptyEv" title="Link to this definition"></a><br /></dt>

v0.9.0-latest/output/api/file_src_ifcparse_rocksdb_map_adapter.h.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,8 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
9494
<ul class="simple">
9595
<li><p><a class="reference internal" href="function_rocksdb__map__adapter_8h_1aad41b1637be9a385c85841fe62d6b0c2.html#exhale-function-rocksdb-map-adapter-8h-1aad41b1637be9a385c85841fe62d6b0c2"><span class="std std-ref">Template Function convert_string</span></a></p></li>
9696
<li><p><a class="reference internal" href="function_rocksdb__map__adapter_8h_1aa3e2b83db1c4e055e9a861bfc4caaa12.html#exhale-function-rocksdb-map-adapter-8h-1aa3e2b83db1c4e055e9a861bfc4caaa12"><span class="std std-ref">Function hex_key</span></a></p></li>
97-
<li><p><a class="reference internal" href="function_rocksdb__map__adapter_8h_1ad0db5cf73cc183adfdeee6cf674a7e41.html#exhale-function-rocksdb-map-adapter-8h-1ad0db5cf73cc183adfdeee6cf674a7e41"><span class="std std-ref">Template Function key_to_string(const KeyT&amp;)</span></a></p></li>
9897
<li><p><a class="reference internal" href="function_rocksdb__map__adapter_8h_1af9356a73aaf9a6fd745cc10e42efb9ef.html#exhale-function-rocksdb-map-adapter-8h-1af9356a73aaf9a6fd745cc10e42efb9ef"><span class="std std-ref">Template Function key_to_string(const std::tuple&lt;Ts…&gt;&amp;)</span></a></p></li>
98+
<li><p><a class="reference internal" href="function_rocksdb__map__adapter_8h_1ad0db5cf73cc183adfdeee6cf674a7e41.html#exhale-function-rocksdb-map-adapter-8h-1ad0db5cf73cc183adfdeee6cf674a7e41"><span class="std std-ref">Template Function key_to_string(const KeyT&amp;)</span></a></p></li>
9999
<li><p><a class="reference internal" href="function_rocksdb__map__adapter_8h_1aae13c074030f58e82049824b8e482d48.html#exhale-function-rocksdb-map-adapter-8h-1aae13c074030f58e82049824b8e482d48"><span class="std std-ref">Function parse_hex_key</span></a></p></li>
100100
<li><p><a class="reference internal" href="function_rocksdb__map__adapter_8h_1a330848d11df840c10611bcb59b937306.html#exhale-function-rocksdb-map-adapter-8h-1a330848d11df840c10611bcb59b937306"><span class="std std-ref">Function rocksdb_key::attribute</span></a></p></li>
101101
<li><p><a class="reference internal" href="function_rocksdb__map__adapter_8h_1ac48770b676af809906f5d1c7b93d9628.html#exhale-function-rocksdb-map-adapter-8h-1ac48770b676af809906f5d1c7b93d9628"><span class="std std-ref">Function rocksdb_key::header_attribute</span></a></p></li>

0 commit comments

Comments
 (0)