aida_pva_api.h File Reference

The Header File for the Channel Provider API endpoints and endpoint-stubs MACROS. More...

#include <jni.h>
#include <descrip.h>
#include <stdbool.h>
#include <stsdef.h>
#include "slc_macros.h"
#include "msg_proto.h"
#include "errtranslate.h"
#include "aida_pva_json.h"
#include "ref.h"
#include "process_parm.h"
#include "aida_pva.h"

Go to the source code of this file.

Macros
#define	REQUEST_STUB_ARRAY(_api)
	API stub for AIDA-PVA array requests. More...
#define	REQUEST_STUB_BOOLEAN   REQUEST_STUB_SCALAR(aidaRequestBoolean, int, 0)
	aidaRequestBoolean API Stub More...
#define	REQUEST_STUB_BOOLEAN_ARRAY   REQUEST_STUB_ARRAY(aidaRequestBooleanArray)
	aidaRequestBooleanArray API Stub More...
#define	REQUEST_STUB_BYTE   REQUEST_STUB_SCALAR(aidaRequestByte, char, 0x0)
	aidaRequestByte API Stub More...
#define	REQUEST_STUB_BYTE_ARRAY   REQUEST_STUB_ARRAY(aidaRequestByteArray)
	aidaRequestByteArray API Stub More...
#define	REQUEST_STUB_DOUBLE   REQUEST_STUB_SCALAR(aidaRequestDouble, double, 0.0)
	aidaRequestDouble API Stub More...
#define	REQUEST_STUB_DOUBLE_ARRAY   REQUEST_STUB_ARRAY(aidaRequestDoubleArray)
	aidaRequestDoubleArray API Stub More...
#define	REQUEST_STUB_FLOAT   REQUEST_STUB_SCALAR(aidaRequestFloat, float, 0.0f)
	aidaRequestFloat API Stub More...
#define	REQUEST_STUB_FLOAT_ARRAY   REQUEST_STUB_ARRAY(aidaRequestFloatArray)
	aidaRequestFloatArray API Stub More...
#define	REQUEST_STUB_INTEGER   REQUEST_STUB_SCALAR(aidaRequestInteger, int, 0)
	aidaRequestInteger API Stub More...
#define	REQUEST_STUB_INTEGER_ARRAY   REQUEST_STUB_ARRAY(aidaRequestIntegerArray)
	aidaRequestIntegerArray API Stub More...
#define	REQUEST_STUB_LONG   REQUEST_STUB_SCALAR(aidaRequestLong, long, 0)
	aidaRequestLong API Stub More...
#define	REQUEST_STUB_LONG_ARRAY   REQUEST_STUB_ARRAY(aidaRequestLongArray)
	aidaRequestLongArray API Stub More...
#define	REQUEST_STUB_SCALAR(_api, _rtype, _r)
	API stub for AIDA-PVA scalar requests. More...
#define	REQUEST_STUB_SHORT   REQUEST_STUB_SCALAR(aidaRequestShort, short, 0)
	aidaRequestShort API Stub More...
#define	REQUEST_STUB_SHORT_ARRAY   REQUEST_STUB_ARRAY(aidaRequestShortArray)
	aidaRequestShortArray API Stub More...
#define	REQUEST_STUB_STRING   REQUEST_STUB_SCALAR(aidaRequestString, char*, NULL)
	aidaRequestString API Stub More...
#define	REQUEST_STUB_STRING_ARRAY
	aidaRequestStringArray API stub More...
#define	REQUEST_STUB_TABLE
	aidaRequestTable API stub More...
#define	RETURN_NULL_TABLE
	Return an empty table response. More...
#define	SET_STUB_TABLE
	aidaSetValueWithResponse API stub More...
#define	SET_STUB_VOID
	aidaSetValue API stub More...
#define	VERSION(_version)
	Use this macro to define the version of the provider. More...

Functions
int	aidaRequestBoolean (JNIEnv *env, const char *uri, Arguments arguments)
	Get a boolean. More...
Array	aidaRequestBooleanArray (JNIEnv *env, const char *uri, Arguments arguments)
	Get a boolean array. More...
char	aidaRequestByte (JNIEnv *env, const char *uri, Arguments arguments)
	Get a byte. More...
Array	aidaRequestByteArray (JNIEnv *env, const char *uri, Arguments arguments)
	Get a byte array. More...
double	aidaRequestDouble (JNIEnv *env, const char *uri, Arguments arguments)
	Get a double. More...
Array	aidaRequestDoubleArray (JNIEnv *env, const char *uri, Arguments arguments)
	Get a double array. More...
float	aidaRequestFloat (JNIEnv *env, const char *uri, Arguments arguments)
	Get a float. More...
Array	aidaRequestFloatArray (JNIEnv *env, const char *uri, Arguments arguments)
	Get a float array. More...
int	aidaRequestInteger (JNIEnv *env, const char *uri, Arguments arguments)
	Get a integer. More...
Array	aidaRequestIntegerArray (JNIEnv *env, const char *uri, Arguments arguments)
	Get a integer array. More...
long	aidaRequestLong (JNIEnv *env, const char *uri, Arguments arguments)
	Get a long. More...
Array	aidaRequestLongArray (JNIEnv *env, const char *uri, Arguments arguments)
	Get a long array. More...
short	aidaRequestShort (JNIEnv *env, const char *uri, Arguments arguments)
	Get a short. More...
Array	aidaRequestShortArray (JNIEnv *env, const char *uri, Arguments arguments)
	Get a short array. More...
char *	aidaRequestString (JNIEnv *env, const char *uri, Arguments arguments)
	Get a string. More...
StringArray	aidaRequestStringArray (JNIEnv *env, const char *uri, Arguments arguments)
	Get a string array. More...
Table	aidaRequestTable (JNIEnv *env, const char *uri, Arguments arguments)
	Get a table of data. More...
void	aidaServiceInit (JNIEnv *env)
	Initialise the aida service. More...
void	aidaSetValue (JNIEnv *env, const char *uri, Arguments arguments, Value value)
	Set a value. More...
Table	aidaSetValueWithResponse (JNIEnv *env, const char *uri, Arguments arguments, Value value)
	Set a value and return a table as a response. More...
char *	getVersion ()
	Function provided by all providers to give the version string. More...

Detailed Description

The Header File for the Channel Provider API endpoints and endpoint-stubs MACROS.

CMS=C_INC

Definition in file aida_pva_api.h.

Macro Definition Documentation

REQUEST_STUB_ARRAY

#define REQUEST_STUB_ARRAY

(

_api

)

Value:

Array _api(JNIEnv* env, const char* uri, Arguments arguments) \
{ \
    UNSUPPORTED_ARRAY_REQUEST \
}

API stub for AIDA-PVA array requests.

Parameters

_api	the name of the API to define

Returns

This MACRO will create a function stub that will return Array

Definition at line 297 of file aida_pva_api.h.

REQUEST_STUB_BOOLEAN

#define REQUEST_STUB_BOOLEAN   REQUEST_STUB_SCALAR(aidaRequestBoolean, int, 0)

aidaRequestBoolean API Stub

Definition at line 253 of file aida_pva_api.h.

REQUEST_STUB_BOOLEAN_ARRAY

#define REQUEST_STUB_BOOLEAN_ARRAY   REQUEST_STUB_ARRAY(aidaRequestBooleanArray)

aidaRequestBooleanArray API Stub

Definition at line 306 of file aida_pva_api.h.

REQUEST_STUB_BYTE

#define REQUEST_STUB_BYTE   REQUEST_STUB_SCALAR(aidaRequestByte, char, 0x0)

aidaRequestByte API Stub

Definition at line 259 of file aida_pva_api.h.

REQUEST_STUB_BYTE_ARRAY

#define REQUEST_STUB_BYTE_ARRAY   REQUEST_STUB_ARRAY(aidaRequestByteArray)

aidaRequestByteArray API Stub

Definition at line 311 of file aida_pva_api.h.

REQUEST_STUB_DOUBLE

#define REQUEST_STUB_DOUBLE   REQUEST_STUB_SCALAR(aidaRequestDouble, double, 0.0)

aidaRequestDouble API Stub

Definition at line 284 of file aida_pva_api.h.

REQUEST_STUB_DOUBLE_ARRAY

#define REQUEST_STUB_DOUBLE_ARRAY   REQUEST_STUB_ARRAY(aidaRequestDoubleArray)

aidaRequestDoubleArray API Stub

Definition at line 336 of file aida_pva_api.h.

REQUEST_STUB_FLOAT

#define REQUEST_STUB_FLOAT   REQUEST_STUB_SCALAR(aidaRequestFloat, float, 0.0f)

aidaRequestFloat API Stub

Definition at line 279 of file aida_pva_api.h.

REQUEST_STUB_FLOAT_ARRAY

#define REQUEST_STUB_FLOAT_ARRAY   REQUEST_STUB_ARRAY(aidaRequestFloatArray)

aidaRequestFloatArray API Stub

Definition at line 331 of file aida_pva_api.h.

REQUEST_STUB_INTEGER

#define REQUEST_STUB_INTEGER   REQUEST_STUB_SCALAR(aidaRequestInteger, int, 0)

aidaRequestInteger API Stub

Definition at line 269 of file aida_pva_api.h.

REQUEST_STUB_INTEGER_ARRAY

#define REQUEST_STUB_INTEGER_ARRAY   REQUEST_STUB_ARRAY(aidaRequestIntegerArray)

aidaRequestIntegerArray API Stub

Definition at line 321 of file aida_pva_api.h.

REQUEST_STUB_LONG

#define REQUEST_STUB_LONG   REQUEST_STUB_SCALAR(aidaRequestLong, long, 0)

aidaRequestLong API Stub

Definition at line 274 of file aida_pva_api.h.

REQUEST_STUB_LONG_ARRAY

#define REQUEST_STUB_LONG_ARRAY   REQUEST_STUB_ARRAY(aidaRequestLongArray)

aidaRequestLongArray API Stub

Definition at line 326 of file aida_pva_api.h.

REQUEST_STUB_SCALAR

#define REQUEST_STUB_SCALAR	(		_api,
			_rtype,
			_r
	)

Value:

_rtype _api(JNIEnv* env, const char* uri, Arguments arguments) \
{ \
    aidaThrowNonOsException(env, UNSUPPORTED_CHANNEL_EXCEPTION, uri); \
    return (_r); \
}

API stub for AIDA-PVA scalar requests.

Parameters

_api	the name of the API to define
_rtype	the type that this API will return
_r	the specified return value

Returns

This MACRO will create a function stub that will return the specified return value

Definition at line 243 of file aida_pva_api.h.

REQUEST_STUB_SHORT

#define REQUEST_STUB_SHORT   REQUEST_STUB_SCALAR(aidaRequestShort, short, 0)

aidaRequestShort API Stub

Definition at line 264 of file aida_pva_api.h.

REQUEST_STUB_SHORT_ARRAY

#define REQUEST_STUB_SHORT_ARRAY   REQUEST_STUB_ARRAY(aidaRequestShortArray)

aidaRequestShortArray API Stub

Definition at line 316 of file aida_pva_api.h.

REQUEST_STUB_STRING

#define REQUEST_STUB_STRING   REQUEST_STUB_SCALAR(aidaRequestString, char*, NULL)

aidaRequestString API Stub

Definition at line 289 of file aida_pva_api.h.

REQUEST_STUB_STRING_ARRAY

#define REQUEST_STUB_STRING_ARRAY

Value:

StringArray aidaRequestStringArray(JNIEnv* env, const char* uri, Arguments arguments) \
{ \
    UNSUPPORTED_STRING_ARRAY_REQUEST \
}

aidaRequestStringArray API stub

Definition at line 342 of file aida_pva_api.h.

REQUEST_STUB_TABLE

#define REQUEST_STUB_TABLE

Value:

Table aidaRequestTable(JNIEnv* env, const char* uri, Arguments arguments) \
{ \
    UNSUPPORTED_TABLE_REQUEST \
}

aidaRequestTable API stub

Definition at line 352 of file aida_pva_api.h.

RETURN_NULL_TABLE

#define RETURN_NULL_TABLE

Value:

    Table nullTable; \
    nullTable.columnCount = 0; \
    return nullTable;

Return an empty table response.

Use this if you're implementing an api that returns a Table and you've encountered an error, just after you've raised an exception.

Definition at line 380 of file aida_pva_api.h.

SET_STUB_TABLE

#define SET_STUB_TABLE

Value:

Table aidaSetValueWithResponse(JNIEnv* env, const char* uri, Arguments arguments, Value value) \
{ \
    UNSUPPORTED_TABLE_REQUEST \
}

aidaSetValueWithResponse API stub

Definition at line 370 of file aida_pva_api.h.

SET_STUB_VOID

#define SET_STUB_VOID

Value:

void aidaSetValue(JNIEnv* env, const char* uri, Arguments arguments, Value value) \
{ \
    aidaThrowNonOsException(env, UNSUPPORTED_CHANNEL_EXCEPTION, uri); \
}

aidaSetValue API stub

Definition at line 361 of file aida_pva_api.h.

VERSION

#define VERSION

(

_version

)

Value:

    char *getVersion() { \
    return _version ; \
}

Use this macro to define the version of the provider.

Definition at line 40 of file aida_pva_api.h.

Function Documentation

aidaRequestBoolean()

int aidaRequestBoolean	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a boolean.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the boolean

In fact this is implemented by getting a short and returning true if it is 0 and false otherwise

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the boolean

Get a boolean.

Parameters

uri	the uri
env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
arguments	the arguments

Returns

the boolean

Definition at line 43 of file AIDASLCDB_SERVER.c.

{
    int val = 0;
    TO_SLC_NAME(uri, slcName)
    vmsstat_t status = JNI_DBGETINT(slcName, &val);
 
    if (!SUCCESS(status)) {
        aidaThrow(env, status, UNABLE_TO_GET_DATA_EXCEPTION, "getting SLC db boolean device data");
    }
 
    // Return logical
    return val != 0;
}

References aidaThrow(), aidaThrowNonOsException(), ascanf(), endsWith(), TO_SLC_NAME, UNABLE_TO_GET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

Referenced by aidaRequestTable().

aidaRequestBooleanArray()

Array aidaRequestBooleanArray	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a boolean array.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the boolean array

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the boolean array

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the boolean array

Definition at line 212 of file AIDASLCDB_SERVER.c.

{
    Array booleanArray;
    booleanArray.count = 0;
    booleanArray.items = NULL;
 
    TO_SLC_NAME(uri, slcName)
    vmsstat_t status = JNI_DBGETINTA(slcName, (int**)(&booleanArray.items));
 
    if (!SUCCESS(status)) {
        aidaThrow(env, status, UNABLE_TO_GET_DATA_EXCEPTION, "getting SLC db boolean array device data");
    }
 
    // First item is the count
    booleanArray.count = *((int*)booleanArray.items);
 
    // update values to contain booleans instead of integers
    for (int i = 0; i < booleanArray.count; i++) {
        ((int*)booleanArray.items)[i] = ((int*)booleanArray.items)[i] != 0;
    }
    return booleanArray;
}

References aidaThrow(), aidaThrowNonOsException(), ALLOCATE_MEMORY_AND_ON_ERROR_RETURN_, ascanf(), Array::count, endsWith(), Array::items, TO_SLC_NAME, UNABLE_TO_GET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

Referenced by aidaRequestTable().

aidaRequestByte()

char aidaRequestByte	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a byte.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the byte

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the byte

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the byte

Definition at line 65 of file AIDASLCDB_SERVER.c.

{
    unsigned char val = 0;
    TO_SLC_NAME(uri, slcName)
    vmsstat_t status = JNI_DBGETBYTE(slcName, &val);
 
    if (!SUCCESS(status)) {
        aidaThrow(env, status, UNABLE_TO_GET_DATA_EXCEPTION, "getting SLC db byte device data");
    }
 
    return (char)val;
}

References aidaThrow(), aidaThrowNonOsException(), ascanf(), endsWith(), TO_SLC_NAME, UNABLE_TO_GET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

Referenced by aidaRequestTable().

aidaRequestByteArray()

Array aidaRequestByteArray	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a byte array.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the byte array

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the byte array

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the byte array

Definition at line 243 of file AIDASLCDB_SERVER.c.

{
    Array byteArray;
    byteArray.count = 0;
    byteArray.items = NULL;
 
    TO_SLC_NAME(uri, slcName)
    vmsstat_t status = JNI_DBGETBYTEA(slcName, (unsigned char**)(&byteArray.items));
 
    if (!SUCCESS(status)) {
        aidaThrow(env, status, UNABLE_TO_GET_DATA_EXCEPTION, "getting SLC db byte array device data");
    }
 
    byteArray.count = (int)strlen(byteArray.items);
    return byteArray;
}

References aidaThrow(), aidaThrowNonOsException(), ALLOCATE_MEMORY_AND_ON_ERROR_RETURN_, ascanf(), Array::count, endsWith(), Array::items, TO_SLC_NAME, UNABLE_TO_GET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

Referenced by aidaRequestTable().

aidaRequestDouble()

double aidaRequestDouble	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a double.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the double

In fact this is implemented by getting a float and converting the return to a double

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the double

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the double

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the double

Definition at line 170 of file AIDASLCDB_SERVER.c.

{
    float val = 0.0f; /* Returned in ieee format */
    TO_SLC_NAME(uri, slcName)
    vmsstat_t status = JNI_DBGETFLOAT(slcName, &val);
 
    if (!SUCCESS(status)) {
        aidaThrow(env, status, UNABLE_TO_GET_DATA_EXCEPTION, "getting SLC db double device data");
    }
 
    return val;
}

References aidaThrow(), aidaThrowNonOsException(), ascanf(), CONVERT_FROM_VMS_DOUBLE, endsWith(), TO_SLC_NAME, UNABLE_TO_GET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

Referenced by aidaRequestTable().

aidaRequestDoubleArray()

Array aidaRequestDoubleArray	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a double array.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the double array

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the double array

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the double array

Definition at line 418 of file AIDASLCDB_SERVER.c.

{
    TRACK_ALLOCATED_MEMORY
    Array doubleArray;
    doubleArray.count = 0;
    doubleArray.items = NULL;
 
    TO_SLC_NAME(uri, slcName)
    vmsstat_t status = JNI_DBGETFLOATA(slcName, (float**)(&doubleArray.items));
    TRACK_MEMORY(doubleArray.items)
 
    if (!SUCCESS(status)) {
        FREE_MEMORY
        aidaThrow(env, status, UNABLE_TO_GET_DATA_EXCEPTION, "getting SLC db double array device data");
    }
 
    // First item is the count
    doubleArray.count = (int)*((float*)doubleArray.items);
 
    // Copy floats to new double array and free up returned float array
    double* doubleData;
    ALLOCATE_AND_TRACK_MEMORY_AND_ON_ERROR_RETURN_(env, doubleData, doubleArray.count * sizeof(double),
            "SLC db float array device data",
            doubleArray)
    for (int i = 0; i < doubleArray.count; i++) {
        doubleData[i] = ((float*)doubleArray.items)[i + 1];
    }
    FREE_TRACKED_MEMORY(doubleArray.items)
    doubleArray.items = doubleData;
 
    return doubleArray;
}

References aidaThrow(), aidaThrowNonOsException(), ALLOCATE_AND_TRACK_MEMORY_AND_ON_ERROR_RETURN_, ALLOCATE_MEMORY_AND_ON_ERROR_RETURN_, ascanf(), Array::count, endsWith(), FREE_MEMORY, FREE_TRACKED_MEMORY, Array::items, TO_SLC_NAME, TRACK_ALLOCATED_MEMORY, TRACK_MEMORY, UNABLE_TO_GET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

Referenced by aidaRequestTable().

aidaRequestFloat()

float aidaRequestFloat	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a float.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the float

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the float

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the float

Definition at line 149 of file AIDASLCDB_SERVER.c.

{
    float val = 0.0f; /* Returned in ieee format */
    TO_SLC_NAME(uri, slcName)
    vmsstat_t status = JNI_DBGETFLOAT(slcName, &val);
 
    if (!SUCCESS(status)) {
        aidaThrow(env, status, UNABLE_TO_GET_DATA_EXCEPTION, "getting SLC db floating point device data");
    }
 
    return val;
}

References aidaThrow(), aidaThrowNonOsException(), ascanf(), endsWith(), TO_SLC_NAME, UNABLE_TO_GET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

Referenced by aidaRequestTable().

aidaRequestFloatArray()

Array aidaRequestFloatArray	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a float array.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the float array

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the float array

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the float array

Definition at line 381 of file AIDASLCDB_SERVER.c.

{
    TRACK_ALLOCATED_MEMORY
    Array floatArray;
    floatArray.count = 0;
    floatArray.items = NULL;
 
    TO_SLC_NAME(uri, slcName)
    vmsstat_t status = JNI_DBGETFLOATA(slcName, (float**)(&floatArray.items));
    TRACK_MEMORY(floatArray.items)
 
    if (!SUCCESS(status)) {
        FREE_MEMORY
        aidaThrow(env, status, UNABLE_TO_GET_DATA_EXCEPTION, "getting SLC db float array device data");
    }
 
    // First item is the count
    floatArray.count = (int)*((float*)floatArray.items);
 
    // Copy floats to new float array and free up returned float array
    float* floatData;
    ALLOCATE_COPY_AND_TRACK_MEMORY_AND_ON_ERROR_RETURN_(env, floatData, &((float*)floatArray.items)[1],
            floatArray.count * sizeof(float),
            "SLC db float array device data", floatArray)
    FREE_TRACKED_MEMORY(floatArray.items)
    floatArray.items = floatData;
    return floatArray;
}

References aidaThrow(), aidaThrowNonOsException(), ALLOCATE_COPY_AND_TRACK_MEMORY_AND_ON_ERROR_RETURN_, ALLOCATE_MEMORY_AND_ON_ERROR_RETURN_, ascanf(), Array::count, endsWith(), FREE_MEMORY, FREE_TRACKED_MEMORY, Array::items, TO_SLC_NAME, TRACK_ALLOCATED_MEMORY, TRACK_MEMORY, UNABLE_TO_GET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

Referenced by aidaRequestTable().

aidaRequestInteger()

int aidaRequestInteger	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a integer.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the integer

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the integer

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the integer

Get a integer.

Parameters

uri	the uri
env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
arguments	the arguments

Returns

the integer

Definition at line 107 of file AIDASLCDB_SERVER.c.

{
    int val = 0;
    TO_SLC_NAME(uri, slcName)
    vmsstat_t status = JNI_DBGETINT(slcName, &val);
 
    if (!SUCCESS(status)) {
        aidaThrow(env, status, UNABLE_TO_GET_DATA_EXCEPTION, "getting SLC db integer device data");
    }
 
    return val;
}

References aidaThrow(), aidaThrowNonOsException(), ascanf(), endsWith(), TO_SLC_NAME, UNABLE_TO_GET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

Referenced by aidaRequestTable().

aidaRequestIntegerArray()

Array aidaRequestIntegerArray	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a integer array.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the integer array

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the integer array

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the integer array

Definition at line 305 of file AIDASLCDB_SERVER.c.

{
    TRACK_ALLOCATED_MEMORY
    Array integerArray;
    integerArray.count = 0;
    integerArray.items = NULL;
 
    TO_SLC_NAME(uri, slcName)
    vmsstat_t status = JNI_DBGETINTA(slcName, (int**)(&integerArray.items));
    TRACK_MEMORY(integerArray.items)
 
    if (!SUCCESS(status)) {
        FREE_MEMORY
        aidaThrow(env, status, UNABLE_TO_GET_DATA_EXCEPTION, "getting SLC db int array device data");
    }
 
    // First item is the count
    integerArray.count = *((int*)integerArray.items);
 
    // Copy integers to new integer array and free up returned integer array
    int* integerData;
    ALLOCATE_COPY_AND_TRACK_MEMORY_AND_ON_ERROR_RETURN_(env, integerData, &((int*)integerArray.items)[1],
            integerArray.count * sizeof(int),
            "SLC db integer array device data", integerArray)
    FREE_TRACKED_MEMORY(integerArray.items)
    integerArray.items = integerData;
    return integerArray;
}

References aidaThrow(), aidaThrowNonOsException(), ALLOCATE_COPY_AND_TRACK_MEMORY_AND_ON_ERROR_RETURN_, ALLOCATE_MEMORY_AND_ON_ERROR_RETURN_, ascanf(), Array::count, endsWith(), FREE_MEMORY, FREE_TRACKED_MEMORY, Array::items, TO_SLC_NAME, TRACK_ALLOCATED_MEMORY, TRACK_MEMORY, UNABLE_TO_GET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

Referenced by aidaRequestTable().

aidaRequestLong()

long aidaRequestLong	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a long.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the long

In fact this is implemented by getting an integer and then converting the return value to a long

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the long

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the long

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the long

Get a long.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the integer

Definition at line 128 of file AIDASLCDB_SERVER.c.

{
    int val = 0;
    TO_SLC_NAME(uri, slcName)
    vmsstat_t status = JNI_DBGETINT(slcName, &val);
 
    if (!SUCCESS(status)) {
        aidaThrow(env, status, UNABLE_TO_GET_DATA_EXCEPTION, "getting SLC db long device data");
    }
 
    return val;
}

References aidaThrow(), aidaThrowNonOsException(), ascanf(), endsWith(), startsWith(), TO_SLC_NAME, UNABLE_TO_GET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

Referenced by aidaRequestTable().

aidaRequestLongArray()

Array aidaRequestLongArray	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a long array.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the long array

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the long array

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the long array

Definition at line 342 of file AIDASLCDB_SERVER.c.

{
    TRACK_ALLOCATED_MEMORY
    Array longArray;
    longArray.count = 0;
    longArray.items = NULL;
 
    TO_SLC_NAME(uri, slcName)
    vmsstat_t status = JNI_DBGETINTA(slcName, (int**)(&longArray.items));
    TRACK_MEMORY(longArray.items)
 
    if (!SUCCESS(status)) {
        FREE_MEMORY
        aidaThrow(env, status, UNABLE_TO_GET_DATA_EXCEPTION, "getting SLC db long array device data");
    }
 
    // First item is the count
    longArray.count = *((int*)longArray.items);
 
    // Copy integers to new long array and free up returned integer array
    long* longData;
    ALLOCATE_AND_TRACK_MEMORY_AND_ON_ERROR_RETURN_(env, longData, longArray.count * sizeof(long),
            "SLC db long array device data", longArray)
    for (int i = 0; i < longArray.count; i++) {
        longData[i] = (long)((int*)longArray.items)[i + 1];
    }
    FREE_TRACKED_MEMORY(longArray.items)
    longArray.items = longData;
    return longArray;
}

References aidaThrow(), aidaThrowNonOsException(), ALLOCATE_AND_TRACK_MEMORY_AND_ON_ERROR_RETURN_, ALLOCATE_MEMORY_AND_ON_ERROR_RETURN_, ascanf(), Array::count, endsWith(), FREE_MEMORY, FREE_TRACKED_MEMORY, Array::items, TO_SLC_NAME, TRACK_ALLOCATED_MEMORY, TRACK_MEMORY, UNABLE_TO_GET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

Referenced by aidaRequestTable().

aidaRequestShort()

short aidaRequestShort	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a short.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the short

Parameters

uri	the uri
env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
arguments	the arguments

Returns

the short

Parameters

uri	the uri
env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
arguments	the arguments

Returns

the short

Parameters

uri	the uri
env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
arguments	the arguments

Returns

the short

Parameters

uri	the uri
env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
arguments	the arguments

Returns

the short

Definition at line 86 of file AIDASLCDB_SERVER.c.

{
    short int val = 0;
    TO_SLC_NAME(uri, slcName)
    vmsstat_t status = JNI_DBGETSHORT(slcName, &val);
 
    if (!SUCCESS(status)) {
        aidaThrow(env, status, UNABLE_TO_GET_DATA_EXCEPTION, "getting SLC db short device data");
    }
 
    return val;
}

References aidaThrow(), aidaThrowNonOsException(), ascanf(), endsWith(), startsWith(), TO_SLC_NAME, UNABLE_TO_GET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

Referenced by aidaRequestTable().

aidaRequestShortArray()

Array aidaRequestShortArray	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a short array.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the short array

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the short array

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the short array

Definition at line 268 of file AIDASLCDB_SERVER.c.

{
    TRACK_ALLOCATED_MEMORY
    Array shortArray;
    shortArray.count = 0;
    shortArray.items = NULL;
 
    TO_SLC_NAME(uri, slcName)
    vmsstat_t status = JNI_DBGETSHORTA(slcName, (short**)(&shortArray.items));
    TRACK_MEMORY(shortArray.items)
 
    if (!SUCCESS(status)) {
        FREE_MEMORY
        aidaThrow(env, status, UNABLE_TO_GET_DATA_EXCEPTION, "getting SLC db short array device data");
    }
 
    // First item is the count
    shortArray.count = (int)*((short*)shortArray.items);
 
    // Copy shorts to new short array and free up returned short array
    short* shortData;
    ALLOCATE_COPY_AND_TRACK_MEMORY_AND_ON_ERROR_RETURN_(env, shortData, &((short*)shortArray.items)[1],
            shortArray.count * sizeof(short),
            "SLC db short array device data", shortArray)
    FREE_TRACKED_MEMORY(shortArray.items)
    shortArray.items = shortData;
    return shortArray;
}

References aidaThrow(), aidaThrowNonOsException(), ALLOCATE_COPY_AND_TRACK_MEMORY_AND_ON_ERROR_RETURN_, ALLOCATE_MEMORY_AND_ON_ERROR_RETURN_, ascanf(), Array::count, endsWith(), FREE_MEMORY, FREE_TRACKED_MEMORY, Array::items, TO_SLC_NAME, TRACK_ALLOCATED_MEMORY, TRACK_MEMORY, UNABLE_TO_GET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

Referenced by aidaRequestTable().

aidaRequestString()

char * aidaRequestString	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a string.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the string

Allocate memory for string and it will be freed for you by framework

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the string

Definition at line 191 of file AIDASLCDB_SERVER.c.

{
    char* val = NULL;
    TO_SLC_NAME(uri, slcName)
    vmsstat_t status = JNI_DBGETSTRING(slcName, &val);
 
    if (!SUCCESS(status)) {
        aidaThrow(env, status, UNABLE_TO_GET_DATA_EXCEPTION, "getting SLC db string device data");
    }
 
    return val;
}

References aidaThrow(), aidaThrowNonOsException(), ALLOCATE_MEMORY_AND_ON_ERROR_RETURN_, ALLOCATE_STRING, ascanf(), endsWith(), ON_EXCEPTION_RETURN_, startsWith(), TO_SLC_NAME, UNABLE_TO_GET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

Referenced by aidaRequestStringArray(), and aidaRequestTable().

aidaRequestStringArray()

StringArray aidaRequestStringArray	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a string array.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the string array

Get a string array.

If the primary is ASTS and the pseudo-secondary is either CTRL, STAT, VSTA, parse the text, color, and flag fields from the string returned by aidaRequestString(). The text, color, and flag substrings are then returned in an array

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the string array

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the string array

Definition at line 465 of file AIDASLCDB_SERVER.c.

{
    TRACK_ALLOCATED_MEMORY
    const char* secondary = secondaryFromUri(uri);
    // If not ASTS and CTRL, STAT or VSTA
    if (!startsWith(uri, "ASTS") || (strcasecmp(secondary, "CTRL") != 0 && strcasecmp(secondary, "STAT") != 0
            && strcasecmp(secondary, "VSTA") != 0)) {
        UNSUPPORTED_STRING_ARRAY_REQUEST
    }
    StringArray stringArray;
    stringArray.count = 0;
 
    char* colorString = aidaRequestString(env, uri, arguments);
    ON_EXCEPTION_RETURN_(stringArray)
    TRACK_MEMORY(colorString)
 
    //    The substring returned by aidaRequestString is 19
    //    characters long and contains the text substring
    //    in characters 0-7, the color substring in
    //    characters 9-16, and the flag substring in
    //    character position 18.
 
    // Space for pointers for each string
    stringArray.count = 3;
    ALLOCATE_AND_TRACK_MEMORY_AND_ON_ERROR_RETURN_(env, stringArray.items, stringArray.count * sizeof(char*),
            "color string array", stringArray)
    char** strings = ((char**)(stringArray.items));
 
    //Create a local version of the string and free the original
    char localColorString[TOTAL_PSEUDO_SECONDARY_LEN + 1];
    memset(localColorString, ' ', TOTAL_PSEUDO_SECONDARY_LEN);
    if (colorString) {
        memcpy(localColorString, colorString, strlen(colorString));
        localColorString[TOTAL_PSEUDO_SECONDARY_LEN] = 0x0;
        FREE_TRACKED_MEMORY(colorString)
    }
 
    ALLOCATE_AND_TRACK_FIXED_LENGTH_STRING_AND_ON_ERROR_RETURN_(env, strings[0],
            localColorString,
            TEXT_SUBSTRING + 1, "text substring in color string array", stringArray)
    ALLOCATE_AND_TRACK_FIXED_LENGTH_STRING_AND_ON_ERROR_RETURN_(env, strings[1],
            &localColorString[TEXT_SUBSTRING + 1],
            COLOR_SUBSTRING + 1, "color substring in color string array", stringArray)
    ALLOCATE_AND_TRACK_FIXED_LENGTH_STRING_AND_ON_ERROR_RETURN_(env, strings[2],
            &localColorString[TEXT_SUBSTRING + COLOR_SUBSTRING + 2],
            FLAG_SUBSTRING + 1, "flag substring in color string array", stringArray)
    return stringArray;
}

References aidaRequestString(), aidaThrowNonOsException(), ALLOCATE_AND_TRACK_FIXED_LENGTH_STRING_AND_ON_ERROR_RETURN_, ALLOCATE_AND_TRACK_MEMORY_AND_ON_ERROR_RETURN_, ALLOCATE_MEMORY_AND_ON_ERROR_RETURN_, ALLOCATE_STRING_AND_ON_ERROR_RETURN_, ascanf(), StringArray::count, endsWith(), FREE_TRACKED_MEMORY, StringArray::items, ON_EXCEPTION_RETURN_, secondaryFromUri(), startsWith(), TRACK_ALLOCATED_MEMORY, TRACK_MEMORY, UNSUPPORTED_CHANNEL_EXCEPTION, and UNSUPPORTED_STRING_ARRAY_REQUEST.

aidaRequestTable()

Table aidaRequestTable	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments
	)

Get a table of data.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the table

Get a table of data.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the table

Get a table of data.

Default is 1 BPMS: json. List of BPMs to read ["BPMS:LI02:501", "BPMS:DR12:334"] DEVS: json. List of devices to read Note: cannot specify both BPMS and DEVS

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the table

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the table

Get a table of data.

This is the entry point for getting the klystron device status for one or more klystrons

For one klystron the uri is KLYS:<micr><unit>:TACT For multiple the uri is KLYSTRONGET:TACT and a mandatory parameter DEVICES contains an array of klystrons to query e.g. DEVICES=["KLYS:LI31:31", "KLYS:LI31:32"]

If all of the queries fail then an exception is raised. Otherwise the following fields are returned: name STRING device name <micr>:<unit> opstat BOOLEAN operation status (true = success, false = failure) status SHORT klystron status accel BOOLEAN is in accelerate state standby BOOLEAN is in standby mode bad BOOLEAN is bad? sled BOOLEAN true is sled sleded BOOLEAN true if sleded pampl BOOLEAN true if pampl pphas BOOLEAN true if pphas

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the table

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the table

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the table

Get a table of data.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments

Returns

the table

The FILE contains the name of the button file and is used The PRIMSTV contains a structure with configuration for the primary step variable The SECNSTV optionally contains a structure with configuration for the secondary step variable

First the button file is loaded and then it is executed. A table with the following fields is returned: primary FLOAT_ARRAY value of primary step variable for this data set secondary FLOAT_ARRAY value of secondary step variable for this data set. Omitted if no secondary step variable specified samp{n} FLOAT_ARRAY For each sample variable found in the given FILE a column is returned. {n} is the sample var number

The labels for each column are set to the device name

Definition at line 66 of file AIDASLCBPM_SERVER.c.

{
    TRACK_ALLOCATED_MEMORY
 
    // Get arguments
    int bpmd, navg = NAVG, cnfnum = BPMD_ROGUE, sortOrder = SORTORDER_DISPLAY, cnftype = CNFTYPE_NONE;
    char* cfnTypeString = NULL;
 
    if (ascanf(env, &arguments, "%d %od %od %od %os",
            "bpmd", &bpmd,
            "n", &navg,
            "cnfnum", &cnfnum,
            "sortOrder", &sortOrder,
            "cnftype", &cfnTypeString
    )) {
        RETURN_NULL_TABLE
    }
    TRACK_MEMORY(cfnTypeString)
 
    // If cfnType was set then set cnftype variable appropriately
    if (cfnTypeString) {
        if (strcasecmp(cfnTypeString, "NONE") == 0) {
            cnftype = CNFTYPE_NONE;
        } else if (strcasecmp(cfnTypeString, "GOLD") == 0) {
            cnftype = CNFTYPE_GOLD;
        } else if (strcasecmp(cfnTypeString, "LOADED") == 0) {
            cnftype = CNFTYPE_LOADED;
        } else if (strcasecmp(cfnTypeString, "SCRATCH") == 0) {
            cnftype = CNFTYPE_SCRATCH;
        } else if (strcasecmp(cfnTypeString, "NORMAL") == 0) {
            cnftype = CNFTYPE_NORMAL;
        } else if (strcasecmp(cfnTypeString, "TEMPORARY") == 0) {
            cnftype = CNFTYPE_TEMPORARY;
        } else {
            aidaThrowNonOsException(env, UNABLE_TO_GET_DATA_EXCEPTION, "CNFTYPE argument not recognised");
            FREE_MEMORY
            RETURN_NULL_TABLE
        }
 
        FREE_MEMORY
 
        // Check that if a cnftype that requires a config number to be given
        // that one was given.
        if ((cnftype == CNFTYPE_SCRATCH || cnftype == CNFTYPE_NORMAL || cnftype == CNFTYPE_TEMPORARY)
                && cnfnum <= BPMD_ROGUE) {
            aidaThrowNonOsException(env, UNABLE_TO_GET_DATA_EXCEPTION,
                    "A CNFNUM argument (>0) is required with the CFNTYPE argument given");
            RETURN_NULL_TABLE
        }
    }
 
    // Check parameters
    if (checkArguments(env, bpmd, navg, cnfnum, sortOrder, cnftype)) {
        RETURN_NULL_TABLE
    }
 
    // Acquire BPM Data
    int rows;
    if (acquireBpmData(env, &rows, bpmd, navg, cnftype, cnfnum, sortOrder)) {
        RETURN_NULL_TABLE
    }
 
    // No rows
    if (!rows) {
        aidaThrowNonOsException(env, UNABLE_TO_GET_DATA_EXCEPTION, "No rows were retrieved for your query");
        RETURN_NULL_TABLE
    }
 
    if (rows > MAX_DGRP_BPMS) {
        aidaThrowNonOsException(env, UNABLE_TO_GET_DATA_EXCEPTION, "Too many rows returned by this query");
        RETURN_NULL_TABLE
    }
 
    // To hold data
    char namesData[rows + 1][NAME_SIZE];
    float xData[rows + 1], yData[rows + 1], tmitData[rows + 1], zData[rows + 1];
    unsigned long hstasData[rows + 1], statsData[rows + 1];
 
    // Get BPM data
    if (getBpmData(env, namesData, xData, yData, tmitData, zData, hstasData, statsData)) {
        RETURN_NULL_TABLE
    }
 
    // Make and output table
    Table table = tableCreate(env, rows, 7);
    ON_EXCEPTION_RETURN_(table)
    tableAddFixedWidthStringColumn(env, &table, (char*)namesData, NAME_SIZE);
    ON_EXCEPTION_RETURN_(table)
    tableAddColumn(env, &table, AIDA_FLOAT_TYPE, xData, false);
    ON_EXCEPTION_RETURN_(table)
    tableAddColumn(env, &table, AIDA_FLOAT_TYPE, yData, false);
    ON_EXCEPTION_RETURN_(table)
    tableAddColumn(env, &table, AIDA_FLOAT_TYPE, tmitData, false);
    ON_EXCEPTION_RETURN_(table)
    tableAddColumn(env, &table, AIDA_FLOAT_TYPE, zData, false);
    ON_EXCEPTION_RETURN_(table)
    tableAddColumn(env, &table, AIDA_INTEGER_TYPE, hstasData, false);
    ON_EXCEPTION_RETURN_(table)
    tableAddColumn(env, &table, AIDA_INTEGER_TYPE, statsData, false);
 
    endAcquireBpmData(env);
 
    // All read successfully
    return table;
}

References AIDA_BOOLEAN_ARRAY_TYPE, AIDA_BOOLEAN_TYPE, AIDA_BYTE_ARRAY_TYPE, AIDA_DOUBLE_ARRAY_TYPE, AIDA_FLOAT_ARRAY_TYPE, AIDA_FLOAT_TYPE, AIDA_INTEGER_ARRAY_TYPE, AIDA_INTEGER_TYPE, AIDA_LONG_ARRAY_TYPE, AIDA_SHORT_ARRAY_TYPE, AIDA_SHORT_TYPE, aidaRequestBoolean(), aidaRequestBooleanArray(), aidaRequestByte(), aidaRequestByteArray(), aidaRequestDouble(), aidaRequestDoubleArray(), aidaRequestFloat(), aidaRequestFloatArray(), aidaRequestInteger(), aidaRequestIntegerArray(), aidaRequestLong(), aidaRequestLongArray(), aidaRequestShort(), aidaRequestShortArray(), aidaRequestString(), aidaThrow(), aidaThrowNonOsException(), ALLOCATE_AND_TRACK_MEMORY_AND_ON_ERROR_RETURN_, ascanf(), Table::columnCount, Array::count, endsWith(), FREE_MEMORY, FREE_TRACKED_MEMORY, Array::items, ON_EXCEPTION_FREE_MEMORY_AND_RETURN_, ON_EXCEPTION_RETURN_, pmuFromDeviceName(), RETURN_NULL_TABLE, SPRINTF_ERROR_FREE_MEMORY_AND_RETURN_, SPRINTF_ERROR_STATUS_FREE_MEMORY_AND_RETURN_, tableAddColumn(), tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowStringColumn(), tableAddStringColumn(), tableCreate(), tableCreateDynamic(), TO_DGROUP, TO_LEGACY_NAME, TRACK_ALLOCATED_MEMORY, TRACK_MEMORY, UNABLE_TO_GET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

aidaServiceInit()

void aidaServiceInit

(

JNIEnv *

env

)

Initialise the aida service.

Called once by the framework when starting up.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()

Initialise the aida service.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()

Exceptions

ServerInitialisationException

if the service fails to initialise

Definition at line 42 of file AIDASLCBPM_SERVER.c.

{
    vmsstat_t status;
 
    if (!$VMS_STATUS_SUCCESS(status = init("AIDA_SLCBPM", true))) {
        aidaThrow(env, status, SERVER_INITIALISATION_EXCEPTION, "initialising SLC BPM Service");
    } else {
        printf("AIDA-PVA BPM Provider\n");
    }
}

References aidaThrow(), init(), and SERVER_INITIALISATION_EXCEPTION.

aidaSetValue()

void aidaSetValue	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments,
		Value	value
	)

Set a value.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments
value	to set

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments
value	to set

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments
value	to set

Set a value.

The VALUE argument given in value will contain a structure containing two elements:

• names: an array of magnet names
• values: an array of corresponding values

e.g. { "names": [... ], "values": [... ] }

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments of type Arguments
value	to set. Contains a structure containing two elements: names: an array of magnet names values: an array of corresponding values.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments
value	to set

Set a value.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments
value	to set

Definition at line 656 of file AIDASLCDB_SERVER.c.

{
    TRACK_ALLOCATED_MEMORY
 
    if (!JNI_DBACCESSENABLED()) {
        aidaThrowNonOsException(env, UNABLE_TO_GET_DATA_EXCEPTION,
                "Aida access for SLC Database set operations are not currently enabled");
        return;
    }
 
    // Get optional VALUE_TYPE parameter
    char* specifiedValueType = "FLOAT_ARRAY";
    if (ascanf(env, &arguments, "%os", "VALUE_TYPE", &specifiedValueType)) {
        return;
    }
 
    vmsstat_t status;
    unsigned int length;
    TO_SLC_NAME(uri, slcName)
 
    if (strcasecmp(specifiedValueType, "FLOAT_ARRAY") == 0) {
        // If VALUE_TYPE is FLOAT_ARRAY then set float array
        float* data;
        if (avscanf(env, &arguments, &value, "%fa", "value", &data, &length)) {
            return;
        }
        TRACK_MEMORY(data)
        CONVERT_TO_VMS_FLOAT(data, length)
        status = JNI_DBSETFLOAT(slcName, data, (int)length);
    } else if (strcasecmp(specifiedValueType, "INTEGER_ARRAY") == 0) {
        // If VALUE_TYPE is INTEGER_ARRAY then set int array
        int* data;
        if (avscanf(env, &arguments, &value, "%da", "value", &data, &length)) {
            return;
        }
        TRACK_MEMORY(data)
        status = JNI_DBSETINT(slcName, data, (int)length);
    } else {
        aidaThrowNonOsException(env, UNABLE_TO_SET_DATA_EXCEPTION,
                "Invalid VALUE_TYPE specified for SLC Database set operation");
        return;
    }
 
    FREE_MEMORY
    if (!SUCCESS(status)) {
        aidaThrow(env, status, UNABLE_TO_SET_DATA_EXCEPTION, "setting SLC db array device data");
    }
}

References aidaThrow(), aidaThrowNonOsException(), ascanf(), avscanf(), CONVERT_TO_VMS_FLOAT, FREE_MEMORY, startsWith(), TO_SLC_NAME, TRACK_ALLOCATED_MEMORY, TRACK_MEMORY, UNABLE_TO_GET_DATA_EXCEPTION, and UNABLE_TO_SET_DATA_EXCEPTION.

aidaSetValueWithResponse()

Table aidaSetValueWithResponse	(	JNIEnv *	env,
		const char *	uri,
		Arguments	arguments,
		Value	value
	)

Set a value and return a table as a response.

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments
value	to set

Returns

a table

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments
value	to set

Returns

a table

Set a value and return a table as a response.

Then optionally performs a specified trim or perturb operation.

The VALUE argument will contain a structure containing two elements:

• names: an array of magnet names
• values: an array of corresponding values

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException(env, exception, message)
uri	the uri - MAGNETSET:BDES or MAGNETSET:BCON
arguments	the arguments. MAGFUNC: required: argument specifies whether a trim or perturb operation will be performed. If NOFUNC, neither a trim nor a perturb operation will be performed TRIM, PTRB, or NOFUNC LIMITCHECK: optional: Used to determine behavior when the set value for one or more devices is outside of its low/high limits. ALL The entire request will fail resulting in an exception being thrown and no BDES / VDES values being set for any of the requested devices. SOME the set value action will succeed for those set values that are within limits and will not be performed for those set values outside their limits (the state string return values for these devices will be set to the string "Outside Limits"). The default setting of this parameter is ALL.
value	to set. Contains a structure containing two elements: names: an array of magnet names values: an array of corresponding values.

Returns

a table

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments
value	to set

Returns

a table

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments
value	to set

Returns

a table

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
uri	the uri
arguments	the arguments
value	to set

Returns

a table

Definition at line 450 of file AIDASLCKLYS_SERVER.c.

{
    if (!DPSLCKLYS_ACCESSENABLED()) {
        aidaThrowNonOsException(env, UNABLE_TO_SET_DATA_EXCEPTION,
                "Aida access to klystron operations is not currently enabled");
        RETURN_NULL_TABLE
    }
 
    PMU_STRING_FROM_URI(pmu_str, uri)
 
    if (endsWith(uri, "TACT")) {
        return setActivateValue(env, uri, arguments, value);
    } else if (endsWith(uri, "PDES")) {
        return setPdesValue(env, uri, arguments, value, pmu_str, "PDES");
    } else if (endsWith(uri, "KPHR")) {
        return setKphrValue(env, uri, arguments, value, pmu_str, "KPHR");
    } else {
        aidaThrowNonOsException(env, UNSUPPORTED_CHANNEL_EXCEPTION, uri);
        RETURN_NULL_TABLE
    }
}

References AIDA_FLOAT_TYPE, aidaThrow(), aidaThrowNonOsException(), avscanf(), CONVERT_FROM_VMS_FLOAT, CONVERT_TO_VMS_FLOAT, endsWith(), FREE_MEMORY, MICRO_LEN, ON_EXCEPTION_RETURN_, PMU_STRING_FROM_URI, PRIM_LEN, RETURN_NULL_TABLE, tableAddColumn(), tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowDoubleColumn(), tableCreate(), TRACK_ALLOCATED_MEMORY, TRACK_MEMORY, UNABLE_TO_SET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.

getVersion()

char * getVersion

(

)

Function provided by all providers to give the version string.

Returns

the version string