basso::TextInput Class Reference

Processes a generic text input file. More...

#include <TextInput.h>

Inheritance diagram for basso::TextInput:

List of all members.

Public Member Functions
	TextInput (char keyword='$', char comment='#')
	TextInput (const String &file, char keyword='$', char comment='#')
virtual	~TextInput ()
virtual int	ProcessFile ()
int	GetCards (const String &keyword, list< InputCard > &cards) const
int	GetCard (const String &keyword, InputCard &card) const
Protected Attributes
multimap< String, InputCard >	fCards
char	fKeyword
char	fComment

---

Detailed Description

Processes a generic text input file.

This class is mostly intended to read input cards that are not found in a mesh file like Gmsh. This would include things like material parameters, boundary conditions etc. This class supports any ASCII input file that uses a keyword symbol to denote a card(s).

Definition at line 34 of file TextInput.h.

---

Constructor & Destructor Documentation

basso::TextInput::TextInput	(	char	keyword = '$',
		char	comment = '#'
	)			[inline]

Constructor for TextInput

Parameters:

	file	file name of the file to be processed
	keyword	keyword symbol for input file (default is '$')
	comment	commment symbol for input file (defult is '#')

Definition at line 43 of file TextInput.h.

References fComment, and fKeyword.

---

Member Function Documentation

int basso::TextInput::GetCards	(	const String &	keyword,
		list< InputCard > &	cards
	)			const

gets all the InputCards with of a given keyword. If no cards are found that match the keyword then zero is returned else 1 is returned.

Parameters:

	keyword	the keyword of the InputCards
	cards	the InputCards with keyword. This list will be cleared of any values that it has when it enters.

Definition at line 74 of file TextInput.h.

References fCards.

int basso::TextInput::GetCard	(	const String &	keyword,
		InputCard &	card
	)			const

gets the first InputCards with of a given keyword. If no cards are found that match the keyword then zero is returned else 1 is returned.

Parameters:

	keyword	the keyword of the InputCard
	card	the InputCard with keyword.

Definition at line 91 of file TextInput.h.

References fCards.

---

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

• /Users/jack/Code/basso_dev/inc/TextInput.h

---