Pulsar::Application::Options Class Referenceabstract

Describes application command line options. More...

#include <Application.h>

Inheritance diagram for Pulsar::Application::Options:
Pulsar::Processor Reference::Able Reference::HeapTracked Pulsar::CommonOptions Pulsar::PlotOptions Pulsar::StandardOptions Pulsar::UnloadOptions

Public Member Functions

virtual void add_options (CommandLine::Menu &)=0
 Additional getopt options.
 
virtual void setup ()
 Additional one-time setup tasks. More...
 
virtual void process (Archive *)
 Additional per-Archive processing tasks. More...
 
virtual void finish (Archive *)
 Additional per-Archive finishing tasks (e.g., unload) More...
 
virtual void finalize ()
 Additional one-time final tasks. More...
 
- Public Member Functions inherited from Pulsar::Processor
virtual Archiveresult ()
 If process if out of place, return pointer to new result. More...
 
- Public Member Functions inherited from Reference::Able
 Able (const Able &)
 
Ableoperator= (const Able &)
 
unsigned get_reference_count () const
 
- Public Member Functions inherited from Reference::HeapTracked
 HeapTracked (const HeapTracked &)
 
HeapTrackedoperator= (const HeapTracked &)
 
bool __is_on_heap () const
 

Protected Attributes

Reference::To< Application, false > application
 The application to which these options belong.
 

Friends

class Application
 

Additional Inherited Members

- Static Public Member Functions inherited from Reference::Able
static size_t get_instance_count ()
 
- Static Public Member Functions inherited from Reference::HeapTracked
static void * operator new (size_t size, void *ptr=0)
 
static void operator delete (void *location, void *ptr)
 
static void operator delete (void *location)
 
static size_t get_heap_queue_size ()
 
- Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
 
void __dereference (bool auto_delete=true) const
 

Detailed Description

Describes application command line options.

Member Function Documentation

◆ finalize()

void Pulsar::Application::Options::finalize ( )
virtual

Additional one-time final tasks.

Optional final steps, run once at end (after main finalize)

Reimplemented in Pulsar::PlotOptions.

◆ finish()

void Pulsar::Application::Options::finish ( Archive )
virtual

Additional per-Archive finishing tasks (e.g., unload)

Optional finishing tasks, run once per Archive (after main process)

Reimplemented in Pulsar::UnloadOptions.

◆ process()

void Pulsar::Application::Options::process ( Archive )
virtual

Additional per-Archive processing tasks.

Optional processing tasks, run once per Archive (before main process)

Implements Pulsar::Processor.

Reimplemented in Pulsar::CommonOptions, and Pulsar::StandardOptions.

◆ setup()

void Pulsar::Application::Options::setup ( )
virtual

Additional one-time setup tasks.

Optional setup steps, run once at start (before main finalize)

Reimplemented in Pulsar::UnloadOptions, and Pulsar::PlotOptions.


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

Generated using doxygen 1.8.17