View source for RRM 3-13 Fanout

[[RRM 3-13|EPICS Record Reference Manual]]


= Fanout =

The fanout record uses several forward processing links to force multiple passive records to scan. When more than one record needs to be scanned as the result of a record being processed, the forward link of that record can specify a fanout record. The fanout record can specify up to six other records to process. When more than six are needed, one of the links in the fanout record can point to another fanout record.

<B>NOTE: Fanout records only propagate processing, not data. The dfanout or data fanout record can, on the other hand, send data to up to eight other records.</B>

== Parameter Fields ==

The fanout record's fields fall into the following categories:

* scan parameters
* operator display parameters
* run-time parameters.


=== Scan Parameters ===

The forward link fields of the fanout record (LINK1-LINK6) specify records to be scanned. The records to be processed must specify <CODE>Passive</CODE> in their SCAN fields; otherwise the forward link to it will not cause it to process. Also when specifying database links for the fanout record, the user needs only to specify the record name. As no value is being sent or retrieved, the field name is optional.

The SELM, SELN, and SELL fields specify the order of processing for the forward links. The select mechanism field (SELM) has three choices--<CODE>All</CODE>, <CODE>Specified</CODE>, or <CODE>Mask</CODE>. How these affect which links to process and in which order is as follows:

; <B>All</B>
: Links are processed in numerical order--LNK1, LNK2, etc.
; <B>Specified</B>
: SELN is used as the specifier of which link to process. For instance, if SELN=1, then LNK1 will be processed.
; <B>Mask</B>
: The individual bits in SELN are used to select which links to process as follows: 
:* If bit 0 of SELN is set, LNK1 is processed.
:* If bit 1 of SELN is set, LNK2 is processed.
:* If bit 2 of SELN is set, LNK3 is processed, etc.

SELN reads its value from SELL. SELL can be a constant, a database link, or a channel access link.  If a constant, SELN is initialized with the constant value and can be changed via dbPuts. For database/channel access links, SELN is retrieved from SELL each time the record is processed and can also be changed via dbPuts.

The Fanout record also has the standard scanning fields common to all records. These fields are listed in [[RRM 3-13 dbCommon#Scan Fields|Scan Fields]]. In addition, [[RRM 3-13 Concepts#Scanning Specification|Scanning Specification]] explains in more detail how forward links and the scanning algorithms work.


<TABLE BORDER="1">
<TH>Field<TH>Summary<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR>
<TD>LNK1<TD> Forward Links<TD>FWDLINK<TD>Yes<TD>0<TD>No<TD>No<TD>N/A<TD>No<TR>
<TD>LNK2<TD> Forward Links<TD>FWDLINK<TD>Yes<TD>0<TD>No<TD>No<TD>N/A<TD>No<TR>
<TD>LNK3<TD> Forward Links<TD>FWDLINK<TD>Yes<TD>0<TD>No<TD>No<TD>N/A<TD>No<TR>
<TD>LNK4<TD> Forward Links<TD>FWDLINK<TD>Yes<TD>0<TD>No<TD>No<TD>N/A<TD>No<TR>
<TD>LNK5<TD> Forward Links<TD>FWDLINK<TD>Yes<TD>0<TD>No<TD>No<TD>N/A<TD>No<TR>
<TD>LNK6<TD> Forward Links<TD>FWDLINK<TD>Yes<TD>0<TD>No<TD>No<TD>N/A<TD>No<TR>
<TD>SELM<TD>Select Mechanism:<TD>[[RRM 3-13 Menu Choices|RECCHOICE]]<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR>
<TD>SELN<TD>Link Selection Algorithm<TD>USHORT<TD>No<TD>1<TD>Yes<TD>Yes<TD>No<TD>No<TR>
<TD>SELL<TD>Link Selection Location<TD>INLINK<TD>Yes<TD>0<TD>No<TD>No<TD>N/A<TD>No
</TABLE>


=== Operator Display Parameters ===

These parameters are used to present meaningful data to the operator. See [[RRM 3-13 dbCommon#Fields Common to All Record Types|Fields Common to All Record Types]] for more on these fields. 


<TABLE BORDER="1">
<TH>Field<TH>Summary<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR>
<TD>NAME<TD>Record Name<TD>STRING [29]<TD>Yes<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR>
<TD>DESC<TD>Description<TD>STRING [29]<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>No<TD>No
</TABLE>


=== Alarm Parameters ===

The Fanout record has the alarm parameters common to all record types.  [[RRM 3-13 dbCommon#Alarm Fields|Alarm Fields]] lists other fields related to a alarms that are common to all record types.


=== Run-time Parameters ===

The VAL field is used only so that dbNameAddr succeeds when no field name is specified. Otherwise, it has no significance.


<TABLE BORDER="1">
<TH>Field<TH>Summary<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR>
<TD>VAL<TD>Value Field<TD>LONG<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>Yes
</TABLE>


== Record Support ==

=== Record Support Routines ===


==== init_record ====

This routine initializes SELN with the value of SELL, if SELL type is CONSTANT link, or creates a channel access link if SELL type is PV_LINK.

==== process ====

See next section.


=== Record Processing ===

Routine process implements the following algorithm:


# PACT is set to TRUE.
# The link selection SELN is fetched.
# Depending on the selection mechanism, the link selection forward links are processed. and UDF is set to FALSE.
# Check to see if monitors should be invoked:
#* Alarm monitors are invoked if the alarm status or severity has changed.
#* NSEV and NSTA are reset to 0.
# Scan forward link if necessary, set PACT FALSE, and return.


----


EPICS Record Reference Manual - 19 MAY 1998