Skip to content

Commit

Permalink
Added doxygen comments for StPicoDstMaker::PicoVtxMode
Browse files Browse the repository at this point in the history
  • Loading branch information
plexoos committed Jul 14, 2017
1 parent 0717a4b commit 33a0735
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion StPicoDstMaker/StPicoDstMaker.h
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,21 @@ class StPicoDstMaker : public StMaker
{
public:
enum PicoIoMode {IoWrite=1, IoRead=2};
enum PicoVtxMode {NotSet=0, Default=1, Vpd=2, VpdOrDefault=3};

/// Various selection criteria for picking a vertex from the list of available
/// vertices in muDst. If requested vertex not found the event is skipped
enum PicoVtxMode
{
/// Default "unspecified" mode to force user pick one of the modes below
NotSet = 0,
/// Select the first vertex in the muDst vertex collection
Default = 1,
/// Select first available vertex within a window around the VPD one
Vpd = 2,
/// If a vertex matching the VPD one is not found pick the first one from
/// the muDst collection
VpdOrDefault = 3
};

StPicoDstMaker(char const* name = "PicoDst");
StPicoDstMaker(PicoIoMode ioMode, char const* fileName = "", char const* name = "PicoDst");
Expand Down

0 comments on commit 33a0735

Please sign in to comment.