BaseDetectorSet Class Reference

Base class for detectors. More...

#include <detector.h>

Inheritance diagram for BaseDetectorSet:

Collaboration diagram for BaseDetectorSet:

Public Member Functions
virtual void	SetWorkFlag (int wf)=0
	set bit flag
virtual void	Flush ()=0
	Flush data from memory to the disc.
virtual int	StartRecord (int it=0)=0
	start record
virtual int	StartNextRecord (bool recorded=true, int async_depth=0)=0
	Start recording current field values.
virtual int	CompleteNextRecord (bool recorded=true, int async_depth=0, const std::string &framehead="")=0
	end record current field values
virtual int	EndRecord ()=0
	finish work
virtual void	SetExtra (const std::string &extra)
	set extra string which will be written in the text file, used in text recorders only
Public Member Functions inherited from apComponent
void	InitComponent (const apComponent &other, const std::vector< int > &p_id=std::vector< int >())
	borrow settings from other component
virtual void	DumpOther (const apComponent *comp, bool lim=false)
	dump some component using dumper
virtual void	DumpOther (int flags, const apComponent *comp, bool lim=false)
	dump some component using dumper and checking bit flags
virtual void	Dump (bool lim=false)
	dump itself using dumper
Public Member Functions inherited from restorer
int	save_data (FILE *f)
	save data to the file
int	load_data (FILE *f)
	read data from the file
int	save_data (const char *fname)
	save data to the file
int	load_data (const char *fname)
	read data from the file

Public Attributes
bool	no_time_skew = false
	Do not use time profile in output.

Protected Attributes
std::vector< int >	dims
	Dimensions for interpreting binary file as a mesh.
Protected Attributes inherited from apComponent
int	ut
	if information about this object will be dumped
std::string	name
	if timers will be used

Additional Inherited Members
Protected Types inherited from apComponent
typedef std::set< apComponent * >	registry_t
	name used in dump and runlog files
Protected Member Functions inherited from apComponent
virtual void	AddDefaultTimers (const std::vector< int > &p_id)
	connect internal timers hierarchy from log to external timers p_id
void	start (int id)
	start timers
void	stop (int id, int force=0)
	stop timers

Detailed Description

Base class for detectors.

Work with this class assumes three phases:

1. Intialization using Init and StartRecord.
2. StartNextRecord and CompleteNextRecord.
3. EndRecord.

Member Function Documentation

StartNextRecord()

virtual int BaseDetectorSet::StartNextRecord ( bool  recorded = true, int  async_depth = 0  )

pure virtual

Start recording current field values.

Parameter recorded is used to indicate whether the record needs to be output in file (otherwise it may be accounted for buffering purposes)

Implemented in DetectorSet< vset_tt, xfer_t >.

StartRecord()

virtual int BaseDetectorSet::StartRecord ( int  it = 0 )

pure virtual

start record

Parameters

it	iteration from which recording is started (not zero if record is continuing after restarting the numerical experiment).

Implemented in DetectorSet< vset_tt, xfer_t >.

---

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

• detector.h