Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
  anonymous_namespace{genToArt.cc} | |
   ThrottledGenerator | ThrottledGenerator: ensure that we only get one fragment per type at a time from the generator |
 anonymous_namespace{shared_memory_reader_t.cc} | |
| anonymous_namespace{TransferWrapper.cc} | |
| anonymous_namespace{xmlrpc_commander.cc} | |
| env_wrap | Wrapper for XMLRPC environment construction/destruction |
| art | Namespace used for classes that interact directly with art |
| ArtdaqInput | This template class provides a unified interface for reading data into art |
| ArtdaqOutput | This is the base class for artdaq OutputModules, providing the serialization interface for art Events. |
| BinaryFileOutput | The BinaryFileOutput module streams art Events to a binary file, bypassing ROOT |
| BinaryNetOutput | An art::OutputModule which sends Fragments using DataSenderManager. This module produces output identical to that of a BoardReader, for use in systems which have multiple layers of EventBuilders |
| Source_generator< ArtdaqInput< NetMonWrapper > > | Trait definition (must precede source typedef) |
| NetMonWrapper | This class wraps NetMonTransportService so that it can act as an ArtdaqInput template class |
| Source_generator< artdaq::detail::SharedMemoryReader< artdaq::Fragment::MakeSystemTypeMap > > | Specialize an art source trait to tell art that we don't care about source.fileNames and don't want the files services to be used |
| RootNetOutput | An art::OutputModule which sends events using DataSenderManager. This module is designed for transporting Fragment-wrapped art::Events after they have been read into art, for example between the EventBuilder and the Aggregator |
| Source_generator< ArtdaqInput< artdaq::TransferWrapper > > | Trait definition (must precede source typedef) |
| TransferOutput | An art::OutputModule which sends events using DataSenderManager. This module is designed for transporting Fragment-wrapped art::Events after they have been read into art, for example between the EventBuilder and the Aggregator |
| ServicesSchedulerConfig | Configuration of the services.scheduler block for artdaq art processes |
| ServicesConfig | Configuration of the services block for artdaq art processes |
| AnalyzersConfig | |
| ProducersConfig | Artdaq does not provide any producers |
| FiltersConfig | |
| PhysicsConfig | Configuration of the physics block for artdaq art processes |
| RootOutputConfig | Confgiguration for ROOT output modules |
| KeysToIgnore | These keys should be ignored by the configuration validation processor |
| OutputsConfig | Configuration for the outputs block of artdaq art processes |
| SourceConfig | Configuration for the source block of artdaq art processes |
| Config | Required configuration for art processes started by artdaq, with artdaq-specific defaults where applicable |
| artdaq | The artdaq namespace |
| detail | The artdaq::detail namespace contains internal implementation details for some classes |
| DefaultFragmentTypeTranslator | Default behavior for experiment-specific customizations in SharedMemoryReader |
| SharedMemoryReader | The SharedMemoryReader is a class which implements the methods needed by art::Source |
| FragCounter | Keep track of the count of Fragments received from a set of sources |
| RequestPacket | The RequestPacket contains information about a single data request |
| RequestHeader | Header of a RequestMessage. Contains magic bytes for validation and a count of expected RequestPackets |
| RequestMessage | A RequestMessage consists of a RequestHeader and zero or more RequestPackets. They will usually be sent in two calls to send() |
| RoutingPacketEntry | A row of the Routing Table |
| RoutingPacketHeader | The header of the Routing Table, containing the magic bytes and the number of entries |
| RoutingAckPacket | A RoutingAckPacket contains the rank of the table receiver, plus the first and last sequence IDs in the Routing Table (for verification) |
| RoutingToken | The RoutingToken contains the magic bytes, the rank of the token sender, and the number of slots free. This is a TCP message, so additional verification is not necessary |
| BoardReaderApp | BoardReaderApp is an artdaq::Commandable derived class which controls the BoardReaderCore state machine |
| BoardReaderCore | BoardReaderCore implements the state machine for the BoardReader artdaq application. It contains a CommandableFragmentGenerator, which generates Fragments which are then sent to a DataSenderManager by BoardReaderCore |
| Commandable | Commandable is the base class for all artdaq components which implement the artdaq state machine |
| DataLoggerApp | DataLoggerApp is an artdaq::Commandable derived class which controls the DataLoggerCore |
| DataLoggerCore | DataLoggerCore implements the state machine for the DataLogger artdaq application. DataLoggerCore processes incoming events in one of three roles: Data Logger, Online Monitor, or Dispatcher |
| DataReceiverCore | DataReceiverCore implements the state machine for the DataReceiver artdaq application. DataReceiverCore receives Fragment objects from the DataReceiverManager, and sends them to the EventStore |
| DispatcherApp | DispatcherApp is an artdaq::Commandable derived class which controls the DispatcherCore |
| DispatcherCore | DispatcherCore implements the state machine for the Dispatcher artdaq application. DispatcherCore processes incoming events in one of three roles: Data Logger, Online Monitor, or Dispatcher |
| EventBuilderApp | EventBuilderApp is an artdaq::Commandable derived class which controls the EventBuilderCore |
| EventBuilderCore | EventBuilderCore implements the state machine for the EventBuilder artdaq application. EventBuilderCore receives Fragment objects from the DataReceiverManager, and sends them to the EventStore |
| RoutingMasterApp | RoutingMasterApp is an artdaq::Commandable derived class which controls the RoutingMasterCore state machine |
| RoutingMasterCore | RoutingMasterCore implements the state machine for the RoutingMaster artdaq application. RoutingMasterCore collects tokens from receivers, and at regular intervals uses these tokens to build Routing Tables that are sent to the senders |
| BuildInfo | BuildInfo is an art::EDProducer which saves information about package builds to the data file |
| TransferWrapper | TransferWrapper wraps a TransferInterface so that it can be used in the ArtdaqInput class to make an art::Source |
| EventDump | Write Event information to the console |
| FragmentWatcher | |
| MissingDataCheck | Check art::Event for potentially missing data |
| PrintBuildInfo | An art::EDAnalyzer which prints any artdaq::BuildInfo objects stored in the run |
| RandomDelayFilter | A filter which delays for a random amount of time, then drops a random fraction of events. Used to simulate the delays and efficiency of real filters |
| GetPackageBuildInfo | Wrapper around the artdaq::GetPackageBuildInfo::getPackageBuildInfo function |
| GenericFragmentSimulator | GenericFragmentSimulator creates simulated Generic events, with data distributed according to a "histogram" provided in the configuration data |
| Config | Configuration of the GenericFragmentSimulator. May be used for parameter validation |
| Globals | The artdaq::Globals class contains several variables which are useful across the entire artdaq system |
| NetMonHeader | Header with length information for NetMonTransport messages |
| PortManager | PortManager attempts to automatically detect interfaces and ports used for the various TCP and UDP sockets used by artdaq |
| Config | Configuration of PortManager. May be used for parameter validation |
| DataReceiverManager | Receives Fragment objects from one or more DataSenderManager instances using TransferInterface plugins DataReceiverMaanger runs a reception thread for each source, and can automatically suppress reception from sources which are going faster than the others |
| DataSenderManager | Sends Fragment objects using TransferInterface plugins. Uses Routing Tables if confgiured, otherwise will Round-Robin Fragments to the destinations |
| Config | Configuration of DataSenderManager. May be used for parameter validation |
| DestinationsConfig | Configuration for transfers to destinations |
| RoutingTableConfig | Configuration for Routing table reception |
| FragmentReceiverManager | Receives Fragment objects from one or more DataSenderManager instances using TransferInterface plugins DataReceiverMaanger runs a reception thread for each source, and can automatically suppress reception from sources which are going faster than the others |
| FragmentStoreElement | This class contains tracking information for all Fragment objects which have been received from a specific source |
| RequestReceiver | Receive data requests and make them available to CommandableFragmentGenerator or other interested parties. Track received requests and report errors when inconsistency is detected. |
| Config | Configuration of the RequestReceiver. May be used for parameter validation |
| RequestSender | The RequestSender contains methods used to send data requests and Routing tokens |
| Config | Configuration of the RequestSender. May be used for parameter validation |
| RoutingTokenConfig | Configuration for Routing token sending |
| art_config_file | Art_config_file wraps a temporary file used to configure art |
| SharedMemoryEventManager | The SharedMemoryEventManager is a SharedMemoryManger which tracks events as they are built |
| Config | Configuration of the SharedMemoryEventManager. May be used for parameter validation |
| StatisticsHelper | This class manages MonitoredQuantity instances for the *Core classes |
| TokenReceiver | Receives event builder "free buffer" tokens and adds them to a specified RoutingPolicy |
| Config | Configuration of the TokenReceiver. May be used for parameter validation |
| TransferTest | Test a set of TransferInterface plugins |
| CommanderInterface | This interface defines the functions used to transfer data between artdaq applications |
| Config | Configuration of the CommanderInterface. May be used for parameter validation |
| cmd_ | The "cmd_" class serves as the base class for all artdaq's XML-RPC commands |
| init_ | |
| soft_init_ | |
| reinit_ | |
| start_ | Command class representing a start transition |
| pause_ | |
| resume_ | |
| stop_ | |
| shutdown_ | Shutdown_ Command class |
| status_ | Status_ Command class |
| report_ | Report_ Command class |
| legal_commands_ | Legal_commands_ Command class |
| register_monitor_ | Register_monitor_ Command class |
| unregister_monitor_ | Unregister_monitor_ Command class |
| trace_set_ | Trace_set_ Command class |
| trace_get_ | Trace_get_ Command class |
| meta_command_ | Meta_command_ Command class |
| rollover_subrun_ | Rollover_subrun_ Command class |
| add_config_archive_entry_ | Add_config_archive_entry_ Command class |
| clear_config_archive_ | Clear_config_archive_ Command class |
| xmlrpc_commander | Serves as the XMLRPC server run in each artdaq application |
| CommandableFragmentGenerator | CommandableFragmentGenerator is a FragmentGenerator-derived abstract class that defines the interface for a FragmentGenerator designed as a state machine with start, stop, etc., transition commands |
| Config | Configuration of the CommandableFragmentGenerator. May be used for parameter validation |
| CompositeDriver | CompositeDriver handles a set of lower-level generators |
| CapacityTestPolicy | A RoutingMasterPolicy which tries to fully load the first receiver, then the second, and so on |
| NoOpPolicy | A RoutingMasterPolicy which simply assigns Sequence IDs to tokens in the order they were received |
| RoundRobinPolicy | A RoutingMasterPolicy which evenly distributes Sequence IDs to all receivers. If an uneven number of tokens have been received, extra tokens are stored for the next table update |
| RoutingMasterPolicy | The interface through which RoutingMasterCore obtains Routing Tables using received Routing Tokens |
| RTIDDS | DDS Transport Implementation |
| OctetsListener | A class that reads data from DDS |
| AutodetectTransfer | The AutodetectTransfer TransferInterface plugin sets up a Shmem_transfer plugin or TCPSocket_transfer plugin depending if the source and destination are on the same host, to maximize throughput |
| HostMap | |
| Config | Template for the host_map configuration parameter. |
| HostConfig | Entries in the host_map should have these parameters. May be used for parameter validation |
| MulticastTransfer | MulticastTransfer is a TransferInterface implementation plugin that transfers data using Multicast |
| NullTransfer | NullTransfer does not send or receive data, but acts as if it did |
| RTIDDSTransfer | RTIDDSTransfer is a TransferInterface implementation plugin that transfers data using RTI DDS |
| ShmemTransfer | A TransferInterface implementation plugin that transfers data using Shared Memory |
| TCPSocketTransfer | TransferInterface implementation plugin that sends data using TCP sockets |
| TransferInterface | This interface defines the functions used to transfer data between artdaq applications |
| Config | Configuration of the TransferInterface. May be used for parameter validation |
| artdaqapp | Class representing an artdaq application. Used by all "main" functions to start artdaq. |
| Config | Configuration of artdaqapp. May be used for parameter validation |
| RoutingReceiver | Class which receives routing tables and prints updates |
| Config | Accepted configuration parameters for RoutingReceiver |
| FragmentSniffer | This art::EDAnalyzer plugin tries to get Fragments from each event, asserting that the correct number of Fragments were present |
| artdaqtest | |
| CommandableFragmentGeneratorTest | CommandableFragmentGenerator derived class for testing |
| MessHead | This header is sent by the TCPSocket_transfer to allow for more efficient writev calls |
| MPRGlobalTestFixture | MasterProductRegistry Test Fixture |
| NetMonTransportService | NetMonTransportService extends NetMonTransportServiceInterface. It sends events using DataSenderManager and receives events from the GlobalQueue |
| Config | Allowed Configuration parameters of NetMonTransportService. May be used for configuration validation |
| NetMonTransportServiceInterface | Interface for NetMonTranportService. This interface is declared to art as part of the required registration of an art Service |
| ShmRTestFixture | SharedMemoryReader Test Fixture |
 Timeout | Performs registered actions at specified intervals |
 timeoutspec | Specification for a Timeout function |
