xal.smf.scada

Annotation Type AScada.Record

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public static @interface AScada.Record

Alternate method of annotating the fields of a SCADA structure. The data structure itself is annotated, rather than each individual field. The annotations are thus arrays of field properties, each array containing an entry for each field of the structure.

Since:

Sep 30, 2011

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
boolean[]	arrCtl Array of controllable flags for each SCADA field in the data structure.
java.lang.String[]	arrHndCtl Array of all the XAL Channel handles for the SCADA fields in this data structure.
java.lang.String[]	arrHndRb Array of all the XAL Channel handles for the SCADA fields in this data structure.
java.lang.String[]	arrNames Array of all the SCADA field names within the data structure.
java.lang.Class<?>[]	arrTypes Array of the class types of all the SCADA fields within this data structure.
int	cntFlds The number of SCADA fields within the data structure.

Element Detail

cntFlds

public abstract int cntFlds

The number of SCADA fields within the data structure. Thus, also the size of each property array.

Returns:

number of SCADA fields

Since:

Sep 30, 2011

arrNames

public abstract java.lang.String[] arrNames

Array of all the SCADA field names within the data structure. These are Java class attributes which are to be specified as SCADA fields.

Returns:

array containing the names of the SCADA fields

Since:

Sep 30, 2011

arrTypes

public abstract java.lang.Class<?>[] arrTypes

Array of the class types of all the SCADA fields within this data structure.

Returns:

array of class types for the SCADA fields

Since:

Sep 30, 2011

arrHndRb

public abstract java.lang.String[] arrHndRb

Array of all the XAL Channel handles for the SCADA fields in this data structure. These are the read back channels.

Returns:

array of read back channel handles

Since:

Sep 30, 2011

arrHndCtl

public abstract java.lang.String[] arrHndCtl

Array of all the XAL Channel handles for the SCADA fields in this data structure. These are the set value channels.

Returns:

array of set value channel handles

Since:

Sep 30, 2011

arrCtl

public abstract boolean[] arrCtl

Array of controllable flags for each SCADA field in the data structure. If the field is flagged as true then a non-null set-value channel handle must be present.

Returns:

array of controllable PV flags for each SCADA field

Since:

Sep 30, 2011