JEventSourceGenerator Class Reference

Inheritance diagram for JEventSourceGenerator:

Collaboration diagram for JEventSourceGenerator:

Public Member Functions
	JEventSourceGenerator (JApplication *app=nullptr)
virtual std::string	GetType (void) const
	Return name of the source type this will generate.
virtual std::string	GetDescription (void) const
	Return description of the source type this will generate.
virtual JEventSource *	MakeJEventSource (std::string source)=0
	Create an instance of the source type this generates.
virtual double	CheckOpenable (std::string source)=0
	See JEventSourceGeneratorT for description.

Public Attributes
friend	JComponentManager

Protected Member Functions
void	SetJApplication (JApplication *app)
	This is called by JEventSourceManager::AddJEventSourceGenerator which itself is called by JApplication::Add(JEventSourceGenerator*).
void	SetPluginName (std::string plugin_name)
	SetPluginName is called by JANA itself and should not be exposed to the user.
std::string	GetPluginName () const
	GetPluginName is called by JANA itself and should not be exposed to the user.
JEventLevel	GetLevel ()
void	SetLevel (JEventLevel level)

Protected Attributes
JApplication *	mApplication {nullptr}
std::string	mPluginName
JEventLevel	mLevel = JEventLevel::None

Member Function Documentation

CheckOpenable()

virtual double JEventSourceGenerator::CheckOpenable ( std::string  source )

pure virtual

See JEventSourceGeneratorT for description.

Implemented in JEventSourceGeneratorT< T, Enable >, and JEventSourceGeneratorT< T, std::enable_if_t< std::is_default_constructible_v< T > > >.

GetDescription()

virtual std::string JEventSourceGenerator::GetDescription ( void  ) const

inlinevirtual

Return description of the source type this will generate.

Reimplemented in JEventSourceGeneratorT< T, Enable >, and JEventSourceGeneratorT< T, std::enable_if_t< std::is_default_constructible_v< T > > >.

GetType()

virtual std::string JEventSourceGenerator::GetType ( void  ) const

inlinevirtual

Return name of the source type this will generate.

Reimplemented in JEventSourceGeneratorT< T, Enable >, and JEventSourceGeneratorT< T, std::enable_if_t< std::is_default_constructible_v< T > > >.

MakeJEventSource()

virtual JEventSource * JEventSourceGenerator::MakeJEventSource ( std::string  source )

pure virtual

Create an instance of the source type this generates.

Implemented in JEventSourceGeneratorT< T, Enable >, and JEventSourceGeneratorT< T, std::enable_if_t< std::is_default_constructible_v< T > > >.

SetJApplication()

void JEventSourceGenerator::SetJApplication ( JApplication *  app )

inlineprotected

This is called by JEventSourceManager::AddJEventSourceGenerator which itself is called by JApplication::Add(JEventSourceGenerator*).

There should be no need to call it from anywhere else.

---

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

• JEventSourceGenerator.h