PSShmemInput::ShmemInputModule Class Reference
[PSShmemInput]

Psana input module for shared memory. More...

#include <ShmemInputModule.h>

Inheritance diagram for PSShmemInput::ShmemInputModule:

List of all members.

Public Member Functions
	ShmemInputModule (const std::string &name)
	Constructor takes the name of the module.
virtual	~ShmemInputModule ()

---

Detailed Description

Psana input module for shared memory.

This class implements psana input module which reads XTC data from shared memory. Psana uses this module instead of regular XTC (or HDF5) input module when it encounters shmem keyword in the input dataset:

  % psana -c config.cfg shmem=name.0

Required value for shmem keyword consists of the shared memory tag name and a client index (number) separated by dot, the meaning of these parameters is defined by the DAQ shared memory server and should be known to people who setup the infrastructure.

In addition to shmem keyword dataset specification can optionally contain stop keyword with a value that specifies stop condition. Possible values for this keyword are:

• unmap - psana stops when UnMap transition occurs
• unconfigure - psana stops when UnConfigure transition occurs
• endrun - psana stops when EndRun transition occurs
• endcalibcycle - psana stops when EndCalibCycle transition occurs
• none - psana runs forever until killed
• no - same as none

By default if stop keyword is not specified then it is equivalent to stop=endrun and psana will stop at the end of run.

Example of starting non-stopping job:

  % psana -c config.cfg shmem=name.0:stop=none

Note:

This software was developed for the LCLS project. If you use all or part of it, please give an appropriate acknowledgment.

Version:

Id

ShmemInputModule.h 7698 2014-02-27 00:47:58Z salnikov@SLAC.STANFORD.EDU

Author:

Andy Salnikov

Definition at line 84 of file ShmemInputModule.h.

---

Constructor & Destructor Documentation

PSShmemInput::ShmemInputModule::ShmemInputModule

(

const std::string &

name

)

Constructor takes the name of the module.

Definition at line 44 of file ShmemInputModule.cpp.

PSShmemInput::ShmemInputModule::~ShmemInputModule

(

)

[virtual]

Definition at line 52 of file ShmemInputModule.cpp.

---

The documentation for this class was generated from the following files:

• PSShmemInput/include/ShmemInputModule.h
• PSShmemInput/src/ShmemInputModule.cpp

---