core.hpp File Reference

C++ veneer for the core module. More...

#include <occtl/occtl_core.h>
#include <cstdint>
#include <stdexcept>
#include <string>
#include <string_view>
#include <tuple>
#include <utility>

Include dependency graph for core.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	occtl::Error
	Exception thrown by the veneer on any non-OK status code. More...
class	occtl::Runtime
	RAII handle for the process-wide runtime. More...

Functions
void	occtl::check (const ::occtl_status_t theStatus)
	Throw on non-OK; otherwise a no-op.
std::tuple< std::uint32_t, std::uint32_t, std::uint32_t >	occtl::version () noexcept
	Returns the runtime SemVer as a (major, minor, patch) tuple.
std::uint32_t	occtl::abi_version () noexcept
	Returns the runtime ABI version.
std::string_view	occtl::occt_version () noexcept
	Returns the OCCT version OCCT-Light was built against, as a string view.
void	occtl::init_runtime_info (::occtl_runtime_init_info_t *theInfo)
	Initialises an occtl_runtime_init_info_t to defaults and throws on a non-OK status (which would mean theInfo was NULL).
int32_t	occtl::uid_equal (const ::occtl_uid_t theA, const ::occtl_uid_t theB) noexcept
	Tests two UIDs for bitwise equality.

Detailed Description

C++ veneer for the core module.

Header-only RAII wrappers and exception translation over the C ABI. The public API is STL-shaped while local identifiers follow OCCT style.

Function Documentation

uid_equal()

int32_t occtl::uid_equal ( const ::occtl_uid_t  theA, const ::occtl_uid_t  theB  )

inlinenoexcept

Tests two UIDs for bitwise equality.

Return values

1	when equal, 0 otherwise.