gparticle_options.h File Reference

Public API for defining and parsing gparticle-related options. More...

#include "gparticle.h"
#include "goptions.h"

Include dependency graph for gparticle_options.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	gparticle

Functions
GOptions	gparticle::defineOptions ()
	Defines the structured options used by the gparticle module.
vector< GparticlePtr >	gparticle::getGParticles (const std::shared_ptr< GOptions > &gopts, std::shared_ptr< GLogger > &logger)
	Builds the list of generator particles from structured options.

Variables
constexpr const char *	GPARTICLE_LOGGER = "gparticle"

Detailed Description

This header contains the authoritative documentation for the option utilities. The corresponding implementation file only provides a short non-Doxygen summary per function (to avoid duplication between .h and .cc).

Definition in file gparticle_options.h.

Variable Documentation

GPARTICLE_LOGGER

constexpr const char* GPARTICLE_LOGGER = "gparticle"

constexpr

Definition at line 16 of file gparticle_options.h.