Skip to content

Class cuvis::Viewer

ClassList > cuvis > Viewer

  • #include <cuvis.hpp>

Public Types

Type Name
typedef std::map< std::string, view_variant_t > view_data_t
typedef std::variant< view_t< std::uint8_t >, view_t< float > > view_variant_t
typedef cuvis_viewer_settings_t viewer_settings_t

Public Functions

Type Name
Viewer (ViewArgs const & args)
Viewer (CUVIS_VIEWER 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.
view_data_t apply (Measurement const & mesu)
CUVIS_VIEWER get_handle () const
Expert: Return the current handle of the wrapper class.
CUVIS_VIEWER 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.

Public Types Documentation

typedef view_data_t

using cuvis::Viewer::view_data_t =  std::map<std::string, view_variant_t>;

typedef view_variant_t

using cuvis::Viewer::view_variant_t =  std::variant<view_t<std::uint8_t>, view_t<float> >;

typedef viewer_settings_t

using cuvis::Viewer::viewer_settings_t =  cuvis_viewer_settings_t;

Public Functions Documentation

function Viewer [1/2]

cuvis::Viewer::Viewer (
    ViewArgs  const & args
) 

function Viewer [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::Viewer::Viewer (
    CUVIS_VIEWER handle
) 


function apply

view_data_t cuvis::Viewer::apply (
    Measurement  const & mesu
) 

function get_handle

Expert: Return the current handle of the wrapper class.

CUVIS_VIEWER cuvis::Viewer::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_VIEWER cuvis::Viewer::get_handle_copy () const



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