SDK/ToolBoxReference/mlPCLSupportTestTools_8h_source.html

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.

// **InsertLicense** code author="Wolf Spindler"

//------------------------------------------------------------------------------


//------------------------------------------------------------------------------


#include <MLPCLSupportSystem.h>

#include <mlTypeDefs.h>

#include <mlAPI.h>

#include <mlPCLBaseObject.h>


namespace MLPCLTestTools {


  MLPCLSUPPORT_EXPORT extern MLLibraryHandle loadPCLLibrary(const char * const modName) ML_RETURN_VALUE_SHOULD_BE_USED;


  MLPCLSUPPORT_EXPORT extern MLErrorCode unloadPCLLibrary(MLLibraryHandle modLibHandle,

                                                          const char * const modName) ML_RETURN_VALUE_SHOULD_BE_USED;


  MLPCLSUPPORT_EXPORT extern MLErrorCode setUpPCLTestTools() ML_RETURN_VALUE_SHOULD_BE_USED;


  MLPCLSUPPORT_EXPORT extern MLErrorCode tearDownPCLTestTools() ML_RETURN_VALUE_SHOULD_BE_USED;


  typedef void  (*OverrideTestDefaultsFunc)(mlModule *modulePtr, const char *className);


  MLPCLSUPPORT_EXPORT extern MLErrorCode runClassInstancesTest(const char * const *     pclClassNames,

                                                               size_t                   numPCLClassNames,

                                                               OverrideTestDefaultsFunc overrideTestDefaults=nullptr,

                                                               bool                     pclSupportItselfIsTested=false,

                                                               size_t                   numIndirectlyLoadedPCLClasses=0) ML_RETURN_VALUE_SHOULD_BE_USED;


  MLPCLSUPPORT_EXPORT extern MLuint64 _MaxSigned32BitIndex;


  MLPCLSUPPORT_EXPORT extern MLuint64 _MaxUnsigned32BitIndex;


}


MLPCLSupportSystem.h
Project global and OS specific declarations.

MLPCLSUPPORT_EXPORT
#define MLPCLSUPPORT_EXPORT
If included by external modules, exported symbols are declared as import symbols.
Definition MLPCLSupportSystem.h:21

MLErrorCode
MLint32 MLErrorCode
Type of an ML Error code.
Definition mlTypeDefs.h:716

mlAPI.h

mlModule
#define mlModule
A macro name for a void pointer to a ml::Module in the ML to make pointer more readable.
Definition mlAPI.h:60

MLLibraryHandle
HMODULE MLLibraryHandle
Defines the platform specific handle for a dynamically linked library.
Definition mlAPI.h:71

mlPCLBaseObject.h
Base object containing pointers (as MLPCLObjectPtrsContainer) to objects from the Point Cloud Library...

mlrange_cast
Target mlrange_cast(Source arg)
Generic version of checked ML casts.
Definition mlRangeCasts.h:332

mlTypeDefs.h

MLuint64
UINT64 MLuint64
Introduce platform independent 64 bit unsigned integer type.
Definition mlTypeDefs.h:425

MLPCLTestTools
Namespace containing useful tools for Google tests written for PCL related classes in MeVisLab.
Definition mlPCLSupportTestTools.h:18

MLPCLTestTools::loadPCLLibrary
MLPCLSUPPORT_EXPORT MLLibraryHandle loadPCLLibrary(const char *const modName) ML_RETURN_VALUE_SHOULD_BE_USED
Loads a MeVisLab library with name modName and returns a non-nullptr handle to the library on success...

MLPCLTestTools::setUpPCLTestTools
MLPCLSUPPORT_EXPORT MLErrorCode setUpPCLTestTools() ML_RETURN_VALUE_SHOULD_BE_USED
Initializes some internals needed by the subsequent tool functions and loads MLBasicModules; returns ...

MLPCLTestTools::tearDownPCLTestTools
MLPCLSUPPORT_EXPORT MLErrorCode tearDownPCLTestTools() ML_RETURN_VALUE_SHOULD_BE_USED
Cleans up some internals initialized with setUpPCLTestTools() and unloads MLBasicModules; returns ML_...

MLPCLTestTools::OverrideTestDefaultsFunc
void(* OverrideTestDefaultsFunc)(mlModule *modulePtr, const char *className)
A function type which allows to set fields of the module with class name className and given with mod...
Definition mlPCLSupportTestTools.h:38

MLPCLTestTools::_MaxUnsigned32BitIndex
MLPCLSUPPORT_EXPORT MLuint64 _MaxUnsigned32BitIndex
This variable is exported for testing purposes only.

MLPCLTestTools::unloadPCLLibrary
MLPCLSUPPORT_EXPORT MLErrorCode unloadPCLLibrary(MLLibraryHandle modLibHandle, const char *const modName) ML_RETURN_VALUE_SHOULD_BE_USED
Unloads a MeVisLab library with name modName and handle modLibHandle; returns ML_RESULT_OK on success...

MLPCLTestTools::_MaxSigned32BitIndex
MLPCLSUPPORT_EXPORT MLuint64 _MaxSigned32BitIndex
This variable is exported for testing purposes only.

MLPCLTestTools::runClassInstancesTest
MLPCLSUPPORT_EXPORT MLErrorCode runClassInstancesTest(const char *const *pclClassNames, size_t numPCLClassNames, OverrideTestDefaultsFunc overrideTestDefaults=nullptr, bool pclSupportItselfIsTested=false, size_t numIndirectlyLoadedPCLClasses=0) ML_RETURN_VALUE_SHOULD_BE_USED
Runs some heavy tests on the module with class name className and given with modulePtr before it is t...