artdaq Namespace Reference

The artdaq namespace. More...

Namespaces

namespace  detail
 

The artdaq::detail namespace contains internal implementation details for some classes.


Classes

class  BoardReaderApp
 BoardReaderApp is an artdaq::Commandable derived class which controls the BoardReaderCore state machine. More...
class  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. More...
class  Commandable
 Commandable is the base class for all artdaq components which implement the artdaq state machine. More...
class  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. More...
class  CompositeDriver
 CompositeDriver handles a set of lower-level generators. More...
class  DataLoggerApp
 DataLoggerApp is an artdaq::Commandable derived class which controls the DataLoggerCore. More...
class  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. More...
class  DataReceiverCore
 DataReceiverCore implements the state machine for the DataReceiver artdaq application. DataReceiverCore receives Fragment objects from the DataReceiverManager, and sends them to the EventStore. More...
class  DispatcherApp
 DispatcherApp is an artdaq::Commandable derived class which controls the DispatcherCore. More...
class  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. More...
class  EventBuilderApp
 EventBuilderApp is an artdaq::Commandable derived class which controls the EventBuilderCore. More...
class  EventBuilderCore
 EventBuilderCore implements the state machine for the EventBuilder artdaq application. EventBuilderCore receives Fragment objects from the DataReceiverManager, and sends them to the EventStore. More...
class  CapacityTestPolicy
 A RoutingMasterPolicy which tries to fully load the first receiver, then the second, and so on. More...
class  NoOpPolicy
 A RoutingMasterPolicy which simply assigns Sequence IDs to tokens in the order they were received. More...
class  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. More...
class  RoutingMasterPolicy
 The interface through which RoutingMasterCore obtains Routing Tables using received Routing Tokens. More...
class  RoutingMasterApp
 RoutingMasterApp is an artdaq::Commandable derived class which controls the RoutingMasterCore state machine. More...
class  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. More...
class  StatisticsHelper
 This class manages MonitoredQuantity instances for the *Core classes. More...
class  BuildInfo
 BuildInfo is an art::EDProducer which saves information about package builds to the data file. More...
class  TransferWrapper
 TransferWrapper wraps a TransferInterface so that it can be used in the ArtdaqInput class to make an art::Source. More...
class  EventDump
 Write Event information to the console. More...
class  MissingDataCheck
 Check art::Event for potentially missing data. More...
class  PrintBuildInfo
 An art::EDAnalyzer which prints any artdaq::BuildInfo objects stored in the run. More...
class  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. More...
struct  GetPackageBuildInfo
 Wrapper around the artdaq::GetPackageBuildInfo::getPackageBuildInfo function. More...
class  GenericFragmentSimulator
 GenericFragmentSimulator creates simulated Generic events, with data distributed according to a "histogram" provided in the configuration data. More...
class  Globals
 The artdaq::Globals class contains several variables which are useful across the entire artdaq system. More...
struct  NetMonHeader
 Header with length information for NetMonTransport messages. More...
class  PortManager
class  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. More...
class  DataSenderManager
 Sends Fragment objects using TransferInterface plugins. Uses Routing Tables if confgiured, otherwise will Round-Robin Fragments to the destinations. More...
class  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. More...
class  FragmentStoreElement
 This class contains tracking information for all Fragment objects which have been received from a specific source. More...
class  RequestReceiver
 Receive data requests and make them available to CommandableFragmentGenerator or other interested parties. Track received requests and report errors when inconsistency is detected. More...
class  RequestSender
 The RequestSender contains methods used to send data requests and Routing tokens. More...
class  art_config_file
 art_config_file wraps a temporary file used to configure art More...
class  SharedMemoryEventManager
 The SharedMemoryEventManager is a SharedMemoryManger which tracks events as they are built. More...
class  TransferTest
 Test a set of TransferInterface plugins. More...
class  CommanderInterface
 This interface defines the functions used to transfer data between artdaq applications. More...
class  cmd_
 The "cmd_" class serves as the base class for all artdaq's XML-RPC commands. More...
class  init_
class  soft_init_
class  reinit_
class  start_
 Command class representing a start transition. More...
class  pause_
class  resume_
class  stop_
class  shutdown_
 shutdown_ Command class More...
class  status_
 status_ Command class More...
class  report_
 report_ Command class More...
class  legal_commands_
 legal_commands_ Command class More...
class  register_monitor_
 register_monitor_ Command class More...
class  unregister_monitor_
 unregister_monitor_ Command class More...
class  trace_set_
 trace_set_ Command class More...
class  trace_get_
 trace_get_ Command class More...
class  meta_command_
 meta_command_ Command class More...
class  rollover_subrun_
 rollover_subrun_ Command class More...
class  add_config_archive_entry_
 add_config_archive_entry_ Command class More...
class  clear_config_archive_
 clear_config_archive_ Command class More...
class  xmlrpc_commander
 The xmlrpc_commander class serves as the XMLRPC server run in each artdaq application. More...
class  RTIDDS
 DDS Transport Implementation. More...
class  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. More...
struct  HostMap
class  MulticastTransfer
 MulticastTransfer is a TransferInterface implementation plugin that transfers data using Multicast. More...
class  NullTransfer
 NullTransfer does not send or receive data, but acts as if it did. More...
class  RTIDDSTransfer
 RTIDDSTransfer is a TransferInterface implementation plugin that transfers data using RTI DDS. More...
class  ShmemTransfer
 A TransferInterface implementation plugin that transfers data using Shared Memory. More...
class  TCPSocketTransfer
 TransferInterface implementation plugin that sends data using TCP sockets. More...
class  TransferInterface
 This interface defines the functions used to transfer data between artdaq applications. More...
class  artdaqapp
 Class representing an artdaq application. Used by all "main" functions to start artdaq. More...
class  FragmentSniffer
 This art::EDAnalyzer plugin tries to get Fragments from each event, asserting that the correct number of Fragments were present. More...

Typedefs

typedef std::unique_ptr
< artdaq::CommandableFragmentGenerator
makeFunc_t (fhicl::ParameterSet const &ps)
 Constructs a CommandableFragmentGenerator instance, and returns a pointer to it.
typedef artdaq::BuildInfo
<&instanceName,
artdaqcore::GetPackageBuildInfo,
artdaq::GetPackageBuildInfo
ArtdaqBuildInfo
 Specialized artdaq::BuildInfo object for the Artdaq build info.
typedef art::Source
< detail::SharedMemoryReader
< artdaq::Fragment::MakeSystemTypeMap > > 
RawInput
 RawInput is a typedef of art::Source<detail::SharedMemoryReader>.
typedef std::map< int,
std::string > 
hostMap_t
 The host_map is a map associating ranks with artdaq::DestinationInfo objects.

Enumerations

enum  RequestMode { Single, Buffer, Window, Ignored }
 

The RequestMode enumeration contains the possible ways which CommandableFragmentGenerator responds to data requests.


Functions

std::unique_ptr
< CommandableFragmentGenerator
makeCommandableFragmentGenerator (std::string const &generator_plugin_spec, fhicl::ParameterSet const &ps)
 Load a CommandableFragmentGenerator plugin.
std::unique_ptr
< RoutingMasterPolicy
makeRoutingMasterPolicy (std::string const &policy_plugin_spec, fhicl::ParameterSet const &ps)
 Load a RoutingMasterPolicy plugin.
std::string infoFilename (std::string const &prefix, int rank, int run)
 Generate a filename using the given parameters.
std::unique_ptr
< artdaq::CommanderInterface
MakeCommanderPlugin (const fhicl::ParameterSet &pset, artdaq::Commandable &commandable)
 Load a CommanderInterface plugin.
std::string exception_msg (const std::runtime_error &er, const std::string &helpText="execute request")
 Write an exception message.
std::string exception_msg (const art::Exception &er, const std::string &helpText)
 Write an exception message.
std::string exception_msg (const cet::exception &er, const std::string &helpText)
 Write an exception message.
std::string exception_msg (const std::string &erText, const std::string &helpText)
 Write an exception message.
template<>
std::string cmd_::getParam< std::string > (const xmlrpc_c::paramList &paramList, int index)
 Get a parameter from the parameter list.
template<>
art::RunID cmd_::getParam< art::RunID > (const xmlrpc_c::paramList &paramList, int index)
 Get a parameter from the parameter list.
template<>
fhicl::ParameterSet cmd_::getParam< fhicl::ParameterSet > (const xmlrpc_c::paramList &paramList, int index)
 Get a parameter from the parameter list.
std::vector< fhicl::ParameterSet > MakeHostMapPset (std::map< int, std::string > input)
 Create a list of HostMap::HostConfig ParameterSets from a hostMap_t map.
hostMap_t MakeHostMap (fhicl::ParameterSet pset, hostMap_t map=hostMap_t())
 Make a hostMap_t from a HostMap::Config ParameterSet.
std::unique_ptr
< artdaq::TransferInterface
MakeTransferPlugin (const fhicl::ParameterSet &pset, std::string plugin_label, TransferInterface::Role role)
 Load a TransferInterface plugin.

Variables

static std::string instanceName = "ArtdaqBuildInfo"
 Name of this BuildInfo instance.

Detailed Description

The artdaq namespace.

Namespace used to differentiate the artdaq version of GetPackageBuildInfo from other versions present in the system.


Typedef Documentation

typedef std::unique_ptr< artdaq::RoutingMasterPolicy > artdaq::makeFunc_t(fhicl::ParameterSet const &ps)

Constructs a CommandableFragmentGenerator instance, and returns a pointer to it.

Constructs a RoutingMasterPolicy instance, and returns a pointer to it.

Parameters:
ps Parameter set for initializing the CommandableFragmentGenerator
Returns:
A smart pointer to the CommandableFragmentGenerator
Parameters:
ps Parameter set for initializing the RoutingMasterPolicy
Returns:
A smart pointer to the RoutingMasterPolicy

Definition at line 17 of file GeneratorMacros.hh.


Function Documentation

template<>
art::RunID artdaq::cmd_::getParam< art::RunID > ( const xmlrpc_c::paramList &  paramList,
int  index 
) [inline]

Get a parameter from the parameter list.

Parameters:
paramList The parameter list
index Index of the parameter in the parameter list
Returns:
The requested parameter

This specialized cmd_getParam for the art::RunID type

template<>
fhicl::ParameterSet artdaq::cmd_::getParam< fhicl::ParameterSet > ( const xmlrpc_c::paramList &  paramList,
int  index 
) [inline]

Get a parameter from the parameter list.

Parameters:
paramList The parameter list
index Index of the parameter in the parameter list
Returns:
The requested parameter

This specialized cmd_getParam for the fhicl::ParameterSet type

template<>
std::string artdaq::cmd_::getParam< std::string > ( const xmlrpc_c::paramList &  paramList,
int  index 
) [inline]

Get a parameter from the parameter list.

Parameters:
paramList The parameter list
index Index of the parameter in the parameter list
Returns:
The requested parameter

This specialized cmd_getParam for the std::string type

std::string artdaq::exception_msg ( const std::string &  erText,
const std::string &  helpText 
)

Write an exception message.

Parameters:
erText A std::string to print
helpText Additional information abou the exception context
Returns:
Exception message

Definition at line 177 of file xmlrpc_commander.cc.

std::string artdaq::exception_msg ( const cet::exception &  er,
const std::string &  helpText 
)

Write an exception message.

Parameters:
er A cet::exceptio to print
helpText Additional information abou the exception context
Returns:
Exception message

Definition at line 160 of file xmlrpc_commander.cc.

std::string artdaq::exception_msg ( const art::Exception &  er,
const std::string &  helpText 
)

Write an exception message.

Parameters:
er An art::Exception to print
helpText Additional information abou the exception context
Returns:
Exception message

Definition at line 143 of file xmlrpc_commander.cc.

std::string artdaq::exception_msg ( const std::runtime_error &  er,
const std::string &  helpText = "execute request" 
)

Write an exception message.

Parameters:
er A std::runtime_error to print
helpText Additional information about the exception context. Default: "execute request"
Returns:
Exception message

Definition at line 126 of file xmlrpc_commander.cc.

std::string artdaq::infoFilename ( std::string const &  prefix,
int  rank,
int  run 
)

Generate a filename using the given parameters.

Parameters:
prefix Prefix for the file name
rank Rank of the application
run Run number
Returns:
prefix + run (4 digits) + "_" + rank (4 digits) + ".txt";

Definition at line 7 of file infoFilename.cc.

std::unique_ptr< artdaq::CommandableFragmentGenerator > artdaq::makeCommandableFragmentGenerator ( std::string const &  generator_plugin_spec,
fhicl::ParameterSet const &  ps 
)

Load a CommandableFragmentGenerator plugin.

Parameters:
generator_plugin_spec Name of the plugin
ps ParameterSet used to configure the plugin
Returns:
Pointer to the new plugin instance

Definition at line 8 of file makeCommandableFragmentGenerator.cc.

std::unique_ptr< CommanderInterface > artdaq::MakeCommanderPlugin ( const fhicl::ParameterSet &  pset,
artdaq::Commandable commandable 
)

Load a CommanderInterface plugin.

Parameters:
pset ParameterSet used to configure the CommanderInterface
commandable artdaq::Commandable object to send transition commands to
Returns:
Pointer to the new CommanderInterface instance
hostMap_t artdaq::MakeHostMap ( fhicl::ParameterSet  pset,
hostMap_t  map = hostMap_t() 
) [inline]

Make a hostMap_t from a HostMap::Config ParameterSet.

Parameters:
pset fhicl::ParameterSet containing a HostMap::Config
masterPortOffset Port offset to apply to all entries (Default 0)
map Input map for consistency checking (Default: hostMap_t())
Returns:
hostMap_t object

Definition at line 66 of file HostMap.hh.

std::vector<fhicl::ParameterSet> artdaq::MakeHostMapPset ( std::map< int, std::string >  input  )  [inline]

Create a list of HostMap::HostConfig ParameterSets from a hostMap_t map.

Parameters:
input Input hostMap_t
Returns:
std::vector containing HostMap::HostConfig ParameterSets

Definition at line 46 of file HostMap.hh.

std::unique_ptr< artdaq::RoutingMasterPolicy > artdaq::makeRoutingMasterPolicy ( std::string const &  policy_plugin_spec,
fhicl::ParameterSet const &  ps 
)

Load a RoutingMasterPolicy plugin.

Parameters:
policy_plugin_spec Name of the RoutingMasterPolicy
ps ParameterSet used to configure the RoutingMasterPolicy
Returns:
std::unique_ptr<RoutingMasterPolicy> to the new RoutingMasterPolicy instance

Definition at line 8 of file makeRoutingMasterPolicy.cc.

std::unique_ptr< TransferInterface > artdaq::MakeTransferPlugin ( const fhicl::ParameterSet &  pset,
std::string  plugin_label,
TransferInterface::Role  role 
)

Load a TransferInterface plugin.

Parameters:
pset ParameterSet used to configure the TransferInterface
plugin_label Name of the plugin
role Whether the TransferInterface should be configured as kSend or kReceive
Returns:
Pointer to the new TransferInterface instance

Generated on 25 Sep 2018 for artdaq by  doxygen 1.6.1