interfaces C++ API Reference¶
-
class I3CalibrationService¶
- #include <I3CalibrationService.h>
Produces I3Calibration objects given a time. Then it tells the next time the calibration will change.
-
class I3DetectorStatusService¶
- #include <I3DetectorStatusService.h>
Produces I3DetectorStatus and I3DetectorStatus Header objects given a I3Time. Intended to be an icetray service which provides the detector status information.
-
class I3EventService¶
- #include <I3EventService.h>
This is the interface to classes which serve up an event and the time of the next event. This is intended to be an icetray service.
Public Functions
-
virtual bool MoreEvents() = 0¶
indicates whether or not there are more events to find.
-
virtual I3Time PopEvent(I3Frame &frame) = 0¶
This method should fill the frame with all the relevent frame data. Returned is the time of the event.
-
inline virtual void DiffEvent(I3Frame &frame)¶
This method should delete any keys that have not changed since the frame was injected into the module chain, i.e. turn the frame into a diff.
-
inline virtual bool DiffEventImplemented()¶
-
virtual ~I3EventService()¶
-
virtual bool MoreEvents() = 0¶
-
class I3GeometryService¶
- #include <I3GeometryService.h>
This is an interface to classes which generates I3Geometry and I3GeometryHeader objects given an I3Time. This is intended to be an icetray services for getting the geometry information into the system.
-
template<class IcePick>
class I3IceForkModule : public I3Module¶ - #include <I3IceForkModule.h>
This module is just like I3IcePickModule except that it does the event selection and then dumps the rejected frame to it’s TrashBox.
This module is a template, so when you want to add this module you need to specify a subclass of I3IcePick that you want to use as the template parameter.
-
template<class IcePick>
class I3IcePickModule : public I3ConditionalModule¶ - #include <I3IcePickModule.h>
This is module that does the event selection. You put it your module chain and then frames which don’t pass the cut don’t make it past this module.
This module is a template, so when you want to add this module you need to specify a subclass of I3IcePick that you want to use as the template parameter. Don’t forget to generate a dictionary for the new template instantiation.
Private Functions
- SET_LOGGER ("I3IcePickModule")
-
class I3MetaService¶
- #include <I3MetaService.h>
-
class I3OMKey2MBID¶
- #include <I3OMKey2MBID.h>
This is an icetray service which provides conversions between OMKey and DOM mainboard id.
Public Functions
-
I3OMKey2MBID()¶
Default constructor.
-
virtual ~I3OMKey2MBID()¶
Destructor.
-
virtual bool OMKeyExists(long long int mbid) const = 0¶
Checks whether an OMKey exists for the given mbid.
Private Functions
-
I3OMKey2MBID(const I3OMKey2MBID &rhs)¶
-
I3OMKey2MBID &operator=(const I3OMKey2MBID &rhs)¶
- SET_LOGGER ("I3OMKey2MBID")
-
I3OMKey2MBID()¶
-
namespace std
STL namespace.
- file destructors.cxx
- #include <interfaces/I3CalibrationService.h>#include <interfaces/I3DetectorStatusService.h>#include <interfaces/I3MetaService.h>#include <interfaces/I3GeometryService.h>#include <interfaces/I3EventService.h>
- file I3CalibrationService.h
- #include <icetray/I3PointerTypedefs.h>#include <icetray/I3DefaultName.h>
Copyright (C) 2004 the icecube collaboration SPDX-License-Identifier: BSD-2-Clause $Id$
- Version
$Revision$
- Date
$Date$
- Author
pretz
Functions
-
I3_POINTER_TYPEDEFS(I3Calibration)
-
I3_DEFAULT_NAME(I3CalibrationService)¶
-
I3_POINTER_TYPEDEFS(I3CalibrationService)¶
- file I3DetectorStatusService.h
- #include <icetray/I3PointerTypedefs.h>#include <icetray/I3DefaultName.h>
Copyright (C) 2004 the icecube collaboration SPDX-License-Identifier: BSD-2-Clause $Id$
- Version
$Revision$
- Date
$Date$
- Author
pretz
Functions
-
I3_FORWARD_DECLARATION(I3DetectorStatus)¶
-
I3_DEFAULT_NAME(I3DetectorStatusService)¶
-
I3_POINTER_TYPEDEFS(I3DetectorStatusService)¶
- file I3EventService.h
- #include <icetray/I3FrameObject.h>#include <icetray/I3DefaultName.h>
Copyright (C) 2004 the icecube collaboration SPDX-License-Identifier: BSD-2-Clause $Id$
- Version
$Revision$
- Date
$Date$
- file I3GeometryService.h
- #include <icetray/I3FrameObject.h>#include <icetray/I3DefaultName.h>
Copyright (C) 2004 the icecube collaboration SPDX-License-Identifier: BSD-2-Clause $Id$
- Version
$Revision$
- Date
$Date$
Functions
-
I3_FORWARD_DECLARATION(I3Geometry)¶
-
I3_DEFAULT_NAME(I3GeometryService)¶
-
I3_POINTER_TYPEDEFS(I3GeometryService)¶
- file I3IceForkModule.h
- #include <icetray/I3Module.h>#include <icetray/I3Bool.h>#include <icetray/I3Frame.h>
- file I3IcePickModule.h
- #include <dataclasses/physics/I3EventHeader.h>#include <icetray/I3ConditionalModule.h>#include <icetray/I3Bool.h>#include <icetray/I3Frame.h>#include <boost/foreach.hpp>#include <boost/python.hpp>
- file I3MetaService.h
- #include <icetray/I3Frame.h>#include <icetray/I3DefaultName.h>
Copyright (C) 2004 the icecube collaboration SPDX-License-Identifier: BSD-2-Clause $Id$
- Version
$Revision$
- Date
$Date$
- Author
pretz
- file I3OMKey2MBID.cxx
- #include <interfaces/I3OMKey2MBID.h>
- file I3OMKey2MBID.h
- #include <icetray/I3DefaultName.h>#include <icetray/I3Logging.h>#include <icetray/I3PointerTypedefs.h>#include <icetray/OMKey.h>
Copyright (C) 2004 the icecube collaboration SPDX-License-Identifier: BSD-2-Clause $Id$
- Version
$Revision$
- Date
$Date$
Functions
-
I3_POINTER_TYPEDEFS(I3OMKey2MBID)¶
pointer type to insulate users from memory management
-
I3_DEFAULT_NAME(I3OMKey2MBID)¶
define a default name to address service in a context
- dir icetray
- dir interfaces
- dir interfaces
- dir interfaces
- dir private
- dir public