utilities::params_file Class Reference

Class for dealing with the parameters of file based wrapper objects. More...

#include <params_file.h>

Inheritance diagram for utilities::params_file:

[legend]

Collaboration diagram for utilities::params_file:

[legend]

List of all members.

Public Member Functions
	params_file (int a, string s, std::map< utilities::D_TYPE, int > contents)
	constructor
	params_file (int a, std::map< utilities::D_TYPE, int > contents)
	constructor with default file name
Wrapper_in *	make_wrapper_in ()
	Returns a pointer to a wrapper_i object based on the parameter object.
Wrapper_out *	make_wrapper_out ()
	Returns a pointer to a output wrapper_o object based on the parameter object.
Public Attributes
int	rows
	number of rows
int	cols
	number of cols
string	fname
	name of file to read data from
std::map< utilities::D_TYPE, int >	contains

---

Detailed Description

Class for dealing with the parameters of file based wrapper objects.

---

Constructor & Destructor Documentation

utilities::params_file::params_file	(	int	a,
		string	s,
		std::map< utilities::D_TYPE, int >	contents
	)			[inline]

constructor

Parameters:

	a	number of particles
	s	filename
	contents	map of contents

utilities::params_file::params_file	(	int	a,
		std::map< utilities::D_TYPE, int >	contents
	)			[inline]

constructor with default file name

Parameters:

	a	number of particles
	contents	map of contents

---

Member Function Documentation

Wrapper_in* utilities::params_file::make_wrapper_in

(

)

[inline, virtual]

Returns a pointer to a wrapper_i object based on the parameter object.

This function instataites an object, but the paramter class does not clean it up. This should only be called in cases where how it will be cleaned up is clear. This should probably be moved in to protected and have every child class be friends with master_box.

Implements utilities::params.

Wrapper_out* utilities::params_file::make_wrapper_out

(

)

[inline, virtual]

Returns a pointer to a output wrapper_o object based on the parameter object.

This function instataites an object, but the paramter class does not clean it up. This should only be called in cases where how it will be cleaned up is clear. This should probably be moved in to protected and have every child class be friends with master_box.

Implements utilities::params.

---

Member Data Documentation

int utilities::params_file::cols

number of cols

std::map<utilities::D_TYPE,int> utilities::params::contains [inherited]

string utilities::params_file::fname

name of file to read data from

int utilities::params_file::rows

number of rows

---

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

• common_src/include/params_file.h