#include <ProbePhotonPacketInterface.hpp>

Inheritance diagram for ProbePhotonPacketInterface:

Public Member Functions
virtual	~ProbePhotonPacketInterface ()

virtual void	probePhotonPacket (const PhotonPacket *pp)=0

Protected Member Functions
	ProbePhotonPacketInterface ()

Detailed Description

ProbePhotonPacketInterface is a pure interface with a single function. Some Probe subclasses implement this interface and install it as a call-back with their target object in the simulation hierarchy, so that the probePhotonPacket() function gets invoked at predefined times in each photon packet's life cycle.

Constructor & Destructor Documentation

◆ ProbePhotonPacketInterface()

ProbePhotonPacketInterface::ProbePhotonPacketInterface ( )

inlineprotected

The empty constructor for the interface.

◆ ~ProbePhotonPacketInterface()

virtual ProbePhotonPacketInterface::~ProbePhotonPacketInterface ( )

inlinevirtual

The empty destructor for the interface.

Member Function Documentation

◆ probePhotonPacket()

virtual void ProbePhotonPacketInterface::probePhotonPacket ( const PhotonPacket * pp )

pure virtual

This function probes the given photon packet. After a Probe subclass installs this interface as a call-back with its target object, this function gets invoked at predefined times in each photon packet's life cycle. Because photon packets may be processed in parallel execution threads, this function must be thread-safe.

Implemented in LaunchedPacketsProbe.

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

ProbePhotonPacketInterface.hpp