The Sparta Modeling Framework
Loading...
Searching...
No Matches
sparta::collection::Collector Class Reference

A non-templated base class that all Collectors should inherit from. More...

#include <Collector.hpp>

Inheritance diagram for sparta::collection::Collector:

Public Member Functions

 Collector (const std::string &name)
 Construct a collector.
 
virtual ~Collector ()
 Enable polymorphism and also be nice.
 
std::string getName () const
 

Protected Attributes

std::string name_
 

Detailed Description

A non-templated base class that all Collectors should inherit from.

Definition at line 22 of file Collector.hpp.

Constructor & Destructor Documentation

◆ Collector()

sparta::collection::Collector::Collector ( const std::string &  name)
inline

Construct a collector.

Parameters
parentthe parent tree node for this collector.
namethe name of the collector.
groupthe TreeNode group name.
group_idxthe TreeNode group index.

Definition at line 32 of file Collector.hpp.

◆ ~Collector()

virtual sparta::collection::Collector::~Collector ( )
inlinevirtual

Enable polymorphism and also be nice.

Definition at line 37 of file Collector.hpp.

Member Function Documentation

◆ getName()

std::string sparta::collection::Collector::getName ( ) const
inline

Definition at line 39 of file Collector.hpp.

Member Data Documentation

◆ name_

std::string sparta::collection::Collector::name_
protected

The name of the collector. This will be used by many collectors to create child collectable objects

Definition at line 48 of file Collector.hpp.


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