One configured -gparticlefile source. More...

#include <gparticle_reader.h>

Public Member Functions
	GParticleSourceDefinition ()=default
	Creates an empty source definition.

	GParticleSourceDefinition (std::string f, std::string n)
	Creates a source definition from a format token and filename.

std::string	gparticlePluginName () const
	Returns the dynamic plugin name associated with this format.

Data Fields
std::string	format
	Source format token, for example `lund`.

std::string	filename
	Source filename.

Detailed Description

The format token selects either a built-in reader, such as lund, or a dynamic plugin named by gparticlePluginName(). The filename value is passed unchanged to the reader.

Definition at line 98 of file gparticle_reader.h.

Constructor & Destructor Documentation

◆ GParticleSourceDefinition() [1/2]

GParticleSourceDefinition::GParticleSourceDefinition ( )

default

◆ GParticleSourceDefinition() [2/2]

GParticleSourceDefinition::GParticleSourceDefinition	(	std::string	f,
		std::string	n )

inline

Parameters

f	Source format token.
n	Source filename.

Definition at line 109 of file gparticle_reader.h.

Member Function Documentation

◆ gparticlePluginName()

std::string GParticleSourceDefinition::gparticlePluginName ( ) const

inline

Returns: Plugin name following the gparticle_<format>_plugin convention.

Definition at line 124 of file gparticle_reader.h.

Field Documentation

◆ filename

std::string GParticleSourceDefinition::filename

Definition at line 117 of file gparticle_reader.h.

◆ format

std::string GParticleSourceDefinition::format

Definition at line 114 of file gparticle_reader.h.

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

gparticle_reader.h

Public Member Functions

Data Fields