This class contains options for the use of an external plot utility like guilogger or neuronviz or just simply file output. More...

#include <plotoption.h>

Classes
struct	matchMode
	nice predicate function for finding by mode More...

Public Member Functions
	PlotOption ()

	PlotOption (PlotMode mode, int interval=1, std::string parameter=std::string(), std::string filter=std::string())
	creates a new plotting object More...

virtual	~PlotOption ()

virtual PlotMode	getPlotOptionMode () const

virtual void	setFilter (const std::list< std::string > &accept, const std::list< std::string > &ignore)
	sets a filter to this plotoption: To export only selected channels More...

virtual void	setFilter (const std::string &filter)
	sets a filter to this plotoption: syntax: +accept_substr -ignore_substr ... More...

virtual void	flush (long step)

void	addConfigurable (const Configurable *)

void	setName (const std::string &name)

const std::string &	getName () const

bool	open ()
	opens the connections to the plot tool More...

void	close ()
	closes the connections to the plot tool More...

virtual bool	useChannel (const std::string &name)

virtual int	printInspectables (const std::list< const Inspectable * > &inspectables, int cnt=0)

virtual int	printInspectableNames (const std::list< const Inspectable * > &inspectables, int cnt=0)

virtual void	printInspectableInfoLines (const std::list< const Inspectable * > &inspectables)

void	printNetworkDescription (const std::string &name, const Inspectable *inspectable)
	prints a network description of the structure given by the inspectable object. More...

Public Attributes
FILE *	pipe

long	t

int	interval

std::string	name

Friends
class	WiredController

class	PlotOptionEngine

Detailed Description

This class contains options for the use of an external plot utility like guilogger or neuronviz or just simply file output.

Examples:: integration/main.cpp.

Constructor & Destructor Documentation

PlotOption ( )

inline

PlotOption	(	PlotMode	mode,
		int	interval = `1`,
		std::string	parameter = `std::string()`,
		std::string	filter = `std::string()`
	)

inline

creates a new plotting object

Parameters

mode	output type

See Also: PlotMode

Parameters

interval	every i-th step is plotted
parameter	free parameters for plotting tool &param filter filter for channels,

See Also: setFilter(const std::string)

Note: the argument whichSensor is removed. You can adjust this in the wirings now.

virtual ~PlotOption ( )

inlinevirtual

Member Function Documentation

void addConfigurable ( const Configurable * )

void close ( )

closes the connections to the plot tool

void flush ( long step )

virtual

const std::string& getName ( ) const

inline

virtual PlotMode getPlotOptionMode ( ) const

inlinevirtual

bool open ( )

opens the connections to the plot tool

void printInspectableInfoLines ( const std::list< const Inspectable * > & inspectables )

virtual

int printInspectableNames	(	const std::list< const Inspectable * > &	inspectables,
		int	cnt = `0`
	)

virtual

int printInspectables	(	const std::list< const Inspectable * > &	inspectables,
		int	cnt = `0`
	)

virtual

void printNetworkDescription	(	const std::string &	name,
		const Inspectable *	inspectable
	)

prints a network description of the structure given by the inspectable object.

(mostly unused now) The network description syntax is as follow

#N neural_net NETWORKNAME
#N layer LAYERNAME1 RANK?
#N neuron N0 BIASN0?
#N neuron N1 BIASN1?
#N layer LAYERNAME2 RANK?
#N neuron K0 BIASK0?
#N neuron K1 BIASK1?
...
#N connection C00 N0 K0
#N connection C10 N0 K1
#N connection C01 N1 K0
#N connection C11 N1 K1
...
#N nn_end

All identifiers are alphanumeric without spaces.

virtual void setFilter	(	const std::list< std::string > &	accept,
		const std::list< std::string > &	ignore
	)

virtual

sets a filter to this plotoption: To export only selected channels

void setFilter ( const std::string & filter )

virtual

sets a filter to this plotoption: syntax: +accept_substr -ignore_substr ...

sets a filter to this plotoption: syntax: +acceptregexp -ignoreregexp ...

void setName ( const std::string & name )

inline

bool useChannel ( const std::string & name )

virtual

Friends And Related Function Documentation

friend class PlotOptionEngine

friend

friend class WiredController

friend

Member Data Documentation

int interval

std::string name

FILE* pipe

long t

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

Classes

Public Member Functions

Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation