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

DCField Class Reference

A single field of a Distributed Class, either atomic or molecular. More...

#include <dcField.h>

Inheritance diagram for DCField:

DCAtomicField DCMolecularField List of all members.

Public Member Functions

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.

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.

virtual ~DCField ()
virtual void write (ostream &out, int indent_level=0) const=0
virtual void generate_hash (HashGenerator &hash) const
 Accumulates the properties of this field into the hash.


Public Attributes

int _number
string _name

Detailed Description

A single field of a Distributed Class, either atomic or molecular.

Definition at line 40 of file dcField.h.

Constructor & Destructor Documentation

DCField::~DCField (   )  [virtual]
 

Definition at line 97 of file dcField.cxx.

Member Function Documentation

DCAtomicField * DCField::as_atomic_field (   )  [virtual]
 

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 * DCField::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 in DCMolecularField.

Definition at line 85 of file dcField.cxx.

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

Accumulates the properties of this field into the hash.

Reimplemented in DCAtomicField, and DCMolecularField.

Definition at line 111 of file dcField.cxx.

Referenced by DCMolecularField::write().

const string & DCField::get_name (   )  const
 

Returns the name of this field.

Definition at line 51 of file dcField.cxx.

References NULL.

int DCField::get_number (   )  const
 

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 _name.

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

Implemented in DCAtomicField, and DCMolecularField.

Member Data Documentation

string DCField::_name
 

Definition at line 55 of file dcField.h.

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

int DCField::_number
 

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