Command Usage: sam v8_1_5
sam declare events

Just having some fun...
Command Description:

Declare the events within a raw data file.

The command line interface only allows the declaration of ONE
event at a time, and is not particularly useful.

The python API may be called to declare the entire event list:
   from SamStruct.RawEventInfoList import RawEventInfoList

   myEventList = RawEventInfoList()
   for ev in <your event list>:
     myEventList.append(ev.ev_num, ev.lum_block,
                        hex(ev.level1), hex(ev.level2), hex(ev.level3))

   from Sam import sam
   sam.declareEvents(runType='physics data taking',
                     runNumber=12345,
                     fileName='raw_file_name_here',
                     eventList=myEventList)


Usage:
       sam declare events [--options] [-flags]

Where:


  --options:
	    --corbaCallTimeout=<value> # time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
	         --eventNumber=<value> # the event number to be declared
	              --fileId=<value> # fileId of the file containing the events
	            --fileName=<value> # file name containing the events
	              --level1=<value> # level1 value
	              --level2=<value> # level2 value
	              --level3=<value> # level3 value
	            --lumBlock=<value> # the lumblock associated with this event number
	       --retryInterval=<value> # retry interval base in seconds; will multiply this base times retryCount (default: 5)
	         --retryJitter=<value> # retry jitter, random jitter added to base retry interval times retryCount (default: 5)
	       --retryMaxCount=<value> # number of times to retry CORBA calls for retriable exceptions (default: 25; zero implies no retries)
	               --runId=<value> # the DB-assigned ID number of the run containing this runNumber/runType
	           --runNumber=<value> # the run number associated with this run
	             --runType=<value> # the run type associated with this run

   -flags:
	                            -c # automatically close all servants after each method call
	                            -d # debug mode
	                            -s # retrySilently mode (do not issue messages to stderr on proxy retries)
	                            -t # time-it mode (print additional info on timings)
	                            -v # verbose mode

Must specify at least one of:
	--fileName=<value> OR --fileId=<value> 
	--runNumber=<value> OR --runId=<value> 

Incompatible Option Combinations:
	[runType, runNumber] OR [runId] 

Required Data Types:
	              corbaCallTimeout : int 
	                   eventNumber : long 
	                        fileId : long 
	                      fileName : string 
	                        level1 : string 
	                        level2 : string 
	                        level3 : string 
	                      lumBlock : long 
	                 retryInterval : int 
	                   retryJitter : int 
	                 retryMaxCount : int 
	                         runId : long 
	                     runNumber : long 
	                       runType : string 

You may omit "-c" if the $SAM_PYAPI_AUTO_CLOSE_SERVANTS environmental variable is set.
You may omit "--corbaCallTimeout=<value>" if the $SAM_PYAPI_CORBA_CALL_TIMEOUT environmental variable is set.
You may omit "--retryInterval=<value>" if the $SAM_PYAPI_RETRY_INTERVAL environmental variable is set.
You may omit "--retryJitter=<value>" if the $SAM_PYAPI_RETRY_JITTER environmental variable is set.
You may omit "--retryMaxCount=<value>" if the $SAM_PYAPI_RETRY_MAX_COUNT environmental variable is set.
You may omit "-s" if the $SAM_PYAPI_RETRY_SILENTLY environmental variable is set.

UNIX ExitStatus:
	             Success :   0
	Unhandled exceptions : 127


See Also: