AIDASLCUTIL_SERVER.c File Reference

Utility Native Provider implementation. More...

#include <descrip.h>
#include <float.h>
#include "aida_pva.h"
#include "descr.h"
#include "ref.h"
#include "crrcntl_parms.h"
#include "bpmutil_proto.h"
#include "AIDASLCUTIL_SERVER.h"

Go to the source code of this file.

Functions
int	aidaRequestBoolean (JNIEnv *env, const char *uri, Arguments arguments)
	Get a Boolean. More...
int	aidaRequestInteger (JNIEnv *env, const char *uri, Arguments arguments)
	Get an integer. More...
long	aidaRequestLong (JNIEnv *env, const char *uri, Arguments arguments)
	Get a integer. More...
short	aidaRequestShort (JNIEnv *env, const char *uri, Arguments arguments)
	Get a short. More...
char *	aidaRequestString (JNIEnv *env, const char *uri, Arguments arguments)
	Get a string. More...
Table	aidaRequestTable (JNIEnv *env, const char *uri, Arguments arguments)
	Implement Correlated Plots. More...
REQUEST_STUB_BYTE REQUEST_STUB_FLOAT REQUEST_STUB_DOUBLE REQUEST_STUB_BOOLEAN_ARRAY REQUEST_STUB_BYTE_ARRAY REQUEST_STUB_SHORT_ARRAY REQUEST_STUB_INTEGER_ARRAY REQUEST_STUB_LONG_ARRAY REQUEST_STUB_FLOAT_ARRAY REQUEST_STUB_DOUBLE_ARRAY REQUEST_STUB_STRING_ARRAY void	aidaServiceInit (JNIEnv *env)
	Initialise the service. More...
void	aidaSetValue (JNIEnv *env, const char *uri, Arguments arguments, Value value)
	Set a value: BGRP Set Variable or SCP transverse feedback. More...
Table	aidaSetValueWithResponse (JNIEnv *env, const char *uri, Arguments arguments, Value value)
	Set a value and return a table as a response. More...

Detailed Description

Utility Native Provider implementation.

MEMBER=SLCLIBS:AIDA_PVALIB ATTRIBUTES=JNI,LIBR_NOGLOBAL

Definition in file AIDASLCUTIL_SERVER.c.

Function Documentation

aidaRequestBoolean()

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

Get a 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 100 of file AIDASLCUTIL_SERVER.c.

                                                                          {
    return getShortFaStatus(env, uri) == 0 ? false : true;
}

References aidaThrow(), TO_SLC_NAME, and UNABLE_TO_GET_DATA_EXCEPTION.

aidaRequestInteger()

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

Get an 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 88 of file AIDASLCUTIL_SERVER.c.

                                                                          {
    return getShortFaStatus(env, uri);
}

References aidaThrow(), TO_SLC_NAME, and UNABLE_TO_GET_DATA_EXCEPTION.

aidaRequestLong()

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

Get a integer.

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 112 of file AIDASLCUTIL_SERVER.c.

                                                                        {
    if (startsWith(uri, "FBCK")) {
        return (long)faStatus(env, uri, 0, TRUE_B);
    } else {
        return (long)getTrigStatus(env, uri, arguments);
    }
}

References aidaThrow(), startsWith(), TO_SLC_NAME, and UNABLE_TO_GET_DATA_EXCEPTION.

aidaRequestShort()

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

Get a 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 72 of file AIDASLCUTIL_SERVER.c.

                                                                          {
    if (startsWith(uri, "FBCK")) {
        return getShortFaStatus(env, uri);
    } else {
        return getTrigStatus(env, uri, arguments);
    }
}

References aidaThrow(), startsWith(), TO_SLC_NAME, and UNABLE_TO_GET_DATA_EXCEPTION.

aidaRequestString()

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

Get a 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 128 of file AIDASLCUTIL_SERVER.c.

                                                                           {
    if (startsWith(uri, "FBCK")) {
        return GetStringFaStatus(env, uri);
    } else {
        // Read the status
        short trig_status = getTrigStatus(env, uri, arguments);
        ON_EXCEPTION_RETURN_(NULL)
 
        if (trig_status) {
            return ALLOCATE_STRING(env, "activated", "string");
        } else {
            return ALLOCATE_STRING(env, "deactivated", "string");
        }
    }
}

References aidaThrow(), ALLOCATE_STRING, ON_EXCEPTION_RETURN_, startsWith(), TO_SLC_NAME, and UNABLE_TO_GET_DATA_EXCEPTION.

aidaRequestTable()

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

Implement Correlated Plots.

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 164 of file AIDASLCUTIL_SERVER.c.

                                                                          {
    REF_DECLARE;
    DESCR_DECLARE;
 
    TRACK_ALLOCATED_MEMORY
 
    // Blank table
    Table table;
    table.columnCount = 0;
 
    // Get button file name
    char* buttonFileName;
    char* primaryStepVariable, * secondaryStepVariable, * magnetFunction;
    float primaryLow, primaryHigh, primarySettleTime, primaryExtraSettleTime, secondaryLow, secondaryHigh, secondarySettleTime, secondaryExtraSettleTime, settle;
    int primarySteps, secondarySteps;
    long nrpos = NRPOS_DEFAULT, dtizavg;
    short bpmd = BPMD_ROGUE;
 
    bool secondaryStepVariableProvided = getAcqParameters(env, arguments, &buttonFileName, &primaryStepVariable,
            &primaryLow, &primaryHigh, &primarySteps,
            &primaryExtraSettleTime, &primarySettleTime, &secondaryStepVariable, &secondaryLow, &secondaryHigh,
            &secondarySteps,
            &secondarySettleTime, &secondaryExtraSettleTime, &bpmd, &nrpos, &dtizavg, &magnetFunction);
    ON_EXCEPTION_RETURN_(table)
    TRACK_MEMORY(buttonFileName)
    TRACK_MEMORY(primaryStepVariable)
    TRACK_MEMORY(secondaryStepVariable)
 
    vmsstat_t status;
 
    // Initialize correlation plot context
    status = CRR_RESET_ALL();
    if (!SUCCESS(status)) {
        SPRINTF_ERROR_STATUS_FREE_MEMORY_AND_RETURN_(status, UNABLE_TO_GET_DATA_EXCEPTION,
                "error resetting correlation plots: %s", buttonFileName, table)
    }
 
    // Local constant for fortran parameter
    float wire_size = 0.0f;
    float inc = (primaryHigh - primaryLow) / (float)(primarySteps - 1);
 
    // Set up primary step variable
    status = CRR_SET_VAR_NAME_FREEFORM(REFINT4_1(DEFINE_STEP), REFINT4_2(1), DESCRN1(primaryStepVariable),
            REFINT4_3(0));
    if (!SUCCESS(status)) {
        SPRINTF_ERROR_STATUS_FREE_MEMORY_AND_RETURN_(status, UNABLE_TO_GET_DATA_EXCEPTION,
                "error setting primary step variable name: %s", primaryStepVariable, table)
    }
    status = CRR_SET_STEP(REFINT4_1(1), &primaryLow, &inc, &primarySteps, &primarySettleTime);
    if (!SUCCESS(status)) {
        SPRINTF_ERROR_STATUS_FREE_MEMORY_AND_RETURN_(status, UNABLE_TO_GET_DATA_EXCEPTION,
                "error setting primary step variable: %s", primaryStepVariable, table)
    }
 
    // Set secondary step variable
    if (secondaryStepVariableProvided) {
        status = CRR_SET_VAR_NAME_FREEFORM(REFINT4_1(DEFINE_STEP), REFINT4_2(-1), DESCRN1(secondaryStepVariable),
                REFINT4_3(0));
        if (!SUCCESS(status)) {
            SPRINTF_ERROR_STATUS_FREE_MEMORY_AND_RETURN_(status, UNABLE_TO_GET_DATA_EXCEPTION,
                    "error setting secondary step variable name: %s", secondaryStepVariable, table)
        }
 
        inc = (secondaryHigh - secondaryLow) / (float)(secondarySteps - 1);
        status = CRR_SET_STEP(REFINT4_1(-1), &secondaryLow, &inc, &secondarySteps, &secondarySettleTime);
        if (!SUCCESS(status)) {
            SPRINTF_ERROR_STATUS_FREE_MEMORY_AND_RETURN_(status, UNABLE_TO_GET_DATA_EXCEPTION,
                    "error setting secondary step variable: %s", secondaryStepVariable, table)
        }
    }
 
    // Make absolute file name
    char fullyQualifiedButtonFileName[strlen(buttonFileName) + strlen(SLC_BUTTON_DIR) + 1];
    sprintf(fullyQualifiedButtonFileName, "%s%s", SLC_BUTTON_DIR, buttonFileName);
 
    // Load button file
    status = CRR_RESTORE_BUTTON_FILE(DESCRN1(fullyQualifiedButtonFileName));
    if (!SUCCESS(status)) {
        SPRINTF_ERROR_STATUS_FREE_MEMORY_AND_RETURN_(status, UNABLE_TO_GET_DATA_EXCEPTION,
                "error loading scan parameters from button file: %s", fullyQualifiedButtonFileName, table)
    }
 
    // Set BPM Measurement Definition if it has been specified
    if (bpmd != BPMD_ROGUE) {
        status = BPMD_SELECT_UTIL(&bpmd, NULL, NULL, NULL, NULL, NULL);
        if (!SUCCESS(status)) {
            fprintf(stderr, "Failed to set Measurement Definition: %hd", bpmd);
            SPRINTF_ERROR_STATUS_FREE_MEMORY_AND_RETURN_(status, UNABLE_TO_GET_DATA_EXCEPTION,
                    "error initializing correlation plot acquisition: %s", buttonFileName, table)
        }
    }
 
    long magfunc;
    memcpy(&magfunc, magnetFunction, 4);
    float settleExtra[2];
    settleExtra[0] = primaryExtraSettleTime;
    settleExtra[1] = secondaryExtraSettleTime;
 
    status = CRR_SET_SAMP_PARMS(&nrpos, &dtizavg, NULL, &magfunc, NULL, NULL, NULL, &settleExtra[0]);
    if (!SUCCESS(status)) {
        fprintf(stderr,
                "Failed to set sample params.  nrpos: %ld, dtizavg: %ld,  magfunc: %ld,  primSettleExtra: %f,  secnSettleExtra: %f",
                nrpos, dtizavg, magfunc, settleExtra[0], settleExtra[1]);
        SPRINTF_ERROR_STATUS_FREE_MEMORY_AND_RETURN_(status, UNABLE_TO_GET_DATA_EXCEPTION,
                "error initializing correlation plot acquisition: %s", buttonFileName, table)
    }
 
    status = CRR_DATA_ACQ_INIT();
    if (!SUCCESS(status)) {
        SPRINTF_ERROR_STATUS_FREE_MEMORY_AND_RETURN_(status, UNABLE_TO_GET_DATA_EXCEPTION,
                "error initializing correlation plot acquisition: %s", buttonFileName, table)
    }
 
    // Run Correlation plot
    status = CRR_DATA_ACQ(DESCRN1("*"));
    if (!SUCCESS(status)) {
        CRR_DATA_ACQ_DONE();
        SPRINTF_ERROR_STATUS_FREE_MEMORY_AND_RETURN_(status, UNABLE_TO_GET_DATA_EXCEPTION,
                "executing correlation plot: %s", buttonFileName, table)
    }
    printf("Scan Complete");
 
    // Number of Samples
    long nSampleVariables;
    if (countSampleVariables(env, &nSampleVariables)) {
        CRR_DATA_ACQ_DONE();
        return table;
    }
 
    // Get step count.
    int nSteps = CRR_SAMPLES();
    if (!SUCCESS(status)) {
        CRR_DATA_ACQ_DONE();
        SPRINTF_ERROR_FREE_MEMORY_AND_RETURN_(UNABLE_TO_GET_DATA_EXCEPTION,
                "error getting number of steps: %s", buttonFileName, table)
    }
 
    // Get total number of samples
    long totalSampleVariables = nSampleVariables + ((secondaryStepVariableProvided) ? 2 : 1);
    if (!totalSampleVariables || !nSampleVariables) {
        CRR_DATA_ACQ_DONE();
        fprintf(stderr, "Invalid number of sample variables. totalSampleVariables: %ld, nSampleVariables: %ld",
                totalSampleVariables, nSampleVariables);
        SPRINTF_ERROR_FREE_MEMORY_AND_RETURN_(UNABLE_TO_GET_DATA_EXCEPTION,
                "No sample variables have been specified in the given file: %s", buttonFileName, table)
    }
 
    // Query results variables
    if (!nSteps) {
        CRR_DATA_ACQ_DONE();
        SPRINTF_ERROR_FREE_MEMORY_AND_RETURN_(UNABLE_TO_GET_DATA_EXCEPTION,
                "Total number of steps derived from specified step variables is: %s", "0", table)
    }
 
    // Space for samples.  Organised as sets of values for all sample variables
    float* samples;
    long* samplesOk;
 
    printf("Tabulating Scan Results: %d x %ld\n", nSteps, totalSampleVariables);
    ALLOCATE_AND_TRACK_MEMORY_AND_ON_ERROR_RETURN_(env, samples, nSteps * totalSampleVariables * sizeof(float) * 2,
            "store acquired data", table)
    ALLOCATE_AND_TRACK_MEMORY_AND_ON_ERROR_RETURN_(env, samplesOk, nSteps * totalSampleVariables * sizeof(long),
            "store acquired data ok", table)
 
    // Clean up correlation plot context
    status = CRR_DATA_ACQ_DONE();
    if (!SUCCESS(status)) {
        SPRINTF_ERROR_STATUS_FREE_MEMORY_AND_RETURN_(status, UNABLE_TO_GET_DATA_EXCEPTION,
                "cleaning up after correlation plot: %s", buttonFileName, table)
    }
 
    // Allocate a dynamic table of with as many columns as samples and step variables
    table = tableCreateDynamic(env, nSteps, (int)totalSampleVariables * 3);
    ON_EXCEPTION_FREE_MEMORY_AND_RETURN_(table)
 
    // Create the correlation plot table
    createCorrelationPlotTable(env, &table, ((int)totalSampleVariables), nSteps,
            primaryStepVariable,
            secondaryStepVariableProvided, secondaryStepVariable,
            samples, samplesOk);
 
    // Free all allocated memory
    FREE_MEMORY
 
    return table;
}

References AIDA_FLOAT_TYPE, AIDA_INTEGER_TYPE, aidaThrowNonOsException(), ALLOCATE_AND_TRACK_MEMORY_AND_ON_ERROR_RETURN_, ascanf(), Table::columnCount, FREE_MEMORY, ON_EXCEPTION_FREE_MEMORY_AND_RETURN_, ON_EXCEPTION_RETURN_, RETURN_NULL_TABLE, SPRINTF_ERROR_FREE_MEMORY_AND_RETURN_, SPRINTF_ERROR_STATUS_FREE_MEMORY_AND_RETURN_, tableAddColumn(), tableAddFixedWidthStringColumn(), tableCreate(), tableCreateDynamic(), TRACK_ALLOCATED_MEMORY, TRACK_MEMORY, and UNABLE_TO_GET_DATA_EXCEPTION.

aidaServiceInit()

REQUEST_STUB_BYTE REQUEST_STUB_FLOAT REQUEST_STUB_DOUBLE REQUEST_STUB_BOOLEAN_ARRAY REQUEST_STUB_BYTE_ARRAY REQUEST_STUB_SHORT_ARRAY REQUEST_STUB_INTEGER_ARRAY REQUEST_STUB_LONG_ARRAY REQUEST_STUB_FLOAT_ARRAY REQUEST_STUB_DOUBLE_ARRAY REQUEST_STUB_STRING_ARRAY void aidaServiceInit

(

JNIEnv *

env

)

Initialise the service.

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 55 of file AIDASLCUTIL_SERVER.c.

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

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

aidaSetValue()

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

Set a value: BGRP Set Variable or SCP transverse feedback.

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 600 of file AIDASLCUTIL_SERVER.c.

                                                                                  {
    if (startsWith(uri, "FBCK")) {
        setFeedback(env, uri, arguments, value);
    } else {
        setBGrp(env, arguments, value);
    }
}

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

Definition at line 617 of file AIDASLCUTIL_SERVER.c.

                                                                                               {
    if (strcasecmp(uri, "MKB:VAL") == 0) {
        // set Multi Knob value
        return setMkbValue(env, uri, arguments, value);
    } else {
        // set TRIGGER value
        return setTriggerValue(env, uri, arguments, value);
    }
}

References aidaThrowNonOsException(), endsWith(), PMU_STRING_FROM_URI, RETURN_NULL_TABLE, UNABLE_TO_SET_DATA_EXCEPTION, and UNSUPPORTED_CHANNEL_EXCEPTION.