Structure Class Reference

Pure virtual class that represent an element of the structure. More...

#include <Structure.h>

Inheritance diagram for Structure:

Public Member Functions
void	addStructuralComponent (StructuralComponent *)
	add a particular StructuralComponent in the list More...
std::vector < StructuralComponent * >	getAllStructuralComponents ()
	get the list of all the StructuralComponent that are using this structure More...
unsigned int	getIndex () const
	get the structure unique index (stored in its property) More...
std::string	getName () const
	get the name of the structure More...
unsigned int	getNumberOfStructuralComponents () const
	get the number of StructuralComponent that are using this structure More...
StructuralComponent *	getStructuralComponent (unsigned int i)
	get a particular StructuralComponent that is using this structure More...
StructureProperties::GeometricType	getType () const
	get the type of index More...
virtual bool	isInstanceOf (const char *) const =0
	pure virtual method, implemented in the child-class More...
void	removeStructuralComponent (StructuralComponent *)
	remove a particular StructuralComponent from the list More...
virtual bool	setIndex (const unsigned int)
	set the index. More...
void	setName (std::string)
	set the name of the structure More...
virtual void	setPhysicalModel (PhysicalModel *)
	set the physical model More...
	Structure ()
	Base constructor. More...
virtual void	xmlPrint (std::ostream &, const StructuralComponent *)=0
	print to an output stream in "pseaudo" XML format. More...
virtual	~Structure ()
	Virtual destructor needed here as this is an abstract class (pure virtual) More...

Protected Attributes
StructureProperties *	properties
	Property of the current structure. More...

Private Attributes
std::vector < StructuralComponent * >	mySCs
	list of StructuralComponent that are using this structure More...

Detailed Description

Pure virtual class that represent an element of the structure.

This implies that every structure could be represented in 3D and is a part of a structural component.

Constructor & Destructor Documentation

Structure::Structure ( )

inline

Base constructor.

virtual Structure::~Structure ( )

inlinevirtual

Virtual destructor needed here as this is an abstract class (pure virtual)

Member Function Documentation

void Structure::addStructuralComponent ( StructuralComponent *  sc )

inline

add a particular StructuralComponent in the list

References mySCs.

Referenced by StructuralComponent::addStructure().

std::vector< StructuralComponent * > Structure::getAllStructuralComponents ( )

inline

get the list of all the StructuralComponent that are using this structure

References mySCs.

unsigned int Structure::getIndex

(

)

const

get the structure unique index (stored in its property)

Referenced by PhysicalModel::getAtom().

std::string Structure::getName

(

)

const

get the name of the structure

unsigned int Structure::getNumberOfStructuralComponents ( ) const

inline

get the number of StructuralComponent that are using this structure

References mySCs.

StructuralComponent * Structure::getStructuralComponent ( unsigned int  i )

inline

get a particular StructuralComponent that is using this structure

References mySCs.

StructureProperties::GeometricType Structure::getType

(

)

const

get the type of index

virtual bool Structure::isInstanceOf ( const char *  ) const

pure virtual

pure virtual method, implemented in the child-class

Implemented in Atom, and Cell.

void Structure::removeStructuralComponent ( StructuralComponent *  sc )

inline

remove a particular StructuralComponent from the list

References mySCs.

Referenced by StructuralComponent::removeStructure().

virtual bool Structure::setIndex ( const unsigned  int )

virtual

set the index.

The index have to be unique otherwise this method has no effect. The sub-classes method will check that this index is not in use.

Returns

true only if the index of the structure was changed

Reimplemented in Cell, and Atom.

void Structure::setName

(

std::string

)

set the name of the structure

virtual void Structure::setPhysicalModel ( PhysicalModel *  )

virtual

set the physical model

virtual void Structure::xmlPrint ( std::ostream &  , const StructuralComponent *    )

pure virtual

print to an output stream in "pseaudo" XML format.

this method is called by the structural component that includes this structure.

Implemented in Atom, and Cell.

Member Data Documentation

std::vector<StructuralComponent *> Structure::mySCs

private

list of StructuralComponent that are using this structure

Referenced by addStructuralComponent(), getAllStructuralComponents(), getNumberOfStructuralComponents(), getStructuralComponent(), and removeStructuralComponent().

StructureProperties* Structure::properties

protected

Property of the current structure.

Referenced by Atom::getProperties().

---

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

• Structure.h