Version: 9.12.0
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 (XAO::Format format)
 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 ()
 
static GeometrycreateGeometry (XAO::Format format, const std::string &name)
 
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 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
 
int countElements (XAO::Dimension dim) const
 
int countVertices () const
 
int countEdges () const
 
int countFaces () const
 
int countSolids () const
 
void setCountVertices (int nb)
 
void setCountEdges (int nb)
 
void setCountFaces (int nb)
 
void setCountSolids (int nb)
 
const std::string getVertexName (int index)
 
const std::string getEdgeName (int index)
 
const std::string getFaceName (int index)
 
const std::string getSolidName (int index)
 
void setVertexName (int index, const std::string &name)
 
void setEdgeName (int index, const std::string &name)
 
void setFaceName (int index, const std::string &name)
 
void setSolidName (int index, const std::string &name)
 
bool hasVertexName (int index)
 
bool hasEdgeName (int index)
 
bool hasFaceName (int index)
 
bool hasSolidName (int index)
 
const std::string getVertexReference (int index)
 
const std::string getEdgeReference (int index)
 
const std::string getFaceReference (int index)
 
const std::string getSolidReference (int index)
 
const std::string getElementReference (XAO::Dimension dim, int index)
 
void setVertexReference (int index, const std::string &reference)
 
void setEdgeReference (int index, const std::string &reference)
 
void setFaceReference (int index, const std::string &reference)
 
void setSolidReference (int index, const std::string &reference)
 
void setVertex (int index, const std::string &name, const std::string &reference)
 
void setEdge (int index, const std::string &name, const std::string &reference)
 
void setFace (int index, const std::string &name, const std::string &reference)
 
void setSolid (int index, const std::string &name, const std::string &reference)
 
int getVertexIndexByReference (const std::string &reference)
 
int getEdgeIndexByReference (const std::string &reference)
 
int getFaceIndexByReference (const std::string &reference)
 
int getSolidIndexByReference (const std::string &reference)
 
int getElementIndexByReference (XAO::Dimension dim, const std::string &reference)
 
GeometricElementList::iterator begin (XAO::Dimension dim)
 
GeometricElementList::iterator end (XAO::Dimension dim)
 
bool isReadOnly ()
 Verifies if the geometry is read only. More...
 
void setReadOnly ()
 Sets the geometry read only. More...
 

Constructor & Destructor Documentation

◆ Geometry()

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

References m_readOnly.

◆ ~Geometry()

Geometry::~Geometry ( )
virtual

Member Function Documentation

◆ begin()

◆ checkReadOnly()

void Geometry::checkReadOnly ( )
protected

References m_readOnly.

◆ countEdges()

int XAO::Geometry::countEdges ( ) const
inline

◆ countElements()

int Geometry::countElements ( XAO::Dimension  dim) const

◆ countFaces()

int XAO::Geometry::countFaces ( ) const
inline

◆ countSolids()

int XAO::Geometry::countSolids ( ) const
inline

◆ countVertices()

int XAO::Geometry::countVertices ( ) const
inline

◆ createGeometry() [1/2]

Geometry * Geometry::createGeometry ( XAO::Format  format)
static
Parameters
formatthe format of the geometry.
Returns
the created geometry.

◆ createGeometry() [2/2]

Geometry * Geometry::createGeometry ( XAO::Format  format,
const std::string &  name 
)
static

References XAO::BREP.

◆ end()

◆ getEdgeIndexByReference()

int XAO::Geometry::getEdgeIndexByReference ( const std::string &  reference)
inline

◆ getEdgeName()

const std::string XAO::Geometry::getEdgeName ( int  index)
inline

◆ getEdgeReference()

const std::string XAO::Geometry::getEdgeReference ( int  index)
inline

◆ getElementIndexByReference()

int Geometry::getElementIndexByReference ( XAO::Dimension  dim,
const std::string &  reference 
)

◆ getElementReference()

const std::string Geometry::getElementReference ( XAO::Dimension  dim,
int  index 
)

◆ getFaceIndexByReference()

int XAO::Geometry::getFaceIndexByReference ( const std::string &  reference)
inline

◆ getFaceName()

const std::string XAO::Geometry::getFaceName ( int  index)
inline

◆ getFaceReference()

const std::string XAO::Geometry::getFaceReference ( int  index)
inline

◆ getFormat()

virtual XAO::Format XAO::Geometry::getFormat ( )
pure virtual
Returns
the format of the geometry.

Implemented in XAO::BrepGeometry.

◆ getName()

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

◆ getShapeString()

virtual const std::string XAO::Geometry::getShapeString ( )
pure virtual

Implemented in XAO::BrepGeometry.

◆ getSolidIndexByReference()

int XAO::Geometry::getSolidIndexByReference ( const std::string &  reference)
inline

◆ getSolidName()

const std::string XAO::Geometry::getSolidName ( int  index)
inline

◆ getSolidReference()

const std::string XAO::Geometry::getSolidReference ( int  index)
inline

◆ getVertexIndexByReference()

int XAO::Geometry::getVertexIndexByReference ( const std::string &  reference)
inline

◆ getVertexName()

const std::string XAO::Geometry::getVertexName ( int  index)
inline

◆ getVertexReference()

const std::string XAO::Geometry::getVertexReference ( int  index)
inline

◆ hasEdgeName()

bool XAO::Geometry::hasEdgeName ( int  index)
inline

◆ hasFaceName()

bool XAO::Geometry::hasFaceName ( int  index)
inline

◆ hasSolidName()

bool XAO::Geometry::hasSolidName ( int  index)
inline

◆ hasVertexName()

bool XAO::Geometry::hasVertexName ( int  index)
inline

◆ isReadOnly()

bool XAO::Geometry::isReadOnly ( )
inline
Returns
true if the geometry is read only.

◆ readShapeFile()

virtual void XAO::Geometry::readShapeFile ( const std::string &  fileName)
pure virtual

Implemented in XAO::BrepGeometry.

◆ setCountEdges()

void Geometry::setCountEdges ( int  nb)

◆ setCountFaces()

void Geometry::setCountFaces ( int  nb)

◆ setCountSolids()

void Geometry::setCountSolids ( int  nb)

◆ setCountVertices()

void Geometry::setCountVertices ( int  nb)

◆ setEdge()

void Geometry::setEdge ( int  index,
const std::string &  name,
const std::string &  reference 
)

◆ setEdgeName()

void XAO::Geometry::setEdgeName ( int  index,
const std::string &  name 
)
inline

◆ setEdgeReference()

void Geometry::setEdgeReference ( int  index,
const std::string &  reference 
)

◆ setFace()

void Geometry::setFace ( int  index,
const std::string &  name,
const std::string &  reference 
)

◆ setFaceName()

void XAO::Geometry::setFaceName ( int  index,
const std::string &  name 
)
inline

◆ setFaceReference()

void Geometry::setFaceReference ( int  index,
const std::string &  reference 
)

◆ setName()

void XAO::Geometry::setName ( const std::string &  name)
inline
Parameters
namethe name to set.

◆ setReadOnly()

void XAO::Geometry::setReadOnly ( )
inline

◆ setShapeString()

virtual void XAO::Geometry::setShapeString ( const std::string &  shape)
pure virtual

Implemented in XAO::BrepGeometry.

◆ setSolid()

void Geometry::setSolid ( int  index,
const std::string &  name,
const std::string &  reference 
)

◆ setSolidName()

void XAO::Geometry::setSolidName ( int  index,
const std::string &  name 
)
inline

◆ setSolidReference()

void Geometry::setSolidReference ( int  index,
const std::string &  reference 
)

◆ setVertex()

void Geometry::setVertex ( int  index,
const std::string &  name,
const std::string &  reference 
)

◆ setVertexName()

void XAO::Geometry::setVertexName ( int  index,
const std::string &  name 
)
inline

◆ setVertexReference()

void Geometry::setVertexReference ( int  index,
const std::string &  reference 
)

◆ writeShapeFile()

virtual void XAO::Geometry::writeShapeFile ( const std::string &  fileName)
pure virtual

Implemented in XAO::BrepGeometry.

Member Data Documentation

◆ m_edges

GeometricElementList XAO::Geometry::m_edges
protected

◆ m_faces

GeometricElementList XAO::Geometry::m_faces
protected

◆ m_name

std::string XAO::Geometry::m_name
protected

◆ m_readOnly

bool XAO::Geometry::m_readOnly
protected

◆ m_solids

GeometricElementList XAO::Geometry::m_solids
protected

◆ m_vertices

GeometricElementList XAO::Geometry::m_vertices
protected

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