Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

DCMolecularField Class Reference

A single molecular field of a Distributed Class, as read from a .dc file. More...

#include <dcMolecularField.h>

Inheritance diagram for DCMolecularField:

DCField List of all members.

Public Types

typedef pvector< DCAtomicField * > Fields

Public Member Functions

virtual DCMolecularField * as_molecular_field ()
 Returns the same field pointer converted to a molecular field pointer, if this is in fact a molecular field; otherwise, returns NULL.

int get_num_atomics () const
 Returns the number of atomic fields that make up this molecular field.

DCAtomicField * get_atomic (int n) const
 Returns the nth atomic field that makes up this molecular field.

 DCMolecularField ()
virtual void write (ostream &out, int indent_level=0) const
 Generates a parseable description of the object to the indicated output stream.

virtual void generate_hash (HashGenerator &hash) const
 Accumulates the properties of this field into the hash.

int get_number () const
 Returns a unique index number associated with this field.

const string & get_name () const
 Returns the name of this field.

virtual DCAtomicField * as_atomic_field ()
 Returns the same field pointer converted to an atomic field pointer, if this is in fact an atomic field; otherwise, returns NULL.


Public Attributes

Fields _fields
int _number
string _name

Detailed Description

A single molecular field of a Distributed Class, as read from a .dc file.

This represents a combination of two or more related atomic fields, that will often be treated as a unit.

Definition at line 43 of file dcMolecularField.h.

Member Typedef Documentation

typedef pvector<DCAtomicField *> DCMolecularField::Fields
 

Definition at line 58 of file dcMolecularField.h.

Constructor & Destructor Documentation

DCMolecularField::DCMolecularField (   ) 
 

Definition at line 89 of file dcMolecularField.cxx.

Member Function Documentation

DCAtomicField * DCField::as_atomic_field (   )  [virtual, inherited]
 

Returns the same field pointer converted to an atomic field pointer, if this is in fact an atomic field; otherwise, returns NULL.

Reimplemented in DCAtomicField.

Definition at line 68 of file dcField.cxx.

DCMolecularField * DCMolecularField::as_molecular_field (   )  [virtual]
 

Returns the same field pointer converted to a molecular field pointer, if this is in fact a molecular field; otherwise, returns NULL.

Reimplemented from DCField.

Definition at line 42 of file dcMolecularField.cxx.

References _fields.

void DCMolecularField::generate_hash (  HashGenerator &  hash  )  const [virtual]
 

Accumulates the properties of this field into the hash.

Reimplemented from DCField.

Definition at line 132 of file dcMolecularField.cxx.

DCAtomicField * DCMolecularField::get_atomic (  int  n  )  const
 

Returns the nth atomic field that makes up this molecular field.

This may or may not be a field of this particular class; it might be defined in a parent class.

Definition at line 76 of file dcMolecularField.cxx.

References _fields, DCField::_name, and indent().

const string & DCField::get_name (   )  const [inherited]
 

Returns the name of this field.

Definition at line 51 of file dcField.cxx.

References NULL.

int DCMolecularField::get_num_atomics (   )  const
 

Returns the number of atomic fields that make up this molecular field.

Definition at line 57 of file dcMolecularField.cxx.

References _fields, nassertr, and NULL.

int DCField::get_number (   )  const [inherited]
 

Returns a unique index number associated with this field.

This is defined implicitly when the .dc file(s) are read.

Definition at line 38 of file dcField.cxx.

References DCField::_name.

void DCMolecularField::write (  ostream &  out,
int  indent_level = 0
)  const [virtual]
 

Generates a parseable description of the object to the indicated output stream.

Implements DCField.

Definition at line 104 of file dcMolecularField.cxx.

References _fields, HashGenerator::add_int(), and DCField::generate_hash().

Member Data Documentation

Fields DCMolecularField::_fields
 

Definition at line 59 of file dcMolecularField.h.

Referenced by as_molecular_field(), get_atomic(), get_num_atomics(), and write().

string DCField::_name [inherited]
 

Definition at line 55 of file dcField.h.

Referenced by get_atomic(), and DCField::get_number().

int DCField::_number [inherited]
 

Definition at line 54 of file dcField.h.

The documentation for this class was generated from the following files:
Generated on Fri May 2 01:41:00 2003 for Direct by doxygen1.3