Preloading data arrays with initial values, Introduction, Parameters used to define preloads – ProSoft Technology PS-QS-1x10-0781 User Manual
Page 39

FieldServer Configuration Manual
Page 39 of 90
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-2269 Toll Free: (888) 509-1970 email: [email protected]
5.6
Preloading Data Arrays with Initial Values
5.6.1 Introduction
Preloads provide a technique which allows parts of one or more Data Arrays to be initialized to specified values.
The Preloads are defined in a configuration file and loaded once when the configuration file is loaded as the
FieldServer starts.
It is also possible to use the FieldServer scripting language to have the FieldServer load a configuration file and
then poke values into the Data Arrays. For more information on this technique call FST Tech Support.
5.6.2 Parameters used to define Preloads
Section Title
Preloads
Column Title
Function
Legal Values
Data_Array_Name
Name of the Data Array to be preloaded. The Data
Array must exist or be defined in the configuration file
and its definition must precede the preload that
references it. If not, System Error Message 10117 will
be printed.
Up to 15 alphanumeric
characters
One of the following:
Data_Array_Offset
Preload_Data_Index
Location
Data_Array_Location
Data_Array_Index
Buffer_Offset
The location in the Data Array to be preloaded.
0
to
maximum
where
maximum is the length of the
Data Array being referenced
less 1.
e.g. If the Data Array length is
200, the maximum value of
this parameter is 199.
Length
Not used. A length of 1 is always applied.
One of the following:
Preload_Data_Value
Preload_Value
Specify the value to be used to initialize the Data Array
Location. If the Data Array specified is a Data Array of
Complex Data Objects (CDO) then the kernel stores
the value to the objects ‘Present_Value’ field. The
value is assumed to be a floating point value and the
format specified by the parameter below is ignored.
Any number – may be
specified with a fractional
part, e.g.0, 1, 1.01,-1, 123.456
A String
7
.
One of the following:
Preload_Data_Format*
Data_Array_Format*
Data_Format*
This parameter tells the kernel how to interpret and
apply
the
value
specified
using
the
“Preload_Data_Value” parameter. (not to be confused
with the format of the Data Array).
Float, Bit, Byte, Uint16,
Uint32, Int16, Int32, String
8
, -
Preload_Obj_Name*
If this parameter is specified then the kernel takes the
value specified by the parameter and uses it to assign
a ‘Name’ to the Data Array object if the Data Array is
an array of Complex Data Objects (CDO).
A maximum of 39 characters.
Leading/trailing spaces and
tabs are ignored. Commas not
supported; support for other
special characters unknown, -
7
Strings: This has been tested with strings up to 320 characters long. Leading and trailing spaces and tabs are ignored, commas cannot be used
and support for other special characters is unknown. Format must be specified as ‘STRING’. The case of the characters is preserved.
8
Must be specified as String if Preload_Value is String.