LabVIEW datatypes and helper functions

Definitions of datatypes and helper functions required for communication with LabVIEW. More...

Classes
struct	ErrorCluster
struct	LVArray< T >
	LabVIEW Array template. More...
struct	LVArray2D< T >
	LabVIEW 2D Array template. More...
struct	LVArray3D< T >
	LabVIEW 3D Array template. More...
struct	LVArrayND< T, N >
	LabVIEW N dimensions array template. More...
struct	CUDADeviceInfo

Enumerations
enum	QueueFrameFlags { QFF_Force32Bit = 0x7fffffff }

Functions
template<typename T >
void	ResizeLVArray2D (LVArray2D< T > **&d, int rows, int cols)
template<typename T >
void	ResizeLVArray3D (LVArray3D< T > **&d, int depth, int rows, int cols)
template<typename T , int N>
void	ResizeLVArray (LVArrayND< T, N > **&d, int *dims)
template<typename T >
void	ResizeLVArray (LVArray< T > **&d, int elems)
void	ArgumentErrorMsg (ErrorCluster *e, const std::string &msg)
void	SetLVString (LStrHandle str, const char *text)
MgErr	FillErrorCluster (MgErr err, const char *message, ErrorCluster *error)
std::vector< std::string >	LVGetStringArray (int count, LStrHandle *str)
bool	ValidateTracker (QueuedTracker *tracker, ErrorCluster *e, const char *funcname)
	Verify the referenced tracker is a valid QueuedTracker instance. More...
static bool	CheckCUDAErrorLV (cudaError err, ErrorCluster *e)
static bool	ValidRM (ResultManager *rm, ErrorCluster *err)
	Verify the referenced resultmanager is a valid ResultManager instance. More...

Detailed Description

Definitions of datatypes and helper functions required for communication with LabVIEW.

Wrappers around LabVIEW's cintools function calls and data types. lv_prolog.h and lv_epilog.h set up the correct alignment for LabVIEW data. See https://zone.ni.com/reference/en-XX/help/371361L-01/lvexcodeconcepts/configuring_the_clf_node/ for some more information.

Enumeration Type Documentation

QueueFrameFlags

enum QueueFrameFlags

Enumerator
QFF_Force32Bit	???

Definition at line 10 of file lv_qtrk_api.h.

                     {
    QFF_Force32Bit = 0x7fffffff     
};

Function Documentation

ArgumentErrorMsg()

void ArgumentErrorMsg	(	ErrorCluster *	e,
		const std::string &	msg
	)

Definition at line 61 of file lv_queuetrk_api.cpp.

{
    FillErrorCluster(mgArgErr, msg.c_str(), e);
}

CheckCUDAErrorLV()

static bool CheckCUDAErrorLV ( cudaError  err, ErrorCluster *  e  )

static

Definition at line 26 of file lv_qtrk_api.h.

{
    if (err != cudaSuccess) {
        const char* errstr = cudaGetErrorString(err);
        FillErrorCluster(kAppErrorBase, SPrintf("CUDA error: %s", errstr).c_str(), e);
        return false;
    }
    return true;
}

FillErrorCluster()

MgErr FillErrorCluster	(	MgErr	err,
		const char *	message,
		ErrorCluster *	error
	)

Definition at line 50 of file lv_queuetrk_api.cpp.

{
    if (err)
    {
        error->status = LVBooleanTrue;
        error->code = err;
        SetLVString ( error->message, message );
    }
    return err;
}

LVGetStringArray()

std::vector<std::string> LVGetStringArray	(	int	count,
		LStrHandle *	str
	)

Definition at line 38 of file lv_queuetrk_api.cpp.

{
    std::vector<std::string> result(count);

    for (int x=0;x<count;x++) {
        uChar *val = LHStrBuf(str[x]);
        int len = LHStrLen (str[x]);
        result[x]=std::string((const char*)val, (size_t)len );
    }
    return result;
}

ResizeLVArray() [1/2]

template<typename T , int N>

void ResizeLVArray	(	LVArrayND< T, N > **&	d,
		int *	dims
	)

Definition at line 118 of file labview.h.

{
    for (int i=0;i<N;i++)
        (*d)->dimSizes[i]=dims[i];
    NumericArrayResize(LVDataType<T>::code, N, (UHandle*)&d, sizeof(T)*(*d)->numElem());
}

ResizeLVArray() [2/2]

template<typename T >

void ResizeLVArray	(	LVArray< T > **&	d,
		int	elems
	)

Definition at line 126 of file labview.h.

{
    if (NumericArrayResize(LVDataType<T>::code, 1, (UHandle*)&d, sizeof(T)*elems) != mgNoErr)
        throw std::runtime_error( SPrintf("NumericArrayResize(1D array, %d) returned error.", elems));
    (*d)->dimSize = elems;
}

ResizeLVArray2D()

template<typename T >

void ResizeLVArray2D	(	LVArray2D< T > **&	d,
		int	rows,
		int	cols
	)

Definition at line 98 of file labview.h.

{
    if (NumericArrayResize(LVDataType<T>::code, 2, (UHandle*)&d, sizeof(T)*rows*cols) != mgNoErr)
        throw std::runtime_error( SPrintf("NumericArrayResize(2D array, %d, %d) returned error.", rows,cols));
    (*d)->dimSizes[0] = rows;
    (*d)->dimSizes[1] = cols;
}

ResizeLVArray3D()

template<typename T >

void ResizeLVArray3D	(	LVArray3D< T > **&	d,
		int	depth,
		int	rows,
		int	cols
	)

Definition at line 107 of file labview.h.

{
    if (NumericArrayResize(LVDataType<T>::code, 3, (UHandle*)&d, sizeof(T)*rows*cols*depth) != mgNoErr)
        throw std::runtime_error( SPrintf("NumericArrayResize(3D array, %d, %d, %d) returned error.", depth,rows,cols));

    (*d)->dimSizes[0] = depth;
    (*d)->dimSizes[1] = rows;
    (*d)->dimSizes[2] = cols;
}

SetLVString()

void SetLVString	(	LStrHandle	str,
		const char *	text
	)

Definition at line 27 of file lv_queuetrk_api.cpp.

{
    int msglen = strlen(text);
    MgErr err = NumericArrayResize(uB, 1, (UHandle*)&str, msglen);
    if (!err)
    {
        MoveBlock(text, LStrBuf(*str), msglen);
        LStrLen(*str) = msglen;
    }
}

ValidateTracker()

bool ValidateTracker	(	QueuedTracker *	tracker,
		ErrorCluster *	e,
		const char *	funcname
	)

Verify the referenced tracker is a valid QueuedTracker instance.

Parameters

[in]	tracker	The instance to verify.
[in]	e	The LabVIEW error cluster for this call.
[in]	funcname	The name of the desired function.

Returns

True if the supplied pointer can be used.

Definition at line 66 of file lv_queuetrk_api.cpp.

{
    if (std::find(trackerList.begin(), trackerList.end(), tracker)==trackerList.end()) {
        ArgumentErrorMsg(e, SPrintf("QTrk C++ function %s called with invalid tracker pointer: %p", funcname, tracker));
        return false;
    }
    return true;
}

ValidRM()

static bool ValidRM ( ResultManager *  rm, ErrorCluster *  err  )

static

Verify the referenced resultmanager is a valid ResultManager instance.

Parameters

[in]	rm	The instance to verify.
[in]	err	The LabVIEW error cluster for this call.

Returns

True if the supplied pointer can be used.

Definition at line 22 of file lv_resultmanager_api.cpp.

{
    if(rm_instances.find(rm) == rm_instances.end()) {
        ArgumentErrorMsg(err, "Invalid ResultManager instance passed.");
        return false;
    }
    return true;
}