#include <BALL/VIEW/MODELS/atomBondModelBaseProcessor.h>

Inheritance diagram for BALL::VIEW::AtomBondModelBaseProcessor:

Public Member Functions
Constructors and Destructors
	AtomBondModelBaseProcessor ()

	AtomBondModelBaseProcessor (const AtomBondModelBaseProcessor &baseProcessor)

virtual	~AtomBondModelBaseProcessor ()

virtual void	clear ()

Assignment
void	set (const AtomBondModelBaseProcessor &processor)

const AtomBondModelBaseProcessor &	operator= (const AtomBondModelBaseProcessor &processor)

Processor specific methods
virtual Processor::Result	operator() (Composite &composite)

debuggers and diagnostics
virtual void	dump (std::ostream &s=std::cout, Size depth=0) const

virtual void	clearComposites ()

virtual bool	createGeometricObjects ()

Public Member Functions inherited from BALL::VIEW::ModelProcessor
	ModelProcessor ()

	ModelProcessor (const ModelProcessor &model_processor)

virtual	~ModelProcessor ()

virtual bool	isValid () const

GeometricObjectList &	getGeometricObjects ()
	Return the list with the created geometric objects. More...

const GeometricObjectList &	getGeometricObjects () const
	Return the list with the created geometric objects. More...

void	setDrawingPrecision (Index precision)

Index	getDrawingPrecision () const

void	setSurfaceDrawingPrecision (float precision)

float	getSurfaceDrawingPrecision () const

Public Member Functions inherited from BALL::UnaryProcessor< Composite >
	UnaryProcessor ()

	UnaryProcessor (const UnaryProcessor &)

virtual	~UnaryProcessor ()

virtual bool	start ()

virtual bool	finish ()

Public Member Functions inherited from BALL::PropertyManager
BALL_INLINE	PropertyManager ()
	Default constructor. More...

BALL_INLINE	PropertyManager (const PropertyManager &property_manager)
	Copy constructor. More...

virtual	~PropertyManager ()
	Destructor. More...

virtual void	destroy ()
	Clears all properties. More...

void	set (const PropertyManager &property_manager)

const PropertyManager &	operator= (const PropertyManager &property_manager)

void	get (PropertyManager &property_manager) const

void	swap (PropertyManager &property_manager)

BitVector &	getBitVector ()

const BitVector &	getBitVector () const

	operator BitVector & ()

void	setProperty (Property property)

void	clearProperty (Property property)

void	toggleProperty (Property property)

Size	countProperties () const

const NamedProperty &	getNamedProperty (Position index) const

NamedProperty &	getNamedProperty (Position index)

void	setProperty (const NamedProperty &property)

void	setProperty (const std::string &name)

void	setProperty (const std::string &name, bool value)

void	setProperty (const std::string &name, int value)

void	setProperty (const std::string &name, unsigned int value)

void	setProperty (const std::string &name, float value)

void	setProperty (const std::string &name, double value)

void	setProperty (const std::string &name, const std::string &value)

void	setProperty (const std::string &name, const PersistentObject &value)

const NamedProperty &	getProperty (const std::string &name) const

NamedPropertyIterator	beginNamedProperty ()

NamedPropertyIterator	endNamedProperty ()

void	clearProperty (const std::string &name)

Size	countNamedProperties () const

bool	hasProperty (Property property) const
	Query for an unnamed property. More...

bool	hasProperty (const std::string &name) const
	Query for a named property. More...

bool	operator== (const PropertyManager &pm) const

bool	operator!= (const PropertyManager &pm) const
	Inequality operator. More...

void	write (PersistenceManager &pm) const
	Persistent stream writing. More...

bool	read (PersistenceManager &pm)
	Persistent stream reading. More...

bool	isValid () const

void	dump (std::ostream &s=std::cout, Size depth=0) const

Protected Member Functions
virtual void	visualiseBond_ (const Bond &bond)

virtual void	visualiseRings_ ()

Protected members
This methods are provided for easy generation of models. With the method insertAtom_() all Atom objects that will be part of the newly created model will be stored. This stored atoms are later used (in the method buildBondModels_()) to create the models of the Bond objects that can be reached from the atoms. The other methods are access method for the stored atoms.
void	insertAtom_ (const Atom *atom)

void	clearUsedAtoms_ ()

std::list< const Atom * > &	getAtomList_ ()

HashSet< const Atom * > &	getAtomSet_ ()

void	buildBondModels_ ()

Protected Attributes
vector< vector< Atom * > >	rings_

HashSet< const Atom * >	ring_atoms_

Protected Attributes inherited from BALL::VIEW::ModelProcessor
GeometricObjectList	geometric_objects_

Index	drawing_precision_

float	surface_drawing_precision_

Additional Inherited Members
Public Types inherited from BALL::UnaryFunctor< Composite, Processor::Result >
typedef Processor::Result	result_type

typedef Composite	argument_type

typedef Composite &	argument_reference

typedef const Composite &	const_argument_reference

typedef Composite *	argument_pointer

typedef const Composite *	const_argument_pointer

Detailed Description

AtomBondModelBaseProcessor class. The class AtomBondModelBaseProcessor is the base class for all models whose structure is somewhat orientated after the Atom and Bond structure (e.g. the model Ball And Stick)

Definition at line 31 of file atomBondModelBaseProcessor.h.

Constructor & Destructor Documentation

BALL::VIEW::AtomBondModelBaseProcessor::AtomBondModelBaseProcessor ( )

Default Constructor. Clear all used Atom objects.

BALL::VIEW::AtomBondModelBaseProcessor::AtomBondModelBaseProcessor ( const AtomBondModelBaseProcessor & baseProcessor )

Copy constructor.

virtual BALL::VIEW::AtomBondModelBaseProcessor::~AtomBondModelBaseProcessor ( )

virtual

Destructor.

Member Function Documentation

void BALL::VIEW::AtomBondModelBaseProcessor::buildBondModels_ ( )

protected

Build the bond models. This method is called from the finish method. It iterates over every Bond object that can be reached from the stored Atom objects and calls visualiseBond_(), which has to be overloaded in derived classes.

virtual void BALL::VIEW::AtomBondModelBaseProcessor::clear ( )

virtual

Explicit default initialization. Reset the state of this AtomBondModelBaseProcessor:

clear the used atoms
clear the ModelProcessor Calls ModelProcessor::clear. Calls clearUsedAtoms_().

Reimplemented from BALL::VIEW::ModelProcessor.

Reimplemented in BALL::VIEW::AddBallAndStickModel, and BALL::VIEW::HBondModelProcessor.

virtual void BALL::VIEW::AtomBondModelBaseProcessor::clearComposites ( )

virtual

Needed in derived classes, which store references to the Composite instances they worked on. Here only needed for a common interface and therefore empty.

Reimplemented from BALL::VIEW::ModelProcessor.

void BALL::VIEW::AtomBondModelBaseProcessor::clearUsedAtoms_ ( )

protected

Clear all used atoms.

virtual bool BALL::VIEW::AtomBondModelBaseProcessor::createGeometricObjects ( )

virtual

Method to create geometric objects. This method is called in Representation::update() after all operator() was called for all Composites. To be overloaded in derived classes

Reimplemented from BALL::VIEW::ModelProcessor.

Reimplemented in BALL::VIEW::AddBallAndStickModel.

virtual void BALL::VIEW::AtomBondModelBaseProcessor::dump	(	std::ostream &	s = `std::cout`,
		Size	depth = `0`
	)		const

virtual

Internal value dump. Dump the current state to the output ostream s with dumping depth depth. Calls ModelProcessor::dump.

Parameters

s	output stream where to output the state
depth	the dumping depth

Reimplemented from BALL::VIEW::ModelProcessor.

Reimplemented in BALL::VIEW::AddBallAndStickModel, BALL::VIEW::AddLineModel, and BALL::VIEW::AddVanDerWaalsModel.

std::list<const Atom*>& BALL::VIEW::AtomBondModelBaseProcessor::getAtomList_ ( )

protected

Mutable inspection of the list of used atoms.

HashSet<const Atom*>& BALL::VIEW::AtomBondModelBaseProcessor::getAtomSet_ ( )

protected

Mutable inspection of the hash set of used atoms.

void BALL::VIEW::AtomBondModelBaseProcessor::insertAtom_ ( const Atom * atom )

protected

Insert an Atom into the used atoms structure. All the inserted atoms will be later processed to generate the graphical representation of the Bond objects that can be reached from each inserted atom.

Parameters

atom	the Atom object to inserted

virtual Processor::Result BALL::VIEW::AtomBondModelBaseProcessor::operator() ( Composite & composite )

virtual

Operator method. This method iterates over each Composite object reachable in the Composite tree. If a Composite is of kind Moleculue and has aromatic rings, these rings are stored for later processing in the finish method.

Parameters

composite the Composite object that will be processed

Reimplemented from BALL::UnaryProcessor< Composite >.

Reimplemented in BALL::VIEW::AddBallAndStickModel, BALL::VIEW::HBondModelProcessor, BALL::VIEW::AddLineModel, and BALL::VIEW::AddVanDerWaalsModel.

const AtomBondModelBaseProcessor& BALL::VIEW::AtomBondModelBaseProcessor::operator= ( const AtomBondModelBaseProcessor & processor )

Assignment operator. Calls set.

void BALL::VIEW::AtomBondModelBaseProcessor::set ( const AtomBondModelBaseProcessor & processor )

Assignment. Calls clearUsedAtoms_(). Calls ModelProcessor::set.

virtual void BALL::VIEW::AtomBondModelBaseProcessor::visualiseBond_ ( const Bond & bond )

protectedvirtual

Reimplemented in BALL::VIEW::AddBallAndStickModel, and BALL::VIEW::AddLineModel.

virtual void BALL::VIEW::AtomBondModelBaseProcessor::visualiseRings_ ( )