Version: 8.3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
XAO::Geometry Class Referenceabstract

Base class for geometries.

#include <XAO_Geometry.hxx>

Inheritance diagram for XAO::Geometry:
Inheritance graph

Static Public Member Functions

static GeometrycreateGeometry (const XAO::Format &format) throw (XAO_Exception)
 Creates a geometry. More...
 

Protected Member Functions

 Geometry (const std::string &name)
 Constructor. More...
 

name the name of the geometry.

Constructor.

Creates a geometry.

Returns
the created geometry.
std::string m_name
 
GeometricElementList m_vertices
 
GeometricElementList m_edges
 
GeometricElementList m_faces
 
GeometricElementList m_solids
 
bool m_readOnly
 
void checkReadOnly () throw (XAO_Exception)
 
static GeometrycreateGeometry (const XAO::Format &format, const std::string &name) throw (XAO_Exception)
 
virtual ~Geometry ()
 Destructor. More...
 
const std::string getName ()
 Gets the name of the geometry. More...
 
void setName (const std::string &name)
 Sets the name of the geometry. More...
 
virtual const XAO::Format getFormat ()=0
 Gets the format of the geometry. More...
 
virtual const std::string getShapeString ()=0
 
virtual void setShapeString (const std::string &shape)=0
 
virtual void writeShapeFile (const std::string &fileName)=0
 
virtual void readShapeFile (const std::string &fileName)=0
 
const int countElements (const XAO::Dimension &dim) const throw (XAO_Exception)
 
const int countVertices () const
 
const int countEdges () const
 
const int countFaces () const
 
const int countSolids () const
 
void setCountVertices (const int &nb) throw (XAO_Exception)
 
void setCountEdges (const int &nb) throw (XAO_Exception)
 
void setCountFaces (const int &nb) throw (XAO_Exception)
 
void setCountSolids (const int &nb) throw (XAO_Exception)
 
const std::string getVertexName (const int &index) throw (XAO_Exception)
 
const std::string getEdgeName (const int &index) throw (XAO_Exception)
 
const std::string getFaceName (const int &index) throw (XAO_Exception)
 
const std::string getSolidName (const int &index) throw (XAO_Exception)
 
void setVertexName (const int &index, const std::string &name) throw (XAO_Exception)
 
void setEdgeName (const int &index, const std::string &name) throw (XAO_Exception)
 
void setFaceName (const int &index, const std::string &name) throw (XAO_Exception)
 
void setSolidName (const int &index, const std::string &name) throw (XAO_Exception)
 
const bool hasVertexName (const int &index) throw (XAO_Exception)
 
const bool hasEdgeName (const int &index) throw (XAO_Exception)
 
const bool hasFaceName (const int &index) throw (XAO_Exception)
 
const bool hasSolidName (const int &index) throw (XAO_Exception)
 
const std::string getVertexReference (const int &index) throw (XAO_Exception)
 
const std::string getEdgeReference (const int &index) throw (XAO_Exception)
 
const std::string getFaceReference (const int &index) throw (XAO_Exception)
 
const std::string getSolidReference (const int &index) throw (XAO_Exception)
 
const std::string getElementReference (const XAO::Dimension &dim, const int &index) throw (XAO_Exception)
 
void setVertexReference (const int &index, const std::string &reference) throw (XAO_Exception)
 
void setEdgeReference (const int &index, const std::string &reference) throw (XAO_Exception)
 
void setFaceReference (const int &index, const std::string &reference) throw (XAO_Exception)
 
void setSolidReference (const int &index, const std::string &reference) throw (XAO_Exception)
 
void setVertex (const int &index, const std::string &name, const std::string &reference) throw (XAO_Exception)
 
void setEdge (const int &index, const std::string &name, const std::string &reference) throw (XAO_Exception)
 
void setFace (const int &index, const std::string &name, const std::string &reference) throw (XAO_Exception)
 
void setSolid (const int &index, const std::string &name, const std::string &reference) throw (XAO_Exception)
 
const int getVertexIndexByReference (const std::string &reference)
 
const int getEdgeIndexByReference (const std::string &reference)
 
const int getFaceIndexByReference (const std::string &reference)
 
const int getSolidIndexByReference (const std::string &reference)
 
const int getElementIndexByReference (const XAO::Dimension &dim, const std::string &reference) throw (XAO_Exception)
 
GeometricElementList::iterator begin (const XAO::Dimension &dim) throw (XAO_Exception)
 
GeometricElementList::iterator end (const XAO::Dimension &dim) throw (XAO_Exception)
 
bool isReadOnly ()
 Verifies if the geometry is read only. More...
 
void setReadOnly ()
 Sets the geometry read only. More...
 

Constructor & Destructor Documentation

Geometry::Geometry ( const std::string &  name)
protected
Parameters
namethe name of the Geometry.

References m_readOnly.

Geometry::~Geometry ( )
virtual

Member Function Documentation

GeometricElementList::iterator Geometry::begin ( const XAO::Dimension dim) throw (XAO_Exception)
void Geometry::checkReadOnly ( ) throw (XAO_Exception)
protected

References m_readOnly.

const int XAO::Geometry::countEdges ( ) const
inline
const int Geometry::countElements ( const XAO::Dimension dim) const throw (XAO_Exception)
const int XAO::Geometry::countFaces ( ) const
inline
const int XAO::Geometry::countSolids ( ) const
inline
const int XAO::Geometry::countVertices ( ) const
inline
Geometry * Geometry::createGeometry ( const XAO::Format format) throw (XAO_Exception)
static
Parameters
formatthe format of the geometry.
Returns
the created geometry.
Geometry * Geometry::createGeometry ( const XAO::Format format,
const std::string &  name 
) throw (XAO_Exception)
static

References XAO::BREP.

GeometricElementList::iterator Geometry::end ( const XAO::Dimension dim) throw (XAO_Exception)
const int XAO::Geometry::getEdgeIndexByReference ( const std::string &  reference)
inline
const std::string XAO::Geometry::getEdgeName ( const int &  index) throw (XAO_Exception)
inline
const std::string XAO::Geometry::getEdgeReference ( const int &  index) throw (XAO_Exception)
inline
const int Geometry::getElementIndexByReference ( const XAO::Dimension dim,
const std::string &  reference 
) throw (XAO_Exception)
const std::string Geometry::getElementReference ( const XAO::Dimension dim,
const int &  index 
) throw (XAO_Exception)
const int XAO::Geometry::getFaceIndexByReference ( const std::string &  reference)
inline
const std::string XAO::Geometry::getFaceName ( const int &  index) throw (XAO_Exception)
inline
const std::string XAO::Geometry::getFaceReference ( const int &  index) throw (XAO_Exception)
inline
virtual const XAO::Format XAO::Geometry::getFormat ( )
pure virtual
Returns
the format of the geometry.

Implemented in XAO::BrepGeometry.

const std::string XAO::Geometry::getName ( )
inline
Returns
the name of the geometry.
virtual const std::string XAO::Geometry::getShapeString ( )
pure virtual

Implemented in XAO::BrepGeometry.

const int XAO::Geometry::getSolidIndexByReference ( const std::string &  reference)
inline
const std::string XAO::Geometry::getSolidName ( const int &  index) throw (XAO_Exception)
inline
const std::string XAO::Geometry::getSolidReference ( const int &  index) throw (XAO_Exception)
inline
const int XAO::Geometry::getVertexIndexByReference ( const std::string &  reference)
inline
const std::string XAO::Geometry::getVertexName ( const int &  index) throw (XAO_Exception)
inline
const std::string XAO::Geometry::getVertexReference ( const int &  index) throw (XAO_Exception)
inline
const bool XAO::Geometry::hasEdgeName ( const int &  index) throw (XAO_Exception)
inline
const bool XAO::Geometry::hasFaceName ( const int &  index) throw (XAO_Exception)
inline
const bool XAO::Geometry::hasSolidName ( const int &  index) throw (XAO_Exception)
inline
const bool XAO::Geometry::hasVertexName ( const int &  index) throw (XAO_Exception)
inline
bool XAO::Geometry::isReadOnly ( )
inline
Returns
true if the geometry is read only.
virtual void XAO::Geometry::readShapeFile ( const std::string &  fileName)
pure virtual

Implemented in XAO::BrepGeometry.

void Geometry::setCountEdges ( const int &  nb) throw (XAO_Exception)
void Geometry::setCountFaces ( const int &  nb) throw (XAO_Exception)
void Geometry::setCountSolids ( const int &  nb) throw (XAO_Exception)
void Geometry::setCountVertices ( const int &  nb) throw (XAO_Exception)
void Geometry::setEdge ( const int &  index,
const std::string &  name,
const std::string &  reference 
) throw (XAO_Exception)
void XAO::Geometry::setEdgeName ( const int &  index,
const std::string &  name 
) throw (XAO_Exception)
inline
void Geometry::setEdgeReference ( const int &  index,
const std::string &  reference 
) throw (XAO_Exception)
void Geometry::setFace ( const int &  index,
const std::string &  name,
const std::string &  reference 
) throw (XAO_Exception)
void XAO::Geometry::setFaceName ( const int &  index,
const std::string &  name 
) throw (XAO_Exception)
inline
void Geometry::setFaceReference ( const int &  index,
const std::string &  reference 
) throw (XAO_Exception)
void XAO::Geometry::setName ( const std::string &  name)
inline
Parameters
namethe name to set.
void XAO::Geometry::setReadOnly ( )
inline
virtual void XAO::Geometry::setShapeString ( const std::string &  shape)
pure virtual

Implemented in XAO::BrepGeometry.

void Geometry::setSolid ( const int &  index,
const std::string &  name,
const std::string &  reference 
) throw (XAO_Exception)
void XAO::Geometry::setSolidName ( const int &  index,
const std::string &  name 
) throw (XAO_Exception)
inline
void Geometry::setSolidReference ( const int &  index,
const std::string &  reference 
) throw (XAO_Exception)
void Geometry::setVertex ( const int &  index,
const std::string &  name,
const std::string &  reference 
) throw (XAO_Exception)
void XAO::Geometry::setVertexName ( const int &  index,
const std::string &  name 
) throw (XAO_Exception)
inline
void Geometry::setVertexReference ( const int &  index,
const std::string &  reference 
) throw (XAO_Exception)
virtual void XAO::Geometry::writeShapeFile ( const std::string &  fileName)
pure virtual

Implemented in XAO::BrepGeometry.

Member Data Documentation

GeometricElementList XAO::Geometry::m_edges
protected
GeometricElementList XAO::Geometry::m_faces
protected
std::string XAO::Geometry::m_name
protected
bool XAO::Geometry::m_readOnly
protected
GeometricElementList XAO::Geometry::m_solids
protected
GeometricElementList XAO::Geometry::m_vertices
protected

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