Class cuvis::SessionFile

ClassList > cuvis > SessionFile

• #include <cuvis.hpp>

Public Functions

Type	Name
	SessionFile (std::filesystem::path const & path)
	SessionFile (CUVIS_SESSION_FILE handle) Expert: Create a wrapper class around a handle. This only allowed once per handle, otherwise the handle could be freed before all instances of the wrapper class are deleted. This can be useful if a previously a handle has been copied and now should be wrapped at another place in a program. Most of the time this is not necesarry and the wrapper class can be copied just as well.
double	get_fps () const get the frame rate of this session
CUVIS_SESSION_FILE	get_handle () const Expert: Return the current handle of the wrapper class.
CUVIS_SESSION_FILE	get_handle_copy () const Expert: Create a copy of the current handle of the wrapper class and return it. This handle needs to be also freed before the resource will be released by the sdk.
std::string	get_hash () const
std::optional< Measurement >	get_mesu (int_t frameNo, cuvis_session_item_type_t type=cuvis_session_item_type_t::session_item_type_frames) const
CUVIS_OPERATION_MODE	get_operation_mode () const get operation mode of the session
std::optional< Measurement >	get_ref (int_t refNo, cuvis_reference_type_t type) const
int_t	get_size (cuvis_session_item_type_t type=cuvis_session_item_type_t::session_item_type_frames) const get size of the SessionFile __
common_image_t< std::uint8_t >	get_thumbnail () const

Public Functions Documentation

function SessionFile [1/2]

cuvis::SessionFile::SessionFile (
    std::filesystem::path const & path
) 

---

function SessionFile [2/2]

Expert: Create a wrapper class around a handle. This only allowed once per handle, otherwise the handle could be freed before all instances of the wrapper class are deleted. This can be useful if a previously a handle has been copied and now should be wrapped at another place in a program. Most of the time this is not necesarry and the wrapper class can be copied just as well.

cuvis::SessionFile::SessionFile (
    CUVIS_SESSION_FILE handle
) 

---

function get_fps

get the frame rate of this session

double cuvis::SessionFile::get_fps () const

---

function get_handle

Expert: Return the current handle of the wrapper class.

CUVIS_SESSION_FILE cuvis::SessionFile::get_handle () const

---

function get_handle_copy

Expert: Create a copy of the current handle of the wrapper class and return it. This handle needs to be also freed before the resource will be released by the sdk.

CUVIS_SESSION_FILE cuvis::SessionFile::get_handle_copy () const

---

function get_hash

std::string cuvis::SessionFile::get_hash () const

---

function get_mesu

std::optional< Measurement > cuvis::SessionFile::get_mesu (
    int_t frameNo,
    cuvis_session_item_type_t type=cuvis_session_item_type_t::session_item_type_frames
) const

---

function get_operation_mode

get operation mode of the session

CUVIS_OPERATION_MODE cuvis::SessionFile::get_operation_mode () const

---

function get_ref

std::optional< Measurement > cuvis::SessionFile::get_ref (
    int_t refNo,
    cuvis_reference_type_t type
) const

---

function get_size

get size of the SessionFile __

int_t cuvis::SessionFile::get_size (
    cuvis_session_item_type_t type=cuvis_session_item_type_t::session_item_type_frames
) const

---

function get_thumbnail

common_image_t < std::uint8_t > cuvis::SessionFile::get_thumbnail () const

---

---

The documentation for this class was generated from the following file cuvis.cpp/interface/cuvis.hpp