aida_pva_types.h File Reference

The Header File for the type enumerations, unions, and typedefs. More...

#include <jni.h>
#include <stdbool.h>
#include "aida_pva_json.h"
#include "aida_pva.h"

Go to the source code of this file.

Data Structures
struct	Argument
	A single request argument. More...
struct	Arguments
	An Arguments structure stores all of the arguments passed from the request to the Native Channel Provider. More...
struct	Array
	An array of data. More...
struct	FloatingPointValue
	Represents a floating point number. More...
union	FloatOrDoubleValue
	This union stores the value part of a FloatingPointValue. More...
struct	StringArray
	An array of string data. More...
struct	Table
	Table structure. More...
struct	Value
	This special type represents a Value. More...
union	ValueContents
	This union stores either the string or the json_value of a Value. More...

Enumerations
enum	Type {   AIDA_NO_TYPE , AIDA_VOID_TYPE , AIDA_BOOLEAN_TYPE , AIDA_BYTE_TYPE ,   AIDA_SHORT_TYPE , AIDA_INTEGER_TYPE , AIDA_LONG_TYPE , AIDA_FLOAT_TYPE ,   AIDA_DOUBLE_TYPE , AIDA_STRING_TYPE , AIDA_BOOLEAN_ARRAY_TYPE , AIDA_BYTE_ARRAY_TYPE ,   AIDA_SHORT_ARRAY_TYPE , AIDA_INTEGER_ARRAY_TYPE , AIDA_LONG_ARRAY_TYPE , AIDA_FLOAT_ARRAY_TYPE ,   AIDA_DOUBLE_ARRAY_TYPE , AIDA_STRING_ARRAY_TYPE , AIDA_TABLE_TYPE , AIDA_JSON_TYPE ,   AIDA_UNSIGNED_SHORT_TYPE , AIDA_UNSIGNED_INTEGER_TYPE , AIDA_UNSIGNED_LONG_TYPE , AIDA_UNSIGNED_SHORT_ARRAY_TYPE ,   AIDA_UNSIGNED_INTEGER_ARRAY_TYPE , AIDA_UNSIGNED_LONG_ARRAY_TYPE }
	The definition of Aida Types. More...

Detailed Description

The Header File for the type enumerations, unions, and typedefs.

CMS=C_INC

Definition in file aida_pva_types.h.

Enumeration Type Documentation

Type

enum Type

The definition of Aida Types.

Defines the permissible types of fields. This enumerated type defines all the possible AIDA-PVA types and classes.

Enumerator
AIDA_NO_TYPE	Used to indicate that no type was provided as an argument.
AIDA_VOID_TYPE	Used when no return value is to be returned from a channel.
AIDA_BOOLEAN_TYPE	Represents a boolean.
AIDA_BYTE_TYPE	Represents a byte.
AIDA_SHORT_TYPE	Represents a short.
AIDA_INTEGER_TYPE	Represents an integer.
AIDA_LONG_TYPE	Represents a long.
AIDA_FLOAT_TYPE	Represents a float.
AIDA_DOUBLE_TYPE	Represents a double.
AIDA_STRING_TYPE	Represents a string.
AIDA_BOOLEAN_ARRAY_TYPE	Represents a boolean array.
AIDA_BYTE_ARRAY_TYPE	Represents a byte array.
AIDA_SHORT_ARRAY_TYPE	Represents a short array.
AIDA_INTEGER_ARRAY_TYPE	Represents an integer array.
AIDA_LONG_ARRAY_TYPE	Represents a long array.
AIDA_FLOAT_ARRAY_TYPE	Represents a float array.
AIDA_DOUBLE_ARRAY_TYPE	Represents a double array.
AIDA_STRING_ARRAY_TYPE	Represents a string array.
AIDA_TABLE_TYPE	Represents a table.
AIDA_JSON_TYPE	Argument was provided as JSON text. Internal use only: DO NOT USE IN SERVICE IMPLEMENTATIONS!!
AIDA_UNSIGNED_SHORT_TYPE	Represents an internal type of unsigned short.
AIDA_UNSIGNED_INTEGER_TYPE	Represents an internal type of unsigned integer.
AIDA_UNSIGNED_LONG_TYPE	Represents an internal type of unsigned long.
AIDA_UNSIGNED_SHORT_ARRAY_TYPE	Represents an internal type of unsigned short array.
AIDA_UNSIGNED_INTEGER_ARRAY_TYPE	Represents an internal type of unsigned integer array.
AIDA_UNSIGNED_LONG_ARRAY_TYPE	Represents an internal type of unsigned long array.

Definition at line 20 of file aida_pva_types.h.

{
    AIDA_NO_TYPE,                      ///< Used to indicate that no type was provided as an argument
    AIDA_VOID_TYPE,                    ///< Used when no return value is to be returned from a channel
 
    AIDA_BOOLEAN_TYPE,                 ///< Represents a boolean
    AIDA_BYTE_TYPE,                    ///< Represents a byte
    AIDA_SHORT_TYPE,                   ///< Represents a short
    AIDA_INTEGER_TYPE,                 ///< Represents an integer
    AIDA_LONG_TYPE,                    ///< Represents a long
    AIDA_FLOAT_TYPE,                   ///< Represents a float
    AIDA_DOUBLE_TYPE,                  ///< Represents a double
    AIDA_STRING_TYPE,                  ///< Represents a string
    AIDA_BOOLEAN_ARRAY_TYPE,           ///< Represents a boolean array
    AIDA_BYTE_ARRAY_TYPE,              ///< Represents a byte array
    AIDA_SHORT_ARRAY_TYPE,             ///< Represents a short array
    AIDA_INTEGER_ARRAY_TYPE,           ///< Represents an integer array
    AIDA_LONG_ARRAY_TYPE,              ///< Represents a long array
    AIDA_FLOAT_ARRAY_TYPE,             ///< Represents a float array
    AIDA_DOUBLE_ARRAY_TYPE,            ///< Represents a double array
    AIDA_STRING_ARRAY_TYPE,            ///< Represents a string array
    AIDA_TABLE_TYPE,                   ///< Represents a table
    AIDA_JSON_TYPE,                    ///< Argument was provided as JSON text
 
    ///< Internal use only: DO NOT USE IN SERVICE IMPLEMENTATIONS!!
    AIDA_UNSIGNED_SHORT_TYPE,           ///< Represents an internal type of unsigned short
    AIDA_UNSIGNED_INTEGER_TYPE,         ///< Represents an internal type of unsigned integer
    AIDA_UNSIGNED_LONG_TYPE,            ///< Represents an internal type of unsigned long
    AIDA_UNSIGNED_SHORT_ARRAY_TYPE,     ///< Represents an internal type of unsigned short array
    AIDA_UNSIGNED_INTEGER_ARRAY_TYPE,   ///< Represents an internal type of unsigned integer array
    AIDA_UNSIGNED_LONG_ARRAY_TYPE       ///< Represents an internal type of unsigned long array
} Type;