oofem::DataReader Class Reference

Class representing the abstraction for input data source. More...

#include <datareader.h>

Inheritance diagram for oofem::DataReader:

Public Types
enum	InputRecordType {   IR_domainRec, IR_outManRec, IR_domainCompRec, IR_geometryRec,   IR_gbpmRec, IR_emodelRec, IR_mstepRec, IR_expModuleRec,   IR_dofmanRec, IR_elemRec, IR_crosssectRec, IR_matRec,   IR_nlocBarRec, IR_bcRec, IR_icRec, IR_funcRec,   IR_setRec, IR_xfemManRec, IR_enrichFuncRec, IR_geoRec,   IR_enrichItemRec, IR_enrichFrontRec, IR_propagationLawRec, IR_crackNucleationRec,   IR_fracManRec, IR_failCritRec, IR_contactManRec, IR_contactDefRec }
	Determines the type of input record. More...

Public Member Functions
	DataReader ()
virtual	~DataReader ()
virtual InputRecord *	giveInputRecord (InputRecordType irType, int recordId)=0
	Returns input record corresponding to given InputRecordType value and its record_id. More...
virtual bool	peakNext (const std::string &keyword)
	Peak in advance into the record list. More...
virtual void	finish ()=0
	Allows to detach all data connections. More...
virtual std::string	giveReferenceName () const =0
	Gives the reference file name (e.g. file name) More...
std::string	giveOutputFileName ()
	Gives the output file name. More...
std::string	giveDescription ()
	Gives the problem description. More...
void	report_error (const char *_class, const char *proc, const char *kwd, IRResultType result, const char *file, int line)
	Prints the error message. More...

Protected Attributes
std::string	outputFileName
	Output file name (first line in OOFEM input files). More...
std::string	description
	Description line (second line in OOFEM input files). More...

Detailed Description

Class representing the abstraction for input data source.

Its role is to provide input records for particular components. The input records are identified by record type and component number. The order of input records is in fact determined by the coded sequence of component initialization. The input record identification facilitates the implementation of database readers with direct or random access.

Definition at line 50 of file datareader.h.

Member Enumeration Documentation

enum oofem::DataReader::InputRecordType

Determines the type of input record.

Enumerator
IR_domainRec
IR_outManRec
IR_domainCompRec
IR_geometryRec
IR_gbpmRec
IR_emodelRec
IR_mstepRec
IR_expModuleRec
IR_dofmanRec
IR_elemRec
IR_crosssectRec
IR_matRec
IR_nlocBarRec
IR_bcRec
IR_icRec
IR_funcRec
IR_setRec
IR_xfemManRec
IR_enrichFuncRec
IR_geoRec
IR_enrichItemRec
IR_enrichFrontRec
IR_propagationLawRec
IR_crackNucleationRec
IR_fracManRec
IR_failCritRec
IR_contactManRec
IR_contactDefRec

Definition at line 60 of file datareader.h.

Constructor & Destructor Documentation

oofem::DataReader::DataReader ( )

inline

Definition at line 69 of file datareader.h.

virtual oofem::DataReader::~DataReader ( )

inlinevirtual

Definition at line 70 of file datareader.h.

Member Function Documentation

virtual void oofem::DataReader::finish ( )

pure virtual

Allows to detach all data connections.

Implemented in oofem::DynamicDataReader, and oofem::OOFEMTXTDataReader.

std :: string oofem::DataReader::giveDescription ( )

inline

Gives the problem description.

Definition at line 96 of file datareader.h.

Referenced by oofem::InstanciateProblem().

virtual InputRecord* oofem::DataReader::giveInputRecord ( InputRecordType  irType, int  recordId  )

pure virtual

Returns input record corresponding to given InputRecordType value and its record_id.

The returned InputRecord reference is valid only until the next call.

Parameters

irType	Determines type of record to be returned.
recordId	Determines the record number corresponding to component number.

Implemented in oofem::DynamicDataReader, and oofem::OOFEMTXTDataReader.

Referenced by oofem::EngngModel::instanciateMetaSteps(), oofem::InstanciateProblem(), oofem::GeometryBasedEI::instanciateYourself(), oofem::NucleationCriterion::instanciateYourself(), oofem::Delamination::instanciateYourself(), oofem::ContactManager::instanciateYourself(), oofem::ModuleManager< InitModule >::instanciateYourself(), oofem::XfemManager::instanciateYourself(), oofem::FractureManager::instanciateYourself(), oofem::ParticleTopologyDescription::instanciateYourself(), and oofem::Domain::instanciateYourself().

std :: string oofem::DataReader::giveOutputFileName ( )

inline

Gives the output file name.

Definition at line 94 of file datareader.h.

Referenced by oofem::InstanciateProblem().

virtual std :: string oofem::DataReader::giveReferenceName ( ) const

pure virtual

Gives the reference file name (e.g. file name)

Implemented in oofem::DynamicDataReader, and oofem::OOFEMTXTDataReader.

Referenced by oofem::EngngModel::instanciateYourself().

virtual bool oofem::DataReader::peakNext ( const std::string &  keyword )

inlinevirtual

Peak in advance into the record list.

Returns

True if next keyword is a set.

Reimplemented in oofem::DynamicDataReader, and oofem::OOFEMTXTDataReader.

Definition at line 84 of file datareader.h.

Referenced by oofem::Domain::instanciateYourself().

void oofem::DataReader::report_error	(	const char *	_class,
		const char *	proc,
		const char *	kwd,
		IRResultType	result,
		const char *	file,
		int	line
	)

Prints the error message.

Member Data Documentation

std :: string oofem::DataReader::description

protected

Description line (second line in OOFEM input files).

Definition at line 56 of file datareader.h.

Referenced by oofem::OOFEMTXTDataReader::OOFEMTXTDataReader(), and oofem::DynamicDataReader::writeToFile().

std :: string oofem::DataReader::outputFileName

protected

Output file name (first line in OOFEM input files).

Definition at line 54 of file datareader.h.

Referenced by oofem::OOFEMTXTDataReader::OOFEMTXTDataReader(), and oofem::DynamicDataReader::writeToFile().

---

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

• datareader.h