xal.smf.impl.profile

Annotation Type ASignal

@Documented
 @Inherited
 @Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface ASignal

Annotation for describing the data acquisition channels for a single plane of a wire profile measurement device. The names of the read back channels for both the position array and the value array are included here. Also, the types of these arrays can be specified.

Ported from XAL on Jul 15, 2014.
· Jonathan M. Freed

Since:

Jan 20, 2013

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	hndPosRb The name of the profile position array read back channel.
java.lang.String	hndValRb The name of the profile value array acquisition channel.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	hndCntRb The XAL channel handle for the number of active signal samples.
java.lang.String	hndNseAvgRb The name of the channel containing the signal noise mean.
java.lang.String	hndNseVarRb The name of the channel containing the signal noise variance.
java.lang.Class<?>	typeCnt The type of the sample count channel.
java.lang.Class<?>	typeNseAvg The data type of the noise mean value.
java.lang.Class<?>	typeNseVar The data type of the noise variance value.
java.lang.Class<?>	typePos The type of the profile position array.
java.lang.Class<?>	typeVal The class type of profile value array.

Element Detail

hndPosRb

public abstract java.lang.String hndPosRb

The name of the profile position array read back channel.

Returns:

the name of the channel serving up the position array, no default value

Since:

Jan 31, 2013

hndValRb

public abstract java.lang.String hndValRb

The name of the profile value array acquisition channel.

Returns:

value array channel name, no default value

Since:

Jan 31, 2013

typeCnt

public abstract java.lang.Class<?> typeCnt

The type of the sample count channel.

Returns:

class type of the sample count, default value is int.class

Since:

Jan 31, 2013

Default:

int.class

hndCntRb

public abstract java.lang.String hndCntRb

The XAL channel handle for the number of active signal samples. This differs from the size of the signal array returned by the channel in ADaqWire.Signal.Hor#hndPosRb which is the buffer size of the DAQ controller.

Returns:

channel handle for the number of signal samples, default ""

Since:

Jan 31, 2013

Default:

""

typePos

public abstract java.lang.Class<?> typePos

The type of the profile position array.

Returns:

the class type of the position array, default value is double[].class

Since:

Jan 31, 2013

Default:

double[].class

typeVal

public abstract java.lang.Class<?> typeVal

The class type of profile value array.

Returns:

the type of the value array, default value is double[].class

Since:

Jan 31, 2013

Default:

double[].class

typeNseAvg

public abstract java.lang.Class<?> typeNseAvg

The data type of the noise mean value. The default value is double.class.

Returns:

class type of the noise mean parameter, default value is double.class

Since:

Dec 7, 2011

Default:

double.class

hndNseAvgRb

public abstract java.lang.String hndNseAvgRb

The name of the channel containing the signal noise mean.

Returns:

noise variance channel name, default value is "" (empty string)

Since:

Dec 7, 2011

Default:

""

typeNseVar

public abstract java.lang.Class<?> typeNseVar

The data type of the noise variance value.

Returns:

class type of the noise variance parameter, the default value is double.class.

Since:

Dec 7, 2011

Default:

double.class

hndNseVarRb

public abstract java.lang.String hndNseVarRb

The name of the channel containing the signal noise variance.

Returns:

noise variance channel name, no default value

Since:

Dec 7, 2011

Default:

""