The Header File for the AIDA-PVA Module functions. More...

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <ctype.h>
#include <stsdef.h>
#include <stdbool.h>
#include <jni.h>
#include "slc_macros.h"
#include "msg_proto.h"
#include "errtranslate.h"
#include "ref.h"
#include "process_parm.h"
#include "aida_pva_json.h"
#include "aida_pva_types.h"
#include "aida_pva_exceptions.h"
#include "aida_pva_api.h"
#include "aida_pva_convert.h"
#include "aida_pva_memory.h"
#include "aida_pva_uri.h"

Functions
void	aidaThrow (JNIEnv env, vmsstat_t status, char exception, const char *message)
	Exception Handling. More...

void	aidaThrowNonOsException (JNIEnv env, char exception, const char *message)
	To log any non-OS exceptions and throw back to java. More...

void *	allocateMemory (JNIEnv env, void source, size_t size, bool nullTerminate, char *message)
	Memory Handling. More...

int	ascanf (JNIEnv env, Arguments arguments, const char *formatString,...)
	Argument Processing. More...

int	avscanf (JNIEnv env, Arguments arguments, Value value, const char formatString,...)
	ascanf(), avscanf() More...

int	endsWith (const char str, char suffix)
	String Handling. More...

int	groupNameFromUri (char groupName[], const char *uri)
	URI Handling for group, secn, pmu and slacName. More...

vmsstat_t	init (const char *processName, bool initMessageServices)
	Initialisation. More...

int	pmuFromDeviceName (JNIEnv env, char device, char primary, char micro, int4u *unit)
	Get primary, micro and unit from a device name. More...

void	pmuStringFromUri (char pmuString, const char uri)
	Get the pmu part of a URI. More...

void	releaseArray (Array array)
	Free up any memory allocated the given scalar array. More...

void	releasePvAndArguments (JNIEnv env, jstring uri, const char pv, Arguments arguments)
	Free up any memory allocated for the given pv and arguments. More...

void	releaseStringArray (StringArray array)
	Free up any memory allocated for string arrays. More...

void	releaseTable (Table table)
	Free up any memory allocated for the given table. More...

void	releaseValue (Value value)
	Release all allocated memory in the given value. More...

void	secnFromUri (const char uri, int4u secn)
	Get secondary from pseudo secondary (containing a colon) number from URI. More...

const char *	secondaryFromUri (const char *uri)
	Get secondary from URI. More...

int	startsWith (const char str, char prefix)
	Check if a string starts with another string. More...

void	tableAddColumn (JNIEnv env, Table table, Type type, void *data, bool ieeeFormat)
	Add a column of arbitrary type to a Table. More...

void	tableAddField (JNIEnv env, Table table, char *fieldName)
	Add a dynamic field to a table. More...

void	tableAddFixedWidthStringColumn (JNIEnv env, Table table, char *data, int width)
	Add fixed-width string data to a column in the given Table. More...

void	tableAddLabel (JNIEnv env, Table table, char *labelName)
	Add a dynamic column to a table. More...

void	tableAddSingleRowBooleanColumn (JNIEnv env, Table table, unsigned char data)
	Add a boolean column to a Table with only one row. More...

void	tableAddSingleRowByteColumn (JNIEnv env, Table table, unsigned char data)
	Add a byte column to a Table with only one row. More...

void	tableAddSingleRowDoubleColumn (JNIEnv env, Table table, double data, bool ieeeDouble)
	Add a double column to a Table with only one row. More...

void	tableAddSingleRowFloatColumn (JNIEnv env, Table table, float data, bool ieeeFloat)
	Add a float column to a Table with only one row. More...

void	tableAddSingleRowIntegerColumn (JNIEnv env, Table table, int data)
	Add a integer column to a Table with only one row. More...

void	tableAddSingleRowLongColumn (JNIEnv env, Table table, long data)
	Add a long column to a Table with only one row. More...

void	tableAddSingleRowShortColumn (JNIEnv env, Table table, short data)
	Add a short column to a Table with only one row. More...

void	tableAddSingleRowStringColumn (JNIEnv env, Table table, char *data)
	Add a string column to a Table with only one row. More...

void	tableAddStringColumn (JNIEnv env, Table table, char **data)
	Add a String column to the given Table. More...

Table	tableCreate (JNIEnv *env, int rows, int columns)
	Table Handling. More...

Table	tableCreateDynamic (JNIEnv *env, int rows, int columns)
	Make a Dynamic Table for return to client. More...

void	uriLegacyName (char legacyName[MAX_URI_LEN], const char *uri)
	Convert the given URI to the legacy AIDA name for low level functions that still require it that way. More...

void	uriToSlcName (char slcName[MAX_URI_LEN], const char *uri)
	Convert all URIs to slac names before making queries. More...

Detailed Description

The Header File for the AIDA-PVA Module functions.

CMS=C_INC

Definition in file aida_pva.h.

Function Documentation

◆ aidaThrow()

void aidaThrow	(	JNIEnv *	env,
		vmsstat_t	status,
		char *	exception,
		const char *	message
	)

Exception Handling.

To log any exceptions and throw back to java.

The #exception is formatted in a standard way using the VMS status code and its associated message and the optionally supplied #message. The #exception is always assumed to be from the edu.stanford.slac.except package

Parameters

env	the JNI environment. Used in all functions involving JNI
status	the VMS status code to luck up and display text for.
exception	the string representation of the exception class to throw.
message	the optional message to attach to the exception. If NULL it is ignored.

Exception Handling.

The #exception is formatted in a standard way using the VMS status code and its associated message and the optionally supplied #message. The #exception is always assumed to be from the edu.stanford.slac.except package

Parameters

env	the JNI environment. Used in all functions involving JNI
status	the VMS status code to luck up and display text for.
exception	the string representation of the exception class to throw.
message	the optional message to attach to the exception. If NULL it is ignored.

Definition at line 92 of file aida_pva_server_helper.c.

{
    // Clear any exception that may be in the process of being thrown (unlikely)
    if ((*env)->ExceptionCheck(env)) {
        (*env)->ExceptionClear(env);
    }
 
    char vmsErrorMessage[BUFSIZ] = { '\0' };
    $DESCRIPTOR(MESSAGE, vmsErrorMessage);
    struct dsc$descriptor errorMessageDescriptor = { BUFSIZ, DSC$K_DTYPE_T, DSC$K_CLASS_S, (char*)&vmsErrorMessage };
 
    //  Get the message text associated with the VMS message code. if the cause is an OS error
    if (!SUCCESS(status)) {
        ERRTRANSLATE(&status, &errorMessageDescriptor);
        strncat(errorMessageDescriptor.dsc$a_pointer, "; ",
                MIN(strlen("; "), BUFSIZ - strlen(errorMessageDescriptor.dsc$a_pointer)));
    }
 
    // Add exception
    strncat(errorMessageDescriptor.dsc$a_pointer, exception,
            MIN(strlen(exception), BUFSIZ - strlen(errorMessageDescriptor.dsc$a_pointer)));
 
    // If a message is specified then append it to the vms message string
    if (message) {
        strncat(errorMessageDescriptor.dsc$a_pointer, "; ",
                MIN(strlen("; "), BUFSIZ - strlen(errorMessageDescriptor.dsc$a_pointer)));
        strncat(errorMessageDescriptor.dsc$a_pointer, message,
                MIN(strlen(message), BUFSIZ - strlen(errorMessageDescriptor.dsc$a_pointer)));
    }
 
    fprintf(stderr, "AIDA Exception: %s: %s\n", exception, errorMessageDescriptor.dsc$a_pointer);
 
    // Create the fully qualified java class name of the exception to throw
    char classToCreate[BUFSIZ] = "edu/stanford/slac/except/";
    strcat (classToCreate, exception);
 
    // Create the java exception class
    jclass exceptionClass;
    exceptionClass = (*env)->FindClass(env, classToCreate);
    if (!exceptionClass) {
        fprintf(stderr, "FATAL: Failed to create object of class: %s\n", classToCreate);
        exit((int)status);
    }
 
    //  Throw the given exception to Java server code, giving the
    //  VMS error text and supplied message as the exception text.
    (*env)->ThrowNew(env, exceptionClass, errorMessageDescriptor.dsc$a_pointer);
}

Referenced by aidaRequestBoolean(), aidaRequestBooleanArray(), aidaRequestByte(), aidaRequestByteArray(), aidaRequestDouble(), aidaRequestDoubleArray(), aidaRequestFloat(), aidaRequestFloatArray(), aidaRequestInteger(), aidaRequestIntegerArray(), aidaRequestLong(), aidaRequestLongArray(), aidaRequestShort(), aidaRequestShortArray(), aidaRequestString(), aidaRequestTable(), aidaServiceInit(), aidaSetValue(), aidaSetValueWithResponse(), and aidaThrowNonOsException().

◆ aidaThrowNonOsException()

void aidaThrowNonOsException	(	JNIEnv *	env,
		char *	exception,
		const char *	message
	)

To log any non-OS exceptions and throw back to java.

The #exception is formatted in a standard way with the optionally supplied #message. The #exception is always assumed to be from the edu.stanford.slac.except package

Parameters

env	the JNI environment. Used in all functions involving JNI
exception	the string representation of the exception class to throw.
message	the optional message to attach to the exception. If NULL it is ignored.

Definition at line 75 of file aida_pva_server_helper.c.

{
    aidaThrow(env, 1, exception, message);
}

References aidaThrow().

Referenced by aidaRequestBoolean(), aidaRequestBooleanArray(), aidaRequestByte(), aidaRequestByteArray(), aidaRequestDouble(), aidaRequestDoubleArray(), aidaRequestFloat(), aidaRequestFloatArray(), aidaRequestInteger(), aidaRequestIntegerArray(), aidaRequestLong(), aidaRequestLongArray(), aidaRequestShort(), aidaRequestShortArray(), aidaRequestString(), aidaRequestStringArray(), aidaRequestTable(), aidaSetValue(), aidaSetValueWithResponse(), allocateMemory(), getClassAndValueOfMethod(), newObject(), newObjectFromClass(), pmuFromDeviceName(), tableAddColumn(), tableAddField(), tableAddLabel(), tableCreate(), toBoolean(), toBooleanArray(), toByte(), toByteArray(), toDouble(), toDoubleArray(), toFloat(), toFloatArray(), toInteger(), toIntegerArray(), toLong(), toLongArray(), toShort(), toShortArray(), toStringArray(), and toTable().

◆ allocateMemory()

void * allocateMemory	(	JNIEnv *	env,
		void *	source,
		size_t	size,
		bool	nullTerminate,
		char *	message
	)

Memory Handling.

Allocate memory and copy the source to it if specified. If the null terminate flag is set null terminate the allocate space, at the last position

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
source	source of data to copy to newly allocated space, NULL to not copy
size	the amount of space to allocate
nullTerminate	true to null terminate
message	the message to display if anything goes wrong

Returns: the allocated memory

Memory Handling.

If the null terminate flag is set null terminate the allocate space, at the last position

Parameters

env	to be used to throw exceptions using aidaThrow() and aidaThrowNonOsException()
source	source of data to copy to newly allocated space, NULL to not copy
size	the amount of space to allocate
nullTerminate	true to null terminate
message	the message to display if anything goes wrong

Returns: the allocated memory

Definition at line 629 of file aida_pva_server_helper.c.

{
    void* data = malloc(size);
    if (!data) {
        aidaThrowNonOsException(env, AIDA_INTERNAL_EXCEPTION, message);
        return NULL;
    }
    if (source) {
        memcpy(data, source, size - (nullTerminate ? 1 : 0));
        if (nullTerminate) {
            *(char*)((char*)data + size - 1) = 0x0;
        }
    }
    return data;
}

References AIDA_INTERNAL_EXCEPTION, and aidaThrowNonOsException().

◆ ascanf()

int ascanf	(	JNIEnv *	env,
		Arguments *	arguments,
		const char *	formatString,
			...
	)

Argument Processing.

ascanf(), avscanf()

Synopsis

int ascanf(Arguments *arguments, const char *format, ...);

int avscanf(Arguments *arguments, Value *value, const char *format, ...);

ascanf

int ascanf(JNIEnv *env, Arguments *arguments, const char *formatString,...)

ascanf(), avscanf()

Definition: aida_pva_types_helper.c:86

avscanf

int avscanf(JNIEnv *env, Arguments *arguments, Value *value, const char *formatString,...)

ascanf(), avscanf()

Definition: aida_pva_types_helper.c:250

Arguments

An Arguments structure stores all of the arguments passed from the request to the Native Channel Prov...

Definition: aida_pva_types.h:127

Value

This special type represents a Value.

Definition: aida_pva_types.h:112

Details

Reads data from the given arguments and stores them according to parameter format into the locations given by the additional arguments, as if scanf() was used, but reading from arguments instead of the standard input (stdin).

See also: avscanf() for full details.

Parameters

env	The JNI environment. Used in all functions involving JNI
arguments	Arguments that the function processes as its source to retrieve the data.
formatString	C string that contains a format string as described above
...	Depending on the format string, the function may expect a sequence of additional arguments, containing pairs of names and pointers to allocated storage (except as indicated above), where the interpretation of the extracted data is stored with the appropriate type. There should be at least as many pairs of these arguments as the number of values stored by the format specifiers. Additional arguments are ignored by the function

Returns: EXIT_SUCCESS if all required arguments were read and no errors occurred, otherwise EXIT_FAILURE

Exceptions

MissingRequiredArgumentException if one of the required arguments are missing

Argument Processing.

Synopsis

int ascanf(Arguments *arguments, const char *format, ...);

int avscanf(Arguments *arguments, Value *value, const char *format, ...);

Details

Reads data from the given arguments and stores them according to parameter format into the locations given by the additional arguments, as if scanf() was used, but reading from arguments instead of the standard input (stdin).

See also: avscanf() for full details.

Parameters

env	The JNI environment. Used in all functions involving JNI
arguments	Arguments that the function processes as its source to retrieve the data.
formatString	C string that contains a format string as described above
...	Depending on the format string, the function may expect a sequence of additional arguments, containing pairs of names and pointers to allocated storage (except as indicated above), where the interpretation of the extracted data is stored with the appropriate type. There should be at least as many pairs of these arguments as the number of values stored by the format specifiers. Additional arguments are ignored by the function

Returns: EXIT_SUCCESS if all required arguments were read and no errors occurred, otherwise EXIT_FAILURE

Exceptions

MissingRequiredArgumentException if one of the required arguments are missing

Definition at line 86 of file aida_pva_types_helper.c.

{
    va_list argp;
    va_start(argp, formatString);
    int status = vavscanf(env, arguments, NULL, formatString, argp);
    va_end (argp);
    return status;
}

Referenced by aidaRequestBoolean(), aidaRequestBooleanArray(), aidaRequestByte(), aidaRequestByteArray(), aidaRequestDouble(), aidaRequestDoubleArray(), aidaRequestFloat(), aidaRequestFloatArray(), aidaRequestInteger(), aidaRequestIntegerArray(), aidaRequestLong(), aidaRequestLongArray(), aidaRequestShort(), aidaRequestShortArray(), aidaRequestString(), aidaRequestStringArray(), aidaRequestTable(), and aidaSetValue().

◆ avscanf()

int avscanf	(	JNIEnv *	env,
		Arguments *	arguments,
		Value *	value,
		const char *	formatString,
			...
	)

ascanf(), avscanf()

Synopsis

int ascanf(Arguments *arguments, const char *format, ...);

int avscanf(Arguments *arguments, Value *value, const char *format, ...);

Details

Reads data from the given arguments and stores them according to parameter format into the locations given by the additional arguments, as if scanf() was used, but reading from arguments instead of the standard input (stdin).

The additional arguments should point to already allocated objects of the type specified by their corresponding format specifier. For strings and arrays only the pointer needs to be pre-allocated.

The only space allocated by this function is for the strings or arrays. So callers should only free strings and arrays. Even if you provide a default value for a string the pointer will be allocated memory on exit from the function, so even then you need to free it.

Note: Only the provided pointer needs to be freed as only one allocation is made e.g.
Arguments arguments;

int *intArray;

ascanf(arguments "%da, "fooArray", &intArray);

// Do stuff

free(intArray);

String space is allocated as follows:

+------------------------+----------+----------+----------+---------+
| pointers to strings    | string 1 | string 2 | string 3 | ...     |
+------------------------+----------+----------+----------+---------+

Differences to scanf()

There are a number of differences from scanf() which are best described by example:

General differences

Scan into simple variable/
int n;

ascanf("%d", "NPOS", &n);

You must always provide the name of the variable and the pointer to the place to put the value in pairs
Optional arguments. Optional arguments are specified with the o character before the format character.
short flag = 10; // 10 is the default value

ascanf("%ohd", "flag", &flag);

By default all arguments referenced by format specifications are considered required unless the format specification character is preceded by o. For optional arguments the pointer provided must point to the default value. In the case of arrays and strings this will be copied into allocated storage that will need to be freed as normal.

Argument names

You can specify simple argument names to search for. These will simply find the named argument and extract its value.
int simpleInt;

ascanf(&arguments "%d, "simple", &simpleInt);
You can also use dot and square brace notation to refer to complex arguments that are either arrays or complex objects. Values that are buried deep inside the json structures can be referenced in this way. e.g., given a variable named json and presented as:
json='{"foo": {"bar": 0}}}'

You can specify the name as "json.foo.bar" to retrieve the 0 value.
Also given a variable named jsonArray and presented as
jsonArray='[{"foo": 10}, {"bar": 20}]'

You can specify the #p name as "jsonArray[1].bar" to retrieve the 20 value.
Finally if you use the name "value", then the avscanf() function will use the supplied value parameter to get the data for that parameter
Arguments arguments;

Value value;

int *intArray;

avscanf(&arguments &value, "%da, "fooArray", &intArray);

// Do stuff

free(intArray);

Format Specifiers

Type specifiers

b : unsigned char * - interpret the input as a boolean, then extract a single byte into the corresponding variable.
- The following translate to true
  - not 0 - integer, short, long,
  - not 0.0 - float, double
  - “true” - char string
  - “t” - char string
  - “yes” - char string
  - “y” - char string
  - !0 - short, int, long, float, or double
- The following translate to false
  - 0 - integer, short, long,
  - 0.0 - float, double
  - “false” - char string
  - “f”- char string
  - “no”- char string
  - “n”- char string
  - 0 - short, int, long, float, or double
c : char * - extract a single character into the corresponding variable.
d : int * - extract an integer into the corresponding variable (see l & h below).
f : float * - extract a floating point number (see l below).
s : char * - extract a string of characters into allocated space and point the corresponding variable to it.
u : unsigned int * - extract an unsigned integer into the corresponding variable (see l & h below).

Required flag

o - optional precede the format with this to indicate that the argument is optional.

Prefixes

h - short * - preceding d will retrieve a short e.g. "%hd".
l - long *, double * - preceding d will retrieve a long eg. "%ld"; preceding f will retrieve a double eg. "%lf".

Suffixes

a - extract an array of the preceding type into a block of allocated space and point the corresponding variable to it. The variable will have an extra level of indirection than the non-array version. e.g.,
int i;

ascanf(..., "%d", &i);

becomes
int *ia, n;

ascanf(..., "%da", &ia, &n);

Also, you need to provide an extra parameter for each format containing an a suffix to hold the count of array elements found. The pointer will point to an int.

Parameters

env	The JNI environment. Used in all functions involving JNI
arguments	Arguments that the function processes as its source to retrieve the data.
value	For the avscanf() form this parameter holds the parsed Value given to the Channel Provider endpoint.
formatString	C string that contains a format string as described above
...	Depending on the format string, the function may expect a sequence of additional arguments, containing pairs of names and pointers to allocated storage (except as indicated above), where the interpretation of the extracted data is stored with the appropriate type. There should be at least as many pairs of these arguments as the number of references in the format specifiers. Additional arguments are ignored by the function

Returns: EXIT_SUCCESS if all required arguments were read and no errors occurred, otherwise EXIT_FAILURE

Exceptions

MissingRequiredArgumentException if one of the required arguments are missing

Synopsis

int ascanf(Arguments *arguments, const char *format, ...);

int avscanf(Arguments *arguments, Value *value, const char *format, ...);

Details

Reads data from the given arguments and stores them according to parameter format into the locations given by the additional arguments, as if scanf() was used, but reading from arguments instead of the standard input (stdin).

The additional arguments should point to already allocated objects of the type specified by their corresponding format specifier. For strings and arrays only the pointer needs to be pre-allocated.

The only space allocated by this function is for the strings or arrays. So callers should only free strings and arrays. Even if you provide a default value for a string the pointer will be allocated memory on exit from the function, so even then you need to free it.

Note: Only the provided pointer needs to be freed as only one allocation is made e.g.
Arguments arguments;

int *intArray;

ascanf(arguments "%da, "fooArray", &intArray);

// Do stuff

free(intArray);

String space is allocated as follows:

+------------------------+----------+----------+----------+---------+
| pointers to strings    | string 1 | string 2 | string 3 | ...     |
+------------------------+----------+----------+----------+---------+

Differences to scanf()

There are a number of differences from scanf() which are best described by example:

General differences

Scan into simple variable/
int n;

ascanf("%d", "NPOS", &n);

You must always provide the name of the variable and the pointer to the place to put the value in pairs
Optional arguments. Optional arguments are specified with the o character before the format character.
short flag = 10; // 10 is the default value

ascanf("%ohd", "flag", &flag);

By default all arguments referenced by format specifications are considered required unless the format specification character is preceded by o. For optional arguments the pointer provided must point to the default value. In the case of arrays and strings this will be copied into allocated storage that will need to be freed as normal.

Argument names

You can specify simple argument names to search for. These will simply find the named argument and extract its value.
int simpleInt;

ascanf(&arguments "%d, "simple", &simpleInt);
You can also use dot and square brace notation to refer to complex arguments that are either arrays or complex objects. Values that are buried deep inside the json structures can be referenced in this way. e.g., given a variable named json and presented as:
json='{"foo": {"bar": 0}}}'

You can specify the name as "json.foo.bar" to retrieve the 0 value.
Also given a variable named jsonArray and presented as
jsonArray='[{"foo": 10}, {"bar": 20}]'

You can specify the #p name as "jsonArray[1].bar" to retrieve the 20 value.
Finally if you use the name "value", then the avscanf() function will use the supplied value parameter to get the data for that parameter
Arguments arguments;

Value value;

int *intArray;

avscanf(&arguments &value, "%da, "fooArray", &intArray);

// Do stuff

free(intArray);

Format Specifiers

Type specifiers

b : unsigned char * - interpret the input as a boolean, then extract a single byte into the corresponding variable.
- The following translate to true
  - not 0 - integer, short, long,
  - not 0.0 - float, double
  - “true” - char string
  - “t” - char string
  - “yes” - char string
  - “y” - char string
  - !0 - short, int, long, float, or double
- The following translate to false
  - 0 - integer, short, long,
  - 0.0 - float, double
  - “false” - char string
  - “f”- char string
  - “no”- char string
  - “n”- char string
  - 0 - short, int, long, float, or double
c : char * - extract a single character into the corresponding variable.
d : int * - extract an integer into the corresponding variable (see l & h below).
f : float * - extract a floating point number (see l below).
s : char * - extract a string of characters into allocated space and point the corresponding variable to it.
u : unsigned int * - extract an unsigned integer into the corresponding variable (see l & h below).

Required flag

o - optional precede the format with this to indicate that the argument is optional.

Prefixes

h - short * - preceding d will retrieve a short e.g. "%hd".
l - long *, double * - preceding d will retrieve a long eg. "%ld"; preceding f will retrieve a double eg. "%lf".

Suffixes

a - extract an array of the preceding type into a block of allocated space and point the corresponding variable to it. The variable will have an extra level of indirection than the non-array version. e.g.,
int i;

ascanf(..., "%d", &i);

becomes
int *ia, n;

ascanf(..., "%da", &ia, &n);

Also, you need to provide an extra parameter for each format containing an a suffix to hold the count of array elements found. The pointer will point to an int.

Parameters

env	The JNI environment. Used in all functions involving JNI
arguments	Arguments that the function processes as its source to retrieve the data.
value	For the avscanf() form this parameter holds the parsed Value given to the Channel Provider endpoint.
formatString	C string that contains a format string as described above
...	Depending on the format string, the function may expect a sequence of additional arguments, containing pairs of names and pointers to allocated storage (except as indicated above), where the interpretation of the extracted data is stored with the appropriate type. There should be at least as many pairs of these arguments as the number of references in the format specifiers. Additional arguments are ignored by the function

Returns: EXIT_SUCCESS if all required arguments were read and no errors occurred, otherwise EXIT_FAILURE

Exceptions

MissingRequiredArgumentException if one of the required arguments are missing

Definition at line 250 of file aida_pva_types_helper.c.

{
    va_list argp;
    va_start(argp, formatString);
    int status = vavscanf(env, arguments, value, formatString, argp);
    va_end (argp);
    return status;
}

Referenced by aidaSetValue(), and aidaSetValueWithResponse().

◆ endsWith()

int endsWith	(	const char *	str,
		char *	suffix
	)

String Handling.

Check if a string str, ends with another string suffix.

Parameters

str	the string to check.
suffix	the `suffix` to look for at the end of `str`

Returns: true if str ends with suffix. false

String Handling.

Parameters

str	the string to check.
suffix	the `suffix` to look for at the end of `str`

Returns: true if str ends with suffix. false

Definition at line 148 of file aida_pva_server_helper.c.

{
    if (!str || !suffix) {
        return false;
    }
    size_t lenstr = strlen(str);
    size_t lenSuffix = strlen(suffix);
    if (lenSuffix > lenstr)
        return false;
    return !strncasecmp(str + lenstr - lenSuffix, suffix, lenSuffix);
}

Referenced by aidaRequestBoolean(), aidaRequestBooleanArray(), aidaRequestByte(), aidaRequestByteArray(), aidaRequestDouble(), aidaRequestDoubleArray(), aidaRequestFloat(), aidaRequestFloatArray(), aidaRequestInteger(), aidaRequestIntegerArray(), aidaRequestLong(), aidaRequestLongArray(), aidaRequestShort(), aidaRequestShortArray(), aidaRequestString(), aidaRequestStringArray(), aidaRequestTable(), and aidaSetValueWithResponse().

◆ groupNameFromUri()

int groupNameFromUri	(	char	groupName[],
		const char *	uri
	)

URI Handling for group, secn, pmu and slacName.

Get the Display group name from a URI.

Parameters

groupName	pre-allocated space to store the group name
uri	the new format AIDA PV name

Returns: EXIT_SUCCESS if all goes well EXIT_FAILURE otherwise

URI Handling for group, secn, pmu and slacName.

Parameters

groupName	pre-allocated space to store the group name
uri	the new format AIDA PV name

Returns: EXIT_SUCCESS if all goes well EXIT_FAILURE otherwise

Definition at line 472 of file aida_pva_server_helper.c.

{
    strcpy(groupName, uri);
    char* groupNameEnd = strrchr(groupName, ':');
    if (groupNameEnd) {
        *groupNameEnd = 0x0;
    }
    return EXIT_SUCCESS;
}

◆ init()

vmsstat_t init	(	const char *	processName,
		bool	initMessageServices
	)

Initialisation.

Call standalone_init() and set development mode flag.

Parameters

processName	the name of the process being initialised
initMessageServices	boolean to determine if the message service needs to be initialised

Returns: vms status code

Initialisation.

Parameters

processName	the name of the process being initialised
initMessageServices	boolean to determine if the message service needs to be initialised

Returns: vms status code

Definition at line 50 of file aida_pva_server_helper.c.

{
    const struct msginit msg_init_s = { 1,      /* init msg service */
                                        1 };    /* init slcnet */
 
    vmsstat_t status;
    $DESCRIPTOR (PROCESS_NAME, processName);    // Ignored in standalone_init() call
 
    status = STANDALONE_INIT(&PROCESS_NAME, &((long)(TRUE)),
            initMessageServices ? &msg_init_s : NULL,
            &((long)(FALSE)), &((long)(FALSE)));
 
    return status;
}

References STANDALONE_INIT().

Referenced by aidaServiceInit().

◆ pmuFromDeviceName()

int pmuFromDeviceName	(	JNIEnv *	env,
		char *	device,
		char *	primary,
		char *	micro,
		int4u *	unit
	)

Get primary, micro and unit from a device name.

Parameters

env	the JNI environment. Used in all functions involving JNI
device	pre-allocated space to store the device
primary	pre-allocated space to store the primary
micro	pre-allocated space to store the micro
unit	pre-allocated space to store the unit

Parameters

env	the JNI environment. Used in all functions involving JNI
device	pre-allocated space to store the device
primary	pre-allocated space to store the primary
micro	pre-allocated space to store the micro
unit	pre-allocated space to store the unit

Definition at line 542 of file aida_pva_server_helper.c.

{
    // Copy each part to the provided variables
    char* nextPart = strtok(device, ":");
    unsigned long len;
    if (nextPart) {
        len = strlen(nextPart);
        if (len != 4) {
            aidaThrowNonOsException(env, UNABLE_TO_GET_DATA_EXCEPTION, "Device name is not valid");
            return EXIT_FAILURE;
        }
        memcpy(primary, nextPart, PRIM_LEN);
        nextPart = strtok(NULL, ":");
        if (nextPart) {
            len = strlen(nextPart);
            if (len != 4 || !isdigit(nextPart[2]) || !isdigit(nextPart[3])) {
                aidaThrowNonOsException(env, UNABLE_TO_GET_DATA_EXCEPTION, "Device name is not valid");
                return EXIT_FAILURE;
            }
            memcpy(micro, nextPart, MICRO_LEN);
            nextPart = strtok(NULL, ":");
            if (nextPart) {
                len = strlen(nextPart);
                if (len < 1 || len > 4 || !isdigit(nextPart[0]) || (len > 1 && !isdigit(nextPart[1]))
                        || (len > 2 && !isdigit(nextPart[2])) || (len > 3 && !isdigit(nextPart[3]))) {
                    aidaThrowNonOsException(env, UNABLE_TO_GET_DATA_EXCEPTION, "Device name is not valid");
                    return EXIT_FAILURE;
                }
                *unit = (int4u)atol(nextPart);
            }
        }
    }
    return EXIT_SUCCESS;
}

References aidaThrowNonOsException(), MICRO_LEN, PRIM_LEN, and UNABLE_TO_GET_DATA_EXCEPTION.

Referenced by aidaRequestTable().

◆ pmuStringFromUri()

void pmuStringFromUri	(	char *	pmuString,
		const char *	uri
	)

Get the pmu part of a URI.

Parameters

pmuString	the pre-allocated space to store the pmu string
uri	the new format AIDA PV name

Parameters

pmuString	the pre-allocated space to store the pmu string
uri	the new format AIDA PV name

Definition at line 523 of file aida_pva_server_helper.c.

{
    unsigned long pmuEnd = strrchr(uri, ':') - uri;
    if (pmuEnd >= MAX_URI_LEN) {
        pmuEnd = MAX_URI_LEN - 1;
    }
    strncpy(pmuString, uri, pmuEnd);
    pmuString[pmuEnd] = 0x0;
}

References MAX_URI_LEN.

◆ releaseArray()

void releaseArray ( Array array )

Free up any memory allocated the given scalar array.

Parameters

array the given scalar array

Parameters

array the given scalar array

Definition at line 893 of file aida_pva_jni_helper.c.

                               {
    if (array.count && array.items) {
        free(array.items);
        array.count = 0;
        array.items = NULL;
    }
}

References Array::count, and Array::items.

Referenced by toBooleanArray(), toByteArray(), toDoubleArray(), toFloatArray(), toIntegerArray(), toLongArray(), and toShortArray().

◆ releasePvAndArguments()

void releasePvAndArguments	(	JNIEnv *	env,
		jstring	uri,
		const char *	pv,
		Arguments	arguments
	)

Free up any memory allocated for the given pv and arguments.

Parameters

arguments the given arguments

Parameters

arguments the given arguments

Definition at line 872 of file aida_pva_jni_helper.c.

                                                                                          {
    if (pv) {
        (*env)->ReleaseStringUTFChars(env, uri, pv);
    }
    if (arguments.floatingPointValues && arguments.floatingPointValuesCount) {
        free(arguments.floatingPointValues);
        arguments.floatingPointValuesCount = 0;
        arguments.floatingPointValues = NULL;
    }
    if (arguments.argumentCount && arguments.arguments) {
        free(arguments.arguments);
        arguments.argumentCount = 0;
        arguments.arguments = NULL;
    }
}

References Arguments::argumentCount, Arguments::arguments, Arguments::floatingPointValues, and Arguments::floatingPointValuesCount.

◆ releaseStringArray()

void releaseStringArray ( StringArray array )

Free up any memory allocated for string arrays.

Parameters

array

Definition at line 905 of file aida_pva_jni_helper.c.

                                           {
    if (array.count && array.items) {
        free(array.items);
        array.count = 0;
        array.items = NULL;
    }
}

References StringArray::count, and StringArray::items.

Referenced by toStringArray().

◆ releaseTable()

void releaseTable ( Table table )

Free up any memory allocated for the given table.

Parameters

table the given tables

Parameters

table the given tables

Definition at line 918 of file aida_pva_jni_helper.c.

                               {
    if (table.columnCount) {
        if (table.ppData) {
            for (int column = 0; column < table._currentColumn; column++) {
                if (table.ppData[column]) {
                    free(table.ppData[column]);
                    table.ppData[column] = NULL;
                }
            }
            free(table.ppData);
            table.ppData = NULL;
 
            if (table.types) {
                free(table.types);
                table.types = NULL;
            }
            table._currentColumn = 0;
        }
 
        // Free field names
        if (table.ppFields) {
            for (int column = 0; column < table._currentField; column++) {
                if (table.ppFields[column]) {
                    free(table.ppFields[column]);
                    table.ppFields[column] = NULL;
                }
            }
            free(table.ppFields);
            table._currentField = 0;
            table.ppFields = NULL;
        }
 
        // Free label names
        if (table.ppLabels) {
            for (int column = 0; column < table._currentLabel; column++) {
                if (table.ppLabels[column]) {
                    free(table.ppLabels[column]);
                    table.ppLabels[column] = NULL;
                }
            }
            free(table.ppLabels);
            table._currentLabel = 0;
            table.ppLabels = NULL;
        }
 
        table.columnCount = 0;
    }
}

References Table::_currentColumn, Table::_currentField, Table::_currentLabel, Table::columnCount, Table::ppData, Table::ppFields, Table::ppLabels, and Table::types.

Referenced by toTable().

◆ releaseValue()

void releaseValue ( Value value )

Release all allocated memory in the given value.

Parameters

value the given value'

Parameters

value the given value'

Definition at line 432 of file aida_pva_jni_helper.c.

                               {
    // Only free json values because the string values will be freed with the arguments directly
    if (value.type == AIDA_JSON_TYPE) {
        json_value_free(value.value.jsonValue);
        value.type = AIDA_NO_TYPE;
    }
}

References AIDA_JSON_TYPE, AIDA_NO_TYPE, ValueContents::jsonValue, Value::type, and Value::value.

◆ secnFromUri()

void secnFromUri	(	const char *	uri,
		int4u *	secn
	)

Get secondary from pseudo secondary (containing a colon) number from URI.

e.g. BD01:BEND:BDES => BEND as int4u

Parameters

uri	the new format AIDA PV name
secn	pointer to an int to store the secondary as a number

Get secondary from pseudo secondary (containing a colon) number from URI.

BD01:BEND:BDES => BEND as int4u

Parameters

uri	the new format AIDA PV name
secn	pointer to an int to store the secondary as a number

Definition at line 489 of file aida_pva_server_helper.c.

{
    char uriCopy[strlen(uri) + 1];
    strcpy(uriCopy, uri);
    char* secondary = strrchr(uriCopy, ':');
    if (secondary) {
        memcpy(secn, secondary + 1, sizeof(int4u));
        return;
    }
    fprintf(stderr, "Warning: Found corrupt URI when trying to extract secn: %s\n", uri);
    *secn = 0;
}

◆ secondaryFromUri()

const char * secondaryFromUri ( const char * uri )

Get secondary from URI.

Just points into the URI so don't go messing with it.

Parameters

uri	the new format AIDA PV name

Just points into the URI so don't go messing with it

Parameters

uri	the new format AIDA PV name

Definition at line 507 of file aida_pva_server_helper.c.

{
    char* secondary = strrchr(uri, ':');
    if (!secondary) {
        fprintf(stderr, "Warning: Secondary not found in uri: %s\n", uri);
        return uri;
    }
    return secondary + 1;
}

Referenced by aidaRequestStringArray().

◆ startsWith()

int startsWith	(	const char *	str,
		char *	prefix
	)

Check if a string starts with another string.

Parameters

str
prefix

Returns: true if string starts with prefix

Definition at line 166 of file aida_pva_server_helper.c.

{
    if (!str || !prefix) {
        return false;
    }
    size_t lenstr = strlen(str);
    size_t lenPrefix = strlen(prefix);
    if (lenPrefix > lenstr)
        return false;
    return !strncasecmp(str, prefix, lenPrefix);
}

Referenced by aidaRequestLong(), aidaRequestShort(), aidaRequestString(), aidaRequestStringArray(), and aidaSetValue().

◆ tableAddColumn()

void tableAddColumn	(	JNIEnv *	env,
		Table *	table,
		Type	type,
		void *	data,
		bool	ieeeFormat
	)

Add a column of arbitrary type to a Table.

Add the given data to the column assuming that the data has a number of rows that corresponds to the Table's rowCount. Memory will be allocated for the data of the column so the data buffer presented can be freed up after calling this function.

Note: Don't call this to add strings to the Table. Use tableAddStringColumn() for that.

The framework will release all memory associated with a Table when you return from your API implementation.

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	the Table to add the column to.
type	the type of this Table column.
data	the data to add to this column, a buffer of `sizeof(type) * table->rowCount` size.
ieeeFormat	true if the data provided is already in ieee format. If the data is not in ieee format, usually because it has been retrieved from some backend system, this function will convert it to ieee format unless this parameter is set to true.

See also: tableCreate(), tableAddStringColumn() tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowStringColumn(),

Example

Create a two column, two row Table, add data, and return.

int rows = 2, columns = 2;
float xData[rows] = { 1.0f, 2.0f }, yData[rows] = { 7.0f, 8.0f };
 
Table table = tableCreate(env, rows, columns);
ON_EXCEPTION_RETURN_(table)
tableAddColumn(env, &table, AIDA_FLOAT_TYPE, xData, true);
ON_EXCEPTION_RETURN_(table)
tableAddColumn(env, &table, AIDA_FLOAT_TYPE, yData, true);
ON_EXCEPTION_RETURN_(table)
return table;

Note: You need to call ON_EXCEPTION_RETURN_(table) after each call to make sure that no exception was raised.

Definition at line 755 of file aida_pva_types_helper.c.

{
    // Table full?
    if (table->_currentColumn >= table->columnCount) {
        aidaThrowNonOsException(env, UNABLE_TO_GET_DATA_EXCEPTION,
                "Internal Error: more columns added than table size");
        return;
    }
 
    // No Data supplied ?
    if (!data) {
        aidaThrowNonOsException(env, UNABLE_TO_GET_DATA_EXCEPTION,
                "Internal Error: Attempt to add column with no data");
        return;
    }
 
    // Correct type for tables
    type = tableArrayTypeOf(type);
 
    // Set column type, and allocate space
    allocateTableColumn(env, table, type, tableElementSizeOfOf(type));
    ON_EXCEPTION_RETURN_VOID
 
    // Rest of processing for strings is done in addStringColumn
    if (type == AIDA_STRING_ARRAY_TYPE) {
        return;
    }
 
    if (!ieeeFormat) {
        // Convert float values if float array
        if (type == AIDA_FLOAT_ARRAY_TYPE) {
            CONVERT_FROM_VMS_FLOAT(((float*)data), (int2u)table->rowCount)
        }
 
        // Convert double values if double array
        if (type == AIDA_DOUBLE_ARRAY_TYPE) {
            CONVERT_FROM_VMS_DOUBLE((double*)data, (int2u)table->rowCount)
        }
    }
 
    // Add data to column
    for (int row = 0; row < table->rowCount; row++) {
        // add data and increment pointer based on type
        switch (type) {
        case AIDA_BOOLEAN_ARRAY_TYPE:
        case AIDA_BYTE_ARRAY_TYPE:
            ((unsigned char*)(table->ppData[table->_currentColumn]))[row] = ((unsigned char*)data)[row];
            break;
        case AIDA_SHORT_ARRAY_TYPE:
            ((short*)(table->ppData[table->_currentColumn]))[row] = ((short*)data)[row];
            break;
        case AIDA_INTEGER_ARRAY_TYPE:
            ((int*)(table->ppData[table->_currentColumn]))[row] = ((int*)data)[row];
            break;
        case AIDA_LONG_ARRAY_TYPE:
            ((long*)(table->ppData[table->_currentColumn]))[row] = ((long*)data)[row];
            break;
        case AIDA_FLOAT_ARRAY_TYPE:
            ((float*)(table->ppData[table->_currentColumn]))[row] = ((float*)data)[row];
            break;
        case AIDA_DOUBLE_ARRAY_TYPE:
            ((double*)(table->ppData[table->_currentColumn]))[row] = ((double*)data)[row];
            break;
        default:
            aidaThrowNonOsException(env, UNABLE_TO_GET_DATA_EXCEPTION,
                    "Internal Error: Call to tableAddColumn() un-supported type");
            return;
        }
    }
 
    table->_currentColumn++;
}

References Table::_currentColumn, AIDA_BOOLEAN_ARRAY_TYPE, AIDA_BYTE_ARRAY_TYPE, AIDA_DOUBLE_ARRAY_TYPE, AIDA_FLOAT_ARRAY_TYPE, AIDA_INTEGER_ARRAY_TYPE, AIDA_LONG_ARRAY_TYPE, AIDA_SHORT_ARRAY_TYPE, AIDA_STRING_ARRAY_TYPE, aidaThrowNonOsException(), Table::columnCount, CONVERT_FROM_VMS_DOUBLE, CONVERT_FROM_VMS_FLOAT, ON_EXCEPTION_RETURN_VOID, Table::ppData, Table::rowCount, and UNABLE_TO_GET_DATA_EXCEPTION.

Referenced by aidaRequestTable(), aidaSetValueWithResponse(), tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowShortColumn(), and tableAddStringColumn().

◆ tableAddField()

void tableAddField	(	JNIEnv *	env,
		Table *	table,
		char *	fieldName
	)

Add a dynamic field to a table.

See also: tableCreateDynamic

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	the Table to add the column to.
fieldName	The name of the field to add

Definition at line 828 of file aida_pva_types_helper.c.

                                                               {
    // Table full?
    if (table->_currentField >= table->columnCount) {
        aidaThrowNonOsException(env, UNABLE_TO_GET_DATA_EXCEPTION,
                "Internal Error: more fields added than table size");
        return;
    }
 
    // No Data supplied ?
    if (!fieldName || !*fieldName) {
        aidaThrowNonOsException(env, UNABLE_TO_GET_DATA_EXCEPTION,
                "Internal Error: Attempt to add empty field name");
        return;
    }
 
    ALLOCATE_STRING_AND_ON_ERROR_RETURN_VOID(env, table->ppFields[table->_currentField], fieldName, "table field names")
    table->_currentField++;
}

References Table::_currentField, aidaThrowNonOsException(), ALLOCATE_STRING_AND_ON_ERROR_RETURN_VOID, Table::columnCount, Table::ppFields, and UNABLE_TO_GET_DATA_EXCEPTION.

◆ tableAddFixedWidthStringColumn()

void tableAddFixedWidthStringColumn	(	JNIEnv *	env,
		Table *	table,
		char *	data,
		int	width
	)

Add fixed-width string data to a column in the given Table.

This reads data from an allocated space that is rows * width with each string occupying width characters Though the strings are null terminated if there is space, there is no guarantee so an exact number of bytes is copied. Each string in the Table is allocated maximally.

Note: The framework will release all memory associated with a Table when you return from your API implementation.

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	The Table to add the column to.
data	The data to add to this column, a pointer to `char` buffer containing the fixed length strings. The strings are arranged in contiguous blocks `width` long.
width	the width of the strings

See also: tableCreate(), tableAddColumn(), tableAddStringColumn() tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowStringColumn(),

Add fixed-width string data to a column in the given Table.

Each string in the Table is allocated maximally.

Note: The framework will release all memory associated with a Table when you return from your API implementation.

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	The Table to add the column to.
data	The data to add to this column, a pointer to `char` buffer containing the fixed length strings. The strings are arranged in contiguous blocks `width` long.
width	the width of the strings

See also: tableCreate(), tableAddColumn(), tableAddStringColumn() tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowStringColumn(),

Definition at line 955 of file aida_pva_types_helper.c.

{
    tableAddColumn(env, table, AIDA_STRING_ARRAY_TYPE, data, false);
    ON_EXCEPTION_RETURN_VOID
 
    // allocate data for each string too
    char** stringArray = table->ppData[table->_currentColumn];
    char* dataPointer = (char*)data;
    for (int row = 0; row < table->rowCount; row++, dataPointer += width) {
        ALLOCATE_FIXED_LENGTH_STRING_AND_ON_ERROR_RETURN_VOID(env, stringArray[row], dataPointer, width + 1, "table strings")
        stringArray[row][width] = 0x0;
    }
 
    table->_currentColumn++;
}

References Table::_currentColumn, AIDA_STRING_ARRAY_TYPE, ALLOCATE_FIXED_LENGTH_STRING_AND_ON_ERROR_RETURN_VOID, ON_EXCEPTION_RETURN_VOID, Table::ppData, Table::rowCount, and tableAddColumn().

Referenced by aidaRequestTable(), and aidaSetValueWithResponse().

◆ tableAddLabel()

void tableAddLabel	(	JNIEnv *	env,
		Table *	table,
		char *	labelName
	)

Add a dynamic column to a table.

See also: tableCreateDynamic

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	the Table to add the column to.
labelName	the label name to add

Definition at line 847 of file aida_pva_types_helper.c.

                                                               {
    // Table full?
    if (table->_currentLabel >= table->columnCount) {
        aidaThrowNonOsException(env, UNABLE_TO_GET_DATA_EXCEPTION,
                "Internal Error: more labels added than table size");
        return;
    }
 
    // No Data supplied ?
    if (!labelName || !*labelName) {
        aidaThrowNonOsException(env, UNABLE_TO_GET_DATA_EXCEPTION,
                "Internal Error: Attempt to add empty label name");
        return;
    }
 
    ALLOCATE_STRING_AND_ON_ERROR_RETURN_VOID(env, table->ppLabels[table->_currentLabel], labelName, "table label names")
    table->_currentLabel++;
}

References Table::_currentLabel, aidaThrowNonOsException(), ALLOCATE_STRING_AND_ON_ERROR_RETURN_VOID, Table::columnCount, Table::ppLabels, and UNABLE_TO_GET_DATA_EXCEPTION.

◆ tableAddSingleRowBooleanColumn()

void tableAddSingleRowBooleanColumn	(	JNIEnv *	env,
		Table *	table,
		unsigned char	data
	)

Add a boolean column to a Table with only one row.

This function will allocate the required memory for the single unsigned char that is required.

Note: The framework will release all memory associated with a Table when you return from your API implementation.

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	The Table to add the column to.
data	The data to add to this column, a pointer to an `unsigned char`.

See also: tableCreate(), tableAddColumn(), tableAddStringColumn() tableAddFixedWidthStringColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowStringColumn(),

Definition at line 996 of file aida_pva_types_helper.c.

{
    tableAddColumn(env, table, AIDA_BOOLEAN_TYPE, &data, false);
}

References AIDA_BOOLEAN_TYPE, and tableAddColumn().

Referenced by aidaRequestTable(), and aidaSetValueWithResponse().

◆ tableAddSingleRowByteColumn()

void tableAddSingleRowByteColumn	(	JNIEnv *	env,
		Table *	table,
		unsigned char	data
	)

Add a byte column to a Table with only one row.

Note: The framework will release all memory associated with a Table when you return from your API implementation.

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	The Table to add the column to.
data	The data to add to this column, an `unsigned char`.

See also: tableCreate(), tableAddColumn(), tableAddStringColumn() tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowStringColumn(),

Note: The framework will release all memory associated with a Table when you return from your API implementation.

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	The Table to add the column to.
data	The data to add to this column, an `unsigned char`.

See also: tableCreate(), tableAddColumn(), tableAddStringColumn() tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowStringColumn(),

Definition at line 1025 of file aida_pva_types_helper.c.

{
    tableAddColumn(env, table, AIDA_BYTE_TYPE, &data, false);
}

References AIDA_BYTE_TYPE, and tableAddColumn().

Referenced by aidaRequestTable().

◆ tableAddSingleRowDoubleColumn()

void tableAddSingleRowDoubleColumn	(	JNIEnv *	env,
		Table *	table,
		double	data,
		bool	ieeeDouble
	)

Add a double column to a Table with only one row.

Note: The framework will release all memory associated with a Table when you return from your API implementation.

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	The Table to add the column to.
data	The data to add to this column, a `double`.
ieeeDouble	True if the data is in ieee format, otherwise the double precision floating point number is converted from VMS to ieee format.

See also: tableCreate(), tableAddColumn(), tableAddStringColumn() tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowStringColumn(),

Definition at line 1175 of file aida_pva_types_helper.c.

{
    tableAddColumn(env, table, AIDA_DOUBLE_TYPE, &data, ieeeDouble);
}

References AIDA_DOUBLE_TYPE, and tableAddColumn().

Referenced by aidaRequestTable(), and aidaSetValueWithResponse().

◆ tableAddSingleRowFloatColumn()

void tableAddSingleRowFloatColumn	(	JNIEnv *	env,
		Table *	table,
		float	data,
		bool	ieeeFloat
	)

Add a float column to a Table with only one row.

Note: The framework will release all memory associated with a Table when you return from your API implementation.

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	The Table to add the column to.
data	The data to add to this column, a `float`.
ieeeFloat	True if the data is in ieee format, otherwise the given floating point number is converted from VMS to ieee format.

See also: tableCreate(), tableAddColumn(), tableAddStringColumn() tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowStringColumn(),

Note: The framework will release all memory associated with a Table when you return from your API implementation.

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	The Table to add the column to.
data	The data to add to this column, a `float`.
ieeeFloat	True if the data is in ieee format, otherwise the given floating point number is converted from VMS to ieee format.

See also: tableCreate(), tableAddColumn(), tableAddStringColumn() tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowStringColumn(),

Definition at line 1144 of file aida_pva_types_helper.c.

{
    tableAddColumn(env, table, AIDA_FLOAT_TYPE, &data, ieeeFloat);
}

References AIDA_FLOAT_TYPE, and tableAddColumn().

Referenced by aidaRequestTable().

◆ tableAddSingleRowIntegerColumn()

void tableAddSingleRowIntegerColumn	(	JNIEnv *	env,
		Table *	table,
		int	data
	)

Add a integer column to a Table with only one row.

Note: The framework will release all memory associated with a Table when you return from your API implementation.

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	the Table to add the column to.
data	the data to add to this column, an `int`

See also: tableCreate(), tableAddColumn(), tableAddStringColumn() tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowStringColumn(),

Definition at line 1083 of file aida_pva_types_helper.c.

{
    tableAddColumn(env, table, AIDA_INTEGER_TYPE, &data, false);
}

References AIDA_INTEGER_TYPE, and tableAddColumn().

Referenced by aidaRequestTable().

◆ tableAddSingleRowLongColumn()

void tableAddSingleRowLongColumn	(	JNIEnv *	env,
		Table *	table,
		long	data
	)

Add a long column to a Table with only one row.

Note: The framework will release all memory associated with a Table when you return from your API implementation.

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	the Table to add the column to.
data	the data to add to this column. A `long` value

See also: tableCreate(), tableAddColumn(), tableAddStringColumn() tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowStringColumn(),

Note: The framework will release all memory associated with a Table when you return from your API implementation.

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	the Table to add the column to.
data	the data to add to this column. A `long` value

See also: tableCreate(), tableAddColumn(), tableAddStringColumn() tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowStringColumn(),

Definition at line 1113 of file aida_pva_types_helper.c.

{
    tableAddColumn(env, table, AIDA_LONG_TYPE, &data, false);
}

References AIDA_LONG_TYPE, and tableAddColumn().

Referenced by aidaRequestTable().

◆ tableAddSingleRowShortColumn()

void tableAddSingleRowShortColumn	(	JNIEnv *	env,
		Table *	table,
		short	data
	)

Add a short column to a Table with only one row.

Note: The framework will release all memory associated with a Table when you return from your API implementation.

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	The Table to add the column to.
data	The data to add to this column, a `short`.

See also: tableCreate(), tableAddColumn(), tableAddStringColumn() tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowStringColumn(),

Definition at line 1054 of file aida_pva_types_helper.c.

{
    tableAddColumn(env, table, AIDA_SHORT_TYPE, &data, false);
}

References AIDA_SHORT_TYPE, and tableAddColumn().

Referenced by aidaRequestTable().

◆ tableAddSingleRowStringColumn()

void tableAddSingleRowStringColumn	(	JNIEnv *	env,
		Table *	table,
		char *	data
	)

Add a string column to a Table with only one row.

This is a shortcut Table function that simplifies adding a string to a Table with only one row.

Note: The framework will release all memory associated with a Table when you return from your API implementation.

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	the Table to add the column to.
data	the data to add to this column. A single string.

See also: tableCreate(), tableAddColumn(), tableAddStringColumn() tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowDoubleColumn(),

Definition at line 1205 of file aida_pva_types_helper.c.

{
    tableAddStringColumn(env, table, &data);
}

References tableAddStringColumn().

Referenced by aidaRequestTable().

◆ tableAddStringColumn()

void tableAddStringColumn	(	JNIEnv *	env,
		Table *	table,
		char **	data
	)

Add a String column to the given Table.

This reads data from a buffer that is itself a list of pointers to strings. We allocate just enough space to store the strings in our Table. This is allocated in one buffer so there is only one pointer to release.

Note: The framework will release all memory associated with a Table when you return from your API implementation.

Parameters

env	The JNI environment. Used in all functions involving JNI.
table	the Table to add the string column to.
data	the data to add to this column, a buffer of `sizeof(char ) table->rowCount` size. This will contain the strings to be added to the Table.

See also: tableCreate(), tableAddColumn(), tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowStringColumn(),

Example

Create a single column, one row Table, add data, and return.

int rows = 1, columns = 1;
char* namesData[rows];
namesData[0] = "NAME";
 
Table table = tableCreate(env, rows, columns);
ON_EXCEPTION_RETURN_(table)
tableAddStringColumn(env, &table, namesData);
ON_EXCEPTION_RETURN_(table)
return table;

Note: You need to call ON_EXCEPTION_RETURN_(table) after each call to make sure that no exception was raised.

Definition at line 912 of file aida_pva_types_helper.c.

{
    tableAddColumn(env, table, AIDA_STRING_ARRAY_TYPE, data, false);
    ON_EXCEPTION_RETURN_VOID
 
    // allocate data for each string too
    char** stringArray = table->ppData[table->_currentColumn];
    for (int row = 0; row < table->rowCount; row++, data++) {
        ALLOCATE_STRING_AND_ON_ERROR_RETURN_VOID(env, stringArray[row], *data, "table strings")
    }
 
    table->_currentColumn++;
}

References Table::_currentColumn, AIDA_STRING_ARRAY_TYPE, ALLOCATE_STRING_AND_ON_ERROR_RETURN_VOID, ON_EXCEPTION_RETURN_VOID, Table::ppData, Table::rowCount, and tableAddColumn().

Referenced by aidaRequestTable(), and tableAddSingleRowStringColumn().

◆ tableCreate()

Table tableCreate	(	JNIEnv *	env,
		int	rows,
		int	columns
	)

Table Handling.

Make a Table for return to client. This is the first call that needs to be made to return a Table. This will create a Table with the specified the number of rows and columns. You need to call tableAddColumn(), tableAddStringColumn(), or any of the other special tableAdd functions to add columns to the Table before returning it.

Parameters

env	The JNI environment. Used in all functions involving JNI.
rows	the number of rows to create the Table with.
columns	the number of columns to create the Table with,

Returns: the newly created Table

See also: tableAddColumn(), tableAddStringColumn() tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowStringColumn(),

Example

Create a two column, two row Table, add data, and return.

int rows = 2, columns = 2;
float xData[rows] = { 1.0f, 2.0f }, yData[rows] = { 7.0f, 8.0f };
 
Table table = tableCreate(env, rows, columns);
ON_EXCEPTION_RETURN_(table)
tableAddColumn(env, &table, AIDA_FLOAT_TYPE, xData, true);
ON_EXCEPTION_RETURN_(table)
tableAddColumn(env, &table, AIDA_FLOAT_TYPE, yData, true);
ON_EXCEPTION_RETURN_(table)
return table;

Note: You need to call ON_EXCEPTION_RETURN_(table) after each call to make sure that no exception was raised.

Table Handling.

This is the first call that needs to be made to return a Table. This will create a Table with the specified the number of rows and columns. You need to call tableAddColumn(), tableAddStringColumn(), or any of the other special tableAdd functions to add columns to the Table before returning it.

Parameters

env	The JNI environment. Used in all functions involving JNI.
rows	the number of rows to create the Table with.
columns	the number of columns to create the Table with,

Returns: the newly created Table

See also: tableAddColumn(), tableAddStringColumn() tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowStringColumn(),

Example

Create a two column, two row Table, add data, and return.

int rows = 2, columns = 2;
float xData[rows] = { 1.0f, 2.0f }, yData[rows] = { 7.0f, 8.0f };
 
Table table = tableCreate(env, rows, columns);
ON_EXCEPTION_RETURN_(table)
tableAddColumn(env, &table, AIDA_FLOAT_TYPE, xData, true);
ON_EXCEPTION_RETURN_(table)
tableAddColumn(env, &table, AIDA_FLOAT_TYPE, yData, true);
ON_EXCEPTION_RETURN_(table)
return table;

Note: You need to call ON_EXCEPTION_RETURN_(table) after each call to make sure that no exception was raised.

Definition at line 672 of file aida_pva_types_helper.c.

{
    Table table;
    memset(&table, 0, sizeof(table));
    table._currentColumn = 0;  // Reset current column so that any addColumn() calls are correct
    table.columnCount = 0;
 
    if (rows <= 0) {
        aidaThrowNonOsException(env, AIDA_INTERNAL_EXCEPTION, "Attempt to allocate a zero length table");
        return table;
    }
 
    // Allocate space for the table columns and column types
    ALLOCATE_MEMORY_AND_ON_ERROR_RETURN_(env, table.ppData, columns * sizeof(void*), "table columns", table)
    ALLOCATE_MEMORY_AND_ON_ERROR_RETURN_(env, table.types, columns * sizeof(Type*), "table column types", table)
    table.rowCount = rows;
    table.columnCount = columns;
    return table;
}

References Table::_currentColumn, AIDA_INTERNAL_EXCEPTION, aidaThrowNonOsException(), ALLOCATE_MEMORY_AND_ON_ERROR_RETURN_, Table::columnCount, Table::ppData, Table::rowCount, and Table::types.

Referenced by aidaRequestTable(), aidaSetValueWithResponse(), and tableCreateDynamic().

◆ tableCreateDynamic()

Table tableCreateDynamic	(	JNIEnv *	env,
		int	rows,
		int	columns
	)

Make a Dynamic Table for return to client.

This is the first call that needs to be made to return a Dynamic Table. This will create a Table with the specified the number of rows and columns. You need to call tableAddColumn(), tableAddStringColumn(), tableAddField(), tableAddLabel(), or any of the other special tableAdd functions to add columns to the Table before returning it. Calling tableAddField(), and tableAddLabel() are mandatory

Parameters

env	The JNI environment. Used in all functions involving JNI.
rows	the number of rows to create the Table with.
columns	the number of columns to create the Table with,

Returns: the newly created Table

See also: tableAddColumn(), tableAddField(), tableAddLabel(), tableAddStringColumn() tableAddFixedWidthStringColumn(), tableAddSingleRowBooleanColumn(), tableAddSingleRowByteColumn(), tableAddSingleRowShortColumn(), tableAddSingleRowIntegerColumn(), tableAddSingleRowLongColumn(), tableAddSingleRowFloatColumn(), tableAddSingleRowDoubleColumn(), tableAddSingleRowStringColumn(),

Example

Create a two column, two row Table, Set Field names, and labels, add data, and return.

int rows = 2, columns = 2;
float xData[rows] = { 1.0f, 2.0f }, yData[rows] = { 7.0f, 8.0f };
char *fields[columns] = { "field1", "field2" };
char *labels[columns] = { "label1", "label2" };
 
Table table = tableCreateDynamic(env, rows, columns);
ON_EXCEPTION_RETURN_(table)
tableAddColumn(env, &table, AIDA_FLOAT_TYPE, xData, true);
ON_EXCEPTION_RETURN_(table)
tableAddField(env, &table, fields[0]);
ON_EXCEPTION_RETURN_(table)
tableAddLabel(env, &table, labels[0]);
ON_EXCEPTION_RETURN_(table)
tableAddColumn(env, &table, AIDA_FLOAT_TYPE, yData, true);
ON_EXCEPTION_RETURN_(table)
tableAddField(env, &table, fields[1]);
ON_EXCEPTION_RETURN_(table)
tableAddLabel(env, &table, labels[1]);
ON_EXCEPTION_RETURN_(table)
return table;

Note: You need to call ON_EXCEPTION_RETURN_(table) after each call to make sure that no exception was raised.

Definition at line 692 of file aida_pva_types_helper.c.

                                                             {
    Table table = tableCreate(env, rows, columns);
    ON_EXCEPTION_RETURN_(table);
 
    table._currentField = 0;  // Reset current field so that any addField() calls are correct
    ALLOCATE_MEMORY_AND_ON_ERROR_RETURN_(env, table.ppFields, columns * sizeof(char*), "table fields", table)
    table._currentLabel = 0;  // Reset current label so that any addLabel() calls are correct
    ALLOCATE_MEMORY_AND_ON_ERROR_RETURN_(env, table.ppLabels, columns * sizeof(char*), "table fields", table)
    return table;
}

References Table::_currentField, Table::_currentLabel, ALLOCATE_MEMORY_AND_ON_ERROR_RETURN_, ON_EXCEPTION_RETURN_, Table::ppFields, Table::ppLabels, and tableCreate().

Referenced by aidaRequestTable().

◆ uriLegacyName()

void uriLegacyName	(	char	legacyName[MAX_URI_LEN],
		const char *	uri
	)

Convert the given URI to the legacy AIDA name for low level functions that still require it that way.

Parameters

legacyName	pointer to space to store the legacy AIDA name
uri	the new format AIDA PV name

Parameters

legacyName	pointer to space to store the legacy AIDA name
uri	the new format AIDA PV name

Definition at line 599 of file aida_pva_server_helper.c.

{
    char* firstSeparator = strchr(uri, ':');
    char* secondSeparator = strchr(firstSeparator + 1, ':');
    char* lastSeparator = strrchr(uri, ':');
    // See how many colons.  If only three then this is a pseudo and we need to separate after first
    if (lastSeparator == secondSeparator) {
        // This has only three parts so separate at first colon
        memcpy(legacyName, uri, firstSeparator - uri);
        memcpy(legacyName + (firstSeparator - uri), "//", 2);
        strcpy(legacyName + (firstSeparator - uri) + 2, firstSeparator + 1);
    } else {
        // Normal URI separate at last colon
        memcpy(legacyName, uri, lastSeparator - uri);
        memcpy(legacyName + (lastSeparator - uri), "//", 2);
        strcpy(legacyName + (lastSeparator - uri) + 2, lastSeparator + 1);
    }
}

◆ uriToSlcName()

void uriToSlcName	(	char	slcName[MAX_URI_LEN],
		const char *	uri
	)

Convert all URIs to slac names before making queries.

Parameters

slcName	pointer to space to store the SLC name
uri	the new format AIDA PV name

Parameters

slcName	pointer to space to store the SLC name
uri	the new format AIDA PV name

Definition at line 583 of file aida_pva_server_helper.c.

{
    char* separator = strrchr(uri, ':');
    if (separator) {
        memcpy(slcName, uri, separator - uri);
        memcpy(slcName + (separator - uri), ".", 1);
        strcpy(slcName + (separator - uri) + 1, separator + 1);
    }
}

Functions

Detailed Description

Function Documentation

◆ aidaThrow()

◆ aidaThrowNonOsException()

◆ allocateMemory()

◆ ascanf()

Synopsis

Details

Synopsis

Details

◆ avscanf()

Synopsis

Details

Differences to scanf()

General differences

Argument names

Format Specifiers

Type specifiers

Required flag

Prefixes

Suffixes

Synopsis

Details

Differences to scanf()

General differences

Argument names

Format Specifiers

Type specifiers

Required flag

Prefixes

Suffixes

◆ endsWith()

◆ groupNameFromUri()

◆ init()

◆ pmuFromDeviceName()

◆ pmuStringFromUri()

◆ releaseArray()

◆ releasePvAndArguments()

◆ releaseStringArray()

◆ releaseTable()

◆ releaseValue()

◆ secnFromUri()

◆ secondaryFromUri()

◆ startsWith()

◆ tableAddColumn()

Example

◆ tableAddField()

◆ tableAddFixedWidthStringColumn()

◆ tableAddLabel()

◆ tableAddSingleRowBooleanColumn()

◆ tableAddSingleRowByteColumn()

◆ tableAddSingleRowDoubleColumn()

◆ tableAddSingleRowFloatColumn()

◆ tableAddSingleRowIntegerColumn()

◆ tableAddSingleRowLongColumn()

◆ tableAddSingleRowShortColumn()

◆ tableAddSingleRowStringColumn()

◆ tableAddStringColumn()

Example

◆ tableCreate()

Example

Example

◆ tableCreateDynamic()

Example

◆ uriLegacyName()

◆ uriToSlcName()