YBOS has a lot of functions, but only a handful suffice for nearly all the normal user's work. I assume that you are working within Analysis_Control, which handles the initialization of YBOS, and loads the events into memory for you.
All YBOS functions are integer functions. Declare them as such or suffer the consequences (crashes). Use the YBOS$LIBRARY:ERRCOD.INC include file to define the error return codes for you. Use the C$INC:BCS.INC include file to define the main YBOS common block in your routine.
YBOS stores data in two kinds of banks--named banks and work banks. The named bank has some header information which is used in transporting the data from one architecture to another. You need to use pointers to the bank header when you are manipulating banks; but for access to the data in the bank you want a pointer to the data.
BLOCAT BNEXT BDATA BCOPY BRENAM BDROP MDROP WBANK WDROP BDLEN BLIST BMAKE BTYMAK
istatus = BLOCAT(iw, bank_name, bank_number, bank_index, index_to_data)Where iw is the main YBOS array, as defined in BCS.INC; bank_name is the 4-character name (upper case, please!) of the bank you want to find; bank_number is the number of the bank (-1 finds the first instance); bank_index is a pointer to the bank header; and index_to_data is a pointer to the start of the data within the bank. Istatus is obviously just a variable to hold the return status, and must be an integer. Compare this with possible return values in ERRCOD.INC to find out what happened. Success is denoted by yesucc. For example,
istatus = blocat(iw,'FMUO',1,ibank,idata) IF(istatus .NE. yesucc) RETURN ! no muons Pt = rw(idata+ptfmo)
istatus = bnext(iw, bank_index, next_bank_index)where bank_index is the pointer to the bank header of the current instance of the named bank, and next_bank_index is a pointer to the bank header of the next instance of the named bank. In order to get the pointer to the data, you need to use BDATA.
istatus = bdata(iw, bank_index, index_to_data)where bank_index is the pointer to the bank header (input argument) and index_to_data is the pointer to the start of data in the named bank (output argument). This is generally used in conjunction with BNEXT or utilities like WBLIST (in C$GMU).
istatus = bcopy(iw,orig_name,orig_#,dest_name,dest_#,bank_index,index_to_data)Where orig_name is the 4-character name of the original bank, and orig_# is the number of that bank; and dest_name is the 4-character name of the destination bank and dest_# is the number of the destination bank. bank_index and index_to_data refer to the destination bank. For example, if the following succeeds it creates a new bank called MUON, number 2.
istatus = bcopy(iw,'FMUS',2,'MUON',2,ibank,idata) IF(istatus .NE. yesucc) GO TO 1000 ! something's wrong
istatus = brenam(iw,orig_name,orig_#,dest_name,dest_#)Where orig_name is the 4-character name of the original bank, and orig_# is the number of that bank; and dest_name is the 4-character name of the destination bank and dest_# is the number of the destination bank.
istatus = bdrop(iw, bank_names)where bank_names is a 4N-character string describing the banks to be deleted. For example, if the name is 'CTCDFMUD' then all instances of the CTCD and FMUD banks are deleted. The '*' character serves as a wild card to replace a single character.
istatus = mdrop(iw, bank_name, bank_number)where bank_name is the 4-character bank name and bank_number is the specific number of the bank to be deleted. Remember that YBOS is case sensitive.
istatus = wbank(iw, index, length)where index is the new work bank pointer and length is the name desired for it. Set `index' to be zero before calling this routine, unless you are extending an existing work bank. From here on, the variable `index' will be automatically changed to reflect the position of the work bank whenever garbage collection is done in YBOS. IW(index) is NOT the first data word, iw(index+1) is.
istatus = wdrop(iw, index, 1)where index is the pointer to the work bank. Never mind why the last argument is 1. Please delete work banks when you are done with them.
istatus = bdlen(iw, bank_index, length)where bank_index is the pointer to the bank header and length is the total length of the data region in the bank.
istatus = blist(iw, 'A+', names)where names is a 4N-character list of YBOS bank names. The above adds the specified banks to the `A' list, which is the main Analysis_Control list of banks which are written out by A_C. The syntax `A-' deletes the banks from the list, and `A=' resets the list. There can be 26 such lists.
istatus = bmake(iw, name, number, #_data, type, bank_index, data_index)where name is the 4-character name of the bank; number is the number of the instance of this bank name; and #_data is the number of DATA words desired, not the total number of words in the bank (let YBOS worry about that). type is the bank data type, from BNKTYP.INC; and bank_index and data_index are pointers to the bank and data within the bank respectively. An example is
istatus=bmake(iw,'FMUE',1,128,bnkti4,ibank,idata) IF(istatus.NE.yesucc) GO TO 999 ! complain and exit
istatus=btymak(iw,name,number,string,#_data,bank_index,data_index)where name is the 4-character name of the bank; number is the number of the instance of this bank name; and #_data is the number of DATA words used--returned by btymak; and bank_index and data_index are pointers to the bank and data within the bank respectively. string is a character string of the general form 'nTYmTY' where TY is some type. For example, a bank consisting of 21 Integer*4 words and 5 Real*4 words and an ASCII string of 35 characters would have a string definition of '21I4,5R4,35AS', or '21I45R435AS', which is 21 of I4, 5 of R4, and 35 of AS. If the bank consists of 26 Integer*4 words, 12 Real*4 words, and 7 blocks (groups) of 5 Real*4 and 2 Integer*4 words, the string would look like '26I4,12R4,7(5R4,2I4)'. An example is
istatus=btymak(iw,'$FMO',1,'4I4,2R42I4',ndw,ind,inddat)
IF(istatus.NE.yesucc)THEN
CALL erlogr('FMOCR',erwarn,0,0,
> 'Failure to make the $FMO bank for forward muon code')
RETURN
END IF