io_step.hpp File Reference

C++ veneer for STEP I/O. More...

#include <occtl/occtl_io_step.h>
#include <occtl-hpp/core.hpp>
#include <occtl-hpp/topo.hpp>
#include <cstddef>
#include <cstdint>
#include <string>
#include <utility>
#include <vector>

Include dependency graph for io_step.hpp:

Go to the source code of this file.

Classes
struct	occtl::io_step::ReadOptions
	Options for read. PascalCase mirror of occtl_io_step_read_options_t. More...
struct	occtl::io_step::WriteOptions
	Options for write. PascalCase mirror of occtl_io_step_write_options_t. More...

Functions
std::pair< Graph, NodeId >	occtl::io_step::read (const std::string &thePath, const ReadOptions &theOptions=ReadOptions{})
	Reads a STEP file into a fresh graph and returns (graph, root).
std::pair< Graph, NodeId >	occtl::io_step::read_memory (const uint8_t *const theData, const std::size_t theSize, const ReadOptions &theOptions=ReadOptions{})
	Reads a STEP memory payload into a fresh graph and returns (graph, root).
std::pair< Graph, NodeId >	occtl::io_step::read_memory (const std::vector< uint8_t > &theData, const ReadOptions &theOptions=ReadOptions{})
	Reads a STEP memory payload into a fresh graph and returns (graph, root).
void	occtl::io_step::write (const Graph &theGraph, const NodeId theRoot, const std::string &thePath, const WriteOptions &theOptions=WriteOptions{})
	Writes the topology rooted at theRoot to a STEP file.
std::vector< uint8_t >	occtl::io_step::write_memory (const Graph &theGraph, const NodeId theRoot, const WriteOptions &theOptions=WriteOptions{})
	Writes the topology rooted at theRoot into a STEP memory payload.

Detailed Description

C++ veneer for STEP I/O.

Function Documentation

read()

std::pair< Graph, NodeId > occtl::io_step::read ( const std::string &  thePath, const ReadOptions &  theOptions = ReadOptions{}  )

inline

Reads a STEP file into a fresh graph and returns (graph, root).

Exceptions

Error

on failure.

read_memory() [1/2]

std::pair< Graph, NodeId > occtl::io_step::read_memory ( const std::vector< uint8_t > &  theData, const ReadOptions &  theOptions = ReadOptions{}  )

inline

Reads a STEP memory payload into a fresh graph and returns (graph, root).

Exceptions

Error

on failure.

read_memory() [2/2]

std::pair< Graph, NodeId > occtl::io_step::read_memory ( const uint8_t *const  theData, const std::size_t  theSize, const ReadOptions &  theOptions = ReadOptions{}  )

inline

Reads a STEP memory payload into a fresh graph and returns (graph, root).

Exceptions

Error

on failure.

write()

void occtl::io_step::write ( const Graph &  theGraph, const NodeId  theRoot, const std::string &  thePath, const WriteOptions &  theOptions = WriteOptions{}  )

inline

Writes the topology rooted at theRoot to a STEP file.

Exceptions

Error

on failure.

write_memory()

std::vector< uint8_t > occtl::io_step::write_memory ( const Graph &  theGraph, const NodeId  theRoot, const WriteOptions &  theOptions = WriteOptions{}  )

inline

Writes the topology rooted at theRoot into a STEP memory payload.

Exceptions

Error

on failure.