Skip to content

Group cuvis_session

Modules > cuvis_session

More...

Public Functions

Type Name
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_session_file_copy_handle (CUVIS_SESSION_FILE i_sess, CUVIS_SESSION_FILE * o_pSess)
Creates an additional session file handle.
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_session_file_free (CUVIS_SESSION_FILE * o_pSess)
Release a session_info file handle.
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_session_file_get_fps (CUVIS_SESSION_FILE i_sess, double * o_pFps)
get a session_info file's FPS
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_session_file_get_hash (CUVIS_SESSION_FILE i_sess, CUVIS_CHAR * o_pHash)
get a session_info file's hash
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_session_file_get_mesu (CUVIS_SESSION_FILE i_sess, CUVIS_INT i_frameNo, CUVIS_SESSION_ITEM_TYPE i_type, CUVIS_MESU * o_pMesu)
Load a measurement from the session_info file.
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_session_file_get_operation_mode (CUVIS_SESSION_FILE i_sess, CUVIS_OPERATION_MODE * o_pMode)
returns the operation mode the session_info file was recorded in
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_session_file_get_reference_mesu (CUVIS_SESSION_FILE i_sess, CUVIS_INT i_frameNo, CUVIS_REFERENCE_TYPE i_type, CUVIS_MESU * o_pMesu)
Load a reference measurement from the session_info file.
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_session_file_get_size (CUVIS_SESSION_FILE i_sess, CUVIS_SESSION_ITEM_TYPE i_type, CUVIS_INT * o_pSize)
Get number of total frames of session_info file.
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_session_file_get_thumbnail (CUVIS_SESSION_FILE i_sess, CUVIS_IMBUFFER * o_pThumbnail)
Get the thumbnail image of a session file.
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_session_file_load (const CUVIS_CHAR * i_path, CUVIS_SESSION_FILE * o_pSess)
Load a session_info file from disk.

Detailed Description

The main file format of the SDK

Public Functions Documentation

function cuvis_session_file_copy_handle

Creates an additional session file handle. 

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_session_file_copy_handle (
    CUVIS_SESSION_FILE i_sess,
    CUVIS_SESSION_FILE * o_pSess
)

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

Parameters:

  • i_sess The handle of the session file to copy
  • o_pSess The new handle of the session file.

Returns:

status_ok if the session file handle could be doubled

function cuvis_session_file_free

Release a session_info file handle. 

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_session_file_free (
    CUVIS_SESSION_FILE * o_pSess
)

Release a measurement by it's handle. The handle will be overwritten to CUVIS_HANDLE_NULL This will not affect any measurements on disk. Measurements loaded from the session_info file remain valid.

Parameters:

  • o_pSess The handle to the measurement to be deleted

Returns:

status_ok if the session_info file was released.

function cuvis_session_file_get_fps

get a session_info file's FPS 

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_session_file_get_fps (
    CUVIS_SESSION_FILE i_sess,
    double * o_pFps
)

The session_info file meta-Information will be available only if the mode cuvis_session_file_get_operation_mode returns "Internal"

Parameters:

  • i_sess the session_info file handle
  • o_pFps the frames per second the session_info was recorded with.

Returns:

status_ok if fps could be retrieved, status_not_available if the session_info file has not FPS property set.

function cuvis_session_file_get_hash

get a session_info file's hash 

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_session_file_get_hash (
    CUVIS_SESSION_FILE i_sess,
    CUVIS_CHAR * o_pHash
)

Parameters:

  • i_sess the session_info file handle
  • o_pHash the hash of the sessionfile.

Returns:

status_ok if hash could be retrieved, status_not_available if the sessionfile has no hash property set.

function cuvis_session_file_get_mesu

Load a measurement from the session_info file. 

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_session_file_get_mesu (
    CUVIS_SESSION_FILE i_sess,
    CUVIS_INT i_frameNo,
    CUVIS_SESSION_ITEM_TYPE i_type,
    CUVIS_MESU * o_pMesu
)

Parameters:

  • i_sess the session_info file handle
  • i_frameNo the frame no. Counting from 0, must be below value of cuvis_session_file_get_size of it's respective i_type
  • i_type the type of listing (size depends on type)
  • o_pMesu the handle of the measurement.

Returns:

status_ok, if the measurement could be loaded. status_no_measurement if the measurement was dropped. status_error if the frame exeeds the number of frames.

function cuvis_session_file_get_operation_mode

returns the operation mode the session_info file was recorded in 

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_session_file_get_operation_mode (
    CUVIS_SESSION_FILE i_sess,
    CUVIS_OPERATION_MODE * o_pMode
)

The operation mode gives indication how the session_info file was recorded.

Parameters:

  • i_sess the session_info file handle
  • o_pMode the operation mode of the session_info file.

Returns:

status_ok if no error occurred.

function cuvis_session_file_get_reference_mesu

Load a reference measurement from the session_info file. 

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_session_file_get_reference_mesu (
    CUVIS_SESSION_FILE i_sess,
    CUVIS_INT i_frameNo,
    CUVIS_REFERENCE_TYPE i_type,
    CUVIS_MESU * o_pMesu
)

Parameters:

  • i_sess the session_info file handle
  • i_frameNo the reference number. Counting from 0. If i_type is not set, refers to the index of all references and must be below the value of cuvis_session_file_get_size using type session_item_type_references. If i_type is set, must be 0.
  • i_type the type of reference measurement requested
  • o_pMesu the handle of the measurement.

Returns:

status_ok, if the reference could be loaded. status_no_measurement if the reference does not exist. status_error if the i_frameNo exeeds the number of references.

function cuvis_session_file_get_size

Get number of total frames of session_info file. 

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_session_file_get_size (
    CUVIS_SESSION_FILE i_sess,
    CUVIS_SESSION_ITEM_TYPE i_type,
    CUVIS_INT * o_pSize
)

Parameters:

  • i_sess the session_info file handle
  • i_type the type of listing (size depends on type)
  • o_pSize the size is written here.

Returns:

status_ok if no error occurred.

function cuvis_session_file_get_thumbnail

Get the thumbnail image of a session file. 

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_session_file_get_thumbnail (
    CUVIS_SESSION_FILE i_sess,
    CUVIS_IMBUFFER * o_pThumbnail
)

Return the thumbnail of a session file. The image data is valid as long as the session file handle is not released.

see also: Reserved Keys

Parameters:

  • i_sess The session file handle
  • o_pThumbnail The image buffer to be filled

Returns:

status_ok if the buffer could be filled with the image element. status_not_available if the requested data was empty, or the key could not be found

function cuvis_session_file_load

Load a session_info file from disk. 

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_session_file_load (
    const CUVIS_CHAR * i_path,
    CUVIS_SESSION_FILE * o_pSess
)

The session_info file is a cu3s file and consists of binary cu3 measurement data. Call cuvis_session_file_get_mesu to obtain a single measurement frame. SessionFile files can be create with the Cube Exporter (see cuvis_exporter_create_cube)

Note:

Do not read a file currently opened for writing.

Parameters:

  • i_path the file path of the session_info file
  • o_pSess the handle of the session_info file.

Returns:

status_ok, if the measurement could be loaded.