Dynamic Neural Field Composer 0.0.0
A C++20 library and interactive application for building and simulating Dynamic Neural Field (DNF) architectures.
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
dnf_composer::Plot Class Referenceabstract

Abstract base class for all renderable plots. More...

#include <plot.h>

Inheritance diagram for dnf_composer::Plot:
Collaboration diagram for dnf_composer::Plot:

Public Member Functions

PlotAnnotations getAnnotations () const
 
PlotDimensions getDimensions () const
 
PlotType getType () const
 
int getUniqueIdentifier () const
 
 Plot (PlotCommonParameters parameters=PlotCommonParameters())
 Construct a plot with the given common parameters.
 
virtual void render (const std::vector< std::vector< double > * > &data, const std::vector< std::string > &legends)=0
 Render the plot using the provided data and legends.
 
void setAnnotations (const PlotAnnotations &annotations)
 
void setDimensions (const PlotDimensions &dimensions)
 
virtual std::string toString () const =0
 
virtual ~Plot ()=default
 

Protected Attributes

PlotCommonParameters commonParameters
 Type, axes ranges, and annotation strings.
 
int uniqueIdentifier
 Auto-assigned unique ID.
 

Static Protected Attributes

static int uniqueIdentifierCounter = 0
 Global counter for plot ID assignment.
 

Detailed Description

Abstract base class for all renderable plots.

Each Plot has a unique integer ID, common parameters (type, dimensions, axis labels), and implements a render() method that draws the plot using the provided data pointers and legend strings.

Constructor & Destructor Documentation

◆ ~Plot()

virtual dnf_composer::Plot::~Plot ( )
virtualdefault

◆ Plot()

dnf_composer::Plot::Plot ( PlotCommonParameters  parameters = PlotCommonParameters())
explicit

Construct a plot with the given common parameters.

Parameters
parametersType, dimensions, and annotations (defaults to LINE_PLOT with default ranges).

Member Function Documentation

◆ getAnnotations()

PlotAnnotations dnf_composer::Plot::getAnnotations ( ) const

◆ getDimensions()

PlotDimensions dnf_composer::Plot::getDimensions ( ) const

◆ getType()

PlotType dnf_composer::Plot::getType ( ) const

◆ getUniqueIdentifier()

int dnf_composer::Plot::getUniqueIdentifier ( ) const

◆ render()

virtual void dnf_composer::Plot::render ( const std::vector< std::vector< double > * > &  data,
const std::vector< std::string > &  legends 
)
pure virtual

Render the plot using the provided data and legends.

Parameters
dataPointers to the component vectors to display.
legendsLegend label for each data series.

Implemented in dnf_composer::Heatmap, and dnf_composer::LinePlot.

◆ setAnnotations()

void dnf_composer::Plot::setAnnotations ( const PlotAnnotations annotations)

◆ setDimensions()

void dnf_composer::Plot::setDimensions ( const PlotDimensions dimensions)

◆ toString()

virtual std::string dnf_composer::Plot::toString ( ) const
pure virtual

Member Data Documentation

◆ commonParameters

PlotCommonParameters dnf_composer::Plot::commonParameters
protected

Type, axes ranges, and annotation strings.

◆ uniqueIdentifier

int dnf_composer::Plot::uniqueIdentifier
protected

Auto-assigned unique ID.

◆ uniqueIdentifierCounter

int dnf_composer::Plot::uniqueIdentifierCounter = 0
inlinestaticprotected

Global counter for plot ID assignment.


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