BALL  1.4.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Protected Attributes | List of all members
BALL::RDFSection Class Reference

#include <BALL/STRUCTURE/RDFSection.h>

Inheritance diagram for BALL::RDFSection:
BALL::ParameterSection

Public Types

Enums
enum  Type { UNKNOWN_TYPE = 0, PIECEWISE_POLYNOMIAL = 1 }
- Public Types inherited from BALL::ParameterSection
enum  { MAX_FIELDS = 20 }

Public Member Functions

Constructors and destructors
 RDFSection ()
 RDFSection (const RDFSection &rdf_section)
virtual ~RDFSection ()
Assignment
const RDFSectionoperator= (const RDFSection &rdf_section)
virtual void clear ()
Parameter extraction
virtual bool extractSection (Parameters &parameters, const String &section_name)
Accessors
const RadialDistributionFunctiongetRDF () const
Predicates
bool operator== (const RDFSection &section) const
- Public Member Functions inherited from BALL::ParameterSection
 ParameterSection ()
 ParameterSection (const ParameterSection &parameter_section)
virtual ~ParameterSection ()
const StringgetSectionName () const
const StringgetValue (const String &key, const String &variable) const
bool has (const String &key, const String &variable) const
bool has (const String &key) const
bool hasVariable (const String &variable) const
Position getColumnIndex (const String &variable) const
Size getNumberOfVariables () const
Size getNumberOfKeys () const
const StringgetValue (Position key_index, Position variable_index) const
const StringgetKey (Position key_index) const
const ParameterSectionoperator= (const ParameterSection &section)
virtual bool isValid () const
bool operator== (const ParameterSection &parameter_section) const

Protected Attributes

RadialDistributionFunction rdf_
- Protected Attributes inherited from BALL::ParameterSection
String section_name_
String format_line_
StringHashMap< Indexsection_entries_
StringHashMap< Indexvariable_names_
std::vector< Stringentries_
std::vector< Stringkeys_
Size number_of_variables_
std::vector< floatversion_
bool valid_

Additional Inherited Members

- Public Attributes inherited from BALL::ParameterSection
Options options
- Static Public Attributes inherited from BALL::ParameterSection
static const String UNDEFINED

Detailed Description

Helper class for RDFParameter.

Definition at line 21 of file RDFSection.h.

Member Enumeration Documentation

Enumerator:
UNKNOWN_TYPE 
PIECEWISE_POLYNOMIAL 

Definition at line 32 of file RDFSection.h.

Constructor & Destructor Documentation

BALL::RDFSection::RDFSection ( )

Default constructor

BALL::RDFSection::RDFSection ( const RDFSection rdf_section)

Copy constructor

virtual BALL::RDFSection::~RDFSection ( )
virtual

Destructor

Member Function Documentation

virtual void BALL::RDFSection::clear ( )
virtual

Clear method

Reimplemented from BALL::ParameterSection.

virtual bool BALL::RDFSection::extractSection ( Parameters parameters,
const String section_name 
)
virtual

Reads a parameter section from an INI file. This method reads the section given in section_name from ini_file, interprets (if given) a format line, reads the data from this section according to the format, and builds some datastructures for fast and easy acces to the data.

Parameters
parametersthe parameters defining the inifile to be read from
section_namethe name of the section to be read (without the squared brackets)
Returns
bool - true if the section could be read, false otherwise

Reimplemented from BALL::ParameterSection.

const RadialDistributionFunction& BALL::RDFSection::getRDF ( ) const

return the RDF created by extractSection()

const RDFSection& BALL::RDFSection::operator= ( const RDFSection rdf_section)
bool BALL::RDFSection::operator== ( const RDFSection section) const

Equality operator

Member Data Documentation

RadialDistributionFunction BALL::RDFSection::rdf_
protected

Definition at line 99 of file RDFSection.h.