insertstatechange

Name

insertstatechange -- Insert run state change items in NSCLDAQ ringbuffers

Synopsis

insertstatechange [option...]

DESCRIPTION

Inserts a state change item into a ring buffers. By state change we mean either a BEGIN_RUN or an END_RUN item.

There must not be a producer to the ring when invoked

COMMAND OPTIONS

-h, --help

Print help text and exit

-V, --version

Prints the program version and then exits.

-r, --ring=STRING

This option is required. Its parameter is the ringbuffers into which the state transition record is inserted.

-R, --run=INT

This option is required. Its parameter is a non-negative integer whose value will be set as the run number for the state change item inserted in the ring buffer.

-t, --title=STRING

This option is required. Its parameter is used for the title in the run state item inserted into the ring buffer. Note that as with any shell command, quotes may be needed to allow embeded whitespace. Embedded quotations also require special handling.

-s, --source-id=INT

This option is required. Its value is the source id to put in the ring item's body header.

-T, --type=STRING

This option is required. Its value indicates the type of state change item generated. The option value can be either begin which generates a BEGIN_RUN ring item or end which generates an END_RUN item.

-o, --offset=INT

This option is optional. It is only allowed if --type=end. If provided it specifies the number of seconds into the run the end run occured. If the option is not provided, the end run time offset generated will be 0xffffffff. Begin run items are always generated with an offset of 0 by definition.