concepts::Connector Class Referenceabstract
An abstract class for elements of the topology. More...
#include <connector.hh>
 
  
| Public Member Functions | |
| const Attribute & | attrib () const | 
| Returns the attribute of the connector.  More... | |
| virtual const Connector * | child (uint i) const =0 | 
| virtual Connector * | child (uint i, bool mode=0)=0 | 
| Returns the ith child of the connector.  More... | |
| Connector (const uint key, const Attribute attrib) | |
| Constructor.  More... | |
| const Key & | key () const | 
| Returns the key of the connector.  More... | |
| int | operator== (const Connector &cntr) const | 
| Comparison operator.  More... | |
| int | related (const Connector &conn) const | 
| Checks if this connector is related to conn.  More... | |
| void | setAttrib (uint attrb) | 
| Protected Member Functions | |
| virtual std::ostream & | info (std::ostream &os) const | 
| Returns information in an output stream.  More... | |
| Protected Attributes | |
| Attribute | attrib_ | 
| Attribute.  More... | |
| Key | key_ | 
| Unique key of the connector.  More... | |
Detailed Description
An abstract class for elements of the topology.
The topology contains the informations about the inter-element connections.
This class prescribes the common interface for all topological elements (connectors). This interface consists of a method to query the children of a connector.
Definition at line 85 of file connector.hh.
Constructor & Destructor Documentation
◆ Connector()
| 
 | inline | 
Constructor.
Definition at line 88 of file connector.hh.
Member Function Documentation
◆ attrib()
| 
 | inline | 
Returns the attribute of the connector.
Definition at line 108 of file connector.hh.
◆ child() [1/2]
| 
 | pure virtual | 
Implemented in concepts::Vertex, concepts::Sphere, concepts::SphericalSurface, concepts::Connector3, concepts::Connector2, concepts::Connector1, concepts::Connector0, concepts::Hexahedron, concepts::Tetrahedron, concepts::InfiniteQuad, concepts::Quad, concepts::Triangle, concepts::InfiniteEdge, and concepts::Edge.
◆ child() [2/2]
| 
 | pure virtual | 
Returns the ith child of the connector.
- Parameters
- 
  i Index of the child mode If mode = false(0) the child is created if it does not yet exist, if mode = true(1) no new children are created (ie. 0 is returned if no children exist). 
- Invariant
- Either all children or no children exist.
Implemented in concepts::Connector3, concepts::Connector2, concepts::Connector1, concepts::Connector0, concepts::Hexahedron, concepts::Tetrahedron, concepts::InfiniteQuad, concepts::Quad, concepts::Triangle, concepts::InfiniteEdge, concepts::Edge, concepts::Vertex, concepts::Sphere, and concepts::SphericalSurface.
◆ info()
| 
 | protectedvirtual | 
Returns information in an output stream.
Reimplemented from concepts::OutputOperator.
Reimplemented in concepts::Sphere, concepts::SphericalSurface, concepts::Hexahedron, concepts::Tetrahedron, concepts::InfiniteQuad, concepts::Quad, concepts::Triangle, concepts::InfiniteEdge, concepts::Edge, and concepts::Vertex.
◆ key()
| 
 | inline | 
Returns the key of the connector.
Definition at line 105 of file connector.hh.
◆ operator==()
| 
 | inline | 
Comparison operator.
Definition at line 102 of file connector.hh.
◆ related()
| int concepts::Connector::related | ( | const Connector & | conn | ) | const | 
Checks if this connector is related to conn. 
It is being checked if one of the two is an ancestor of the other.
- Parameters
- 
  conn Other connector 
- Returns
- An integer i.
 i=0 if there is no relationship or the connectors are identical
 i>0 ifconnis an ancestor of this connector
 i<0 ifconnis a descendant of this connector
 |i| gives the number of generations between the connectors
◆ setAttrib()
| 
 | inline | 
Definition at line 111 of file connector.hh.
Member Data Documentation
◆ attrib_
| 
 | protected | 
Definition at line 132 of file connector.hh.
◆ key_
| 
 | protected | 
Unique key of the connector.
Definition at line 129 of file connector.hh.
The documentation for this class was generated from the following file:
- geometry/connector.hh

