Group cuvis_viewer

Modules > cuvis_viewer

More...

Public Functions

Type	Name
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_view_free (CUVIS_VIEWER * io_pView) Release a view.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_view_get_data (CUVIS_VIEW i_view, CUVIS_INT i_index, CUVIS_VIEW_DATA * o_pData) Obtain data from view.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_view_get_data_count (CUVIS_VIEW i_view, CUVIS_INT * o_pCount) retrieves the number of view data elements
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_viewer_apply (CUVIS_VIEWER i_viewer, CUVIS_MESU i_mesu, CUVIS_VIEW * o_pView) Generate a view from a measurement.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_viewer_copy_handle (CUVIS_VIEWER i_viewer, CUVIS_VIEWER * o_pViewer) Creates an additional viewer handle.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_viewer_create (CUVIS_VIEWER * o_pViewer, CUVIS_VIEWER_SETTINGS viewerSettings) Create a viewer.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_viewer_free (CUVIS_VIEWER * io_pViewer) Release a viewer.

Detailed Description

Something about the viewer

Public Functions Documentation

function cuvis_view_free

Release a view.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_view_free (
    CUVIS_VIEWER * io_pView
) 

Parameters:

• io_pView View to be released. If successfully, handle will be invalidated

Returns:

status_ok if the exporter was cleared.

---

function cuvis_view_get_data

Obtain data from view.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_view_get_data (
    CUVIS_VIEW i_view,
    CUVIS_INT i_index,
    CUVIS_VIEW_DATA * o_pData
) 

The data contains the actual view

Parameters:

• i_view The view handle
• i_index The element number
• o_pData The actual view data

Returns:

status_ok, if the meta-data could be loaded without errors

---

function cuvis_view_get_data_count

retrieves the number of view data elements

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_view_get_data_count (
    CUVIS_VIEW i_view,
    CUVIS_INT * o_pCount
) 

Parameters:

• i_view the view handle
• o_pCount The number of elements

---

function cuvis_viewer_apply

Generate a view from a measurement.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_viewer_apply (
    CUVIS_VIEWER i_viewer,
    CUVIS_MESU i_mesu,
    CUVIS_VIEW * o_pView
) 

The view is processed from a measurement by the viewer. The resulting view handle can be accessed by the cuvis_view_get_data_count to get number of elements, cuvis_view_get_data to get a single date element and cuvis_view_free to release the view (this must always be called)

Parameters:

• i_viewer The viewer
• i_mesu the measurement
• o_pView the resulting view handle.

Returns:

status_ok if the measurement was processed successfully.

---

function cuvis_viewer_copy_handle

Creates an additional viewer handle.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_viewer_copy_handle (
    CUVIS_VIEWER i_viewer,
    CUVIS_VIEWER * o_pViewer
) 

Creates an additional handle that points to the same instance as the supplied handle

Parameters:

• i_viewer The handle of the viewer to copy
• o_pViewer The new handle of the viewer.

Returns:

status_ok if the viewer handle could be doubled

---

function cuvis_viewer_create

Create a viewer.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_viewer_create (
    CUVIS_VIEWER * o_pViewer,
    CUVIS_VIEWER_SETTINGS viewerSettings
) 

Not to be confused with the view exporter. The viewer returns the view in the memory

Parameters:

• o_pViewer The handle of the viewer
• viewerSettings view settings

Returns:

status_ok if the exporter was created successfully

---

function cuvis_viewer_free

Release a viewer.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_viewer_free (
    CUVIS_VIEWER * io_pViewer
) 

Parameters:

• io_pViewer Viewer to be released. If successfully, handle will be invalidated

Returns:

status_ok if the exporter was cleared.

---

---