Class documentation of Concepts

Loading...
Searching...
No Matches

#include <connector.hh>

Inheritance diagram for concepts::Connector1:
concepts::Connector concepts::OutputOperator concepts::Edge concepts::InfiniteEdge test::ResetConnector1

Public Member Functions

 Connector1 (Attribute attrib)
 
virtual Connector0vertex (uint i) const =0
 
virtual Connector1child (uint i, bool mode=0)=0
 
virtual const Connector1child (uint i) const =0
 
int operator== (const Connector &cntr) const
 Comparison operator.
 
const Keykey () const
 Returns the key of the connector.
 
const Attributeattrib () const
 Returns the attribute of the connector.
 
void setAttrib (uint attrb)
 
int related (const Connector &conn) const
 

Protected Member Functions

 Connector1 (const Attribute attrib, const Key &key)
 
virtual std::ostream & info (std::ostream &os) const
 Returns information in an output stream.
 

Protected Attributes

Key key_
 Unique key of the connector.
 
Attribute attrib_
 Attribute.
 

Static Protected Attributes

static uint cnt_
 

Detailed Description

A 1D element of the topology. Base class for an edge. 1D elements of the topology are defined by 0D elements, ie. an edge is defined by two vertices.

On this level a unique counter for all 1D connectors is implemented. In addition to the interface prescribed by connector a method to query the 0D components of this connector is declared.

Definition at line 182 of file connector.hh.

Constructor & Destructor Documentation

◆ Connector1() [1/2]

concepts::Connector1::Connector1 ( Attribute  attrib)
inline

Constructor.

Parameters
attribAttribute

Definition at line 188 of file connector.hh.

◆ Connector1() [2/2]

concepts::Connector1::Connector1 ( const Attribute  attrib,
const Key key 
)
inlineprotected

Constructor. Used by the clone function of inherited classes.

Parameters
attribThe attribute
keyThe key

Definition at line 205 of file connector.hh.

Member Function Documentation

◆ attrib()

const Attribute & concepts::Connector::attrib ( ) const
inlineinherited

Returns the attribute of the connector.

Definition at line 108 of file connector.hh.

◆ child() [1/2]

virtual const Connector1 * concepts::Connector1::child ( uint  i) const
pure virtual

Implements concepts::Connector.

◆ child() [2/2]

virtual Connector1 * concepts::Connector1::child ( uint  i,
bool  mode = 0 
)
pure virtual

Returns the ith child of the connector.

Parameters
iIndex of the child
modeIf 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.

Implements concepts::Connector.

Implemented in concepts::Edge, and concepts::InfiniteEdge.

◆ info()

virtual std::ostream & concepts::Connector::info ( std::ostream &  os) const
protectedvirtualinherited

◆ key()

const Key & concepts::Connector::key ( ) const
inlineinherited

Returns the key of the connector.

Definition at line 105 of file connector.hh.

◆ operator==()

int concepts::Connector::operator== ( const Connector cntr) const
inlineinherited

Comparison operator.

Definition at line 102 of file connector.hh.

◆ related()

int concepts::Connector::related ( const Connector conn) const
inherited

Checks if this connector is related to conn. It is being checked if one of the two is an ancestor of the other.

Parameters
connOther connector
Returns
An integer i.
i=0 if there is no relationship or the connectors are identical
i>0 if conn is an ancestor of this connector
i<0 if conn is a descendant of this connector
|i| gives the number of generations between the connectors

◆ setAttrib()

void concepts::Connector::setAttrib ( uint  attrb)
inlineinherited

Definition at line 111 of file connector.hh.

◆ vertex()

virtual Connector0 * concepts::Connector1::vertex ( uint  i) const
pure virtual

Returns a 0D component: vertex A 1D element consists of 0D elements, the vertices can be queried here.

Parameters
iIndex of the vertex

Implemented in concepts::Edge, and concepts::InfiniteEdge.

Member Data Documentation

◆ attrib_

Attribute concepts::Connector::attrib_
protectedinherited

Attribute.

Definition at line 132 of file connector.hh.

◆ cnt_

uint concepts::Connector1::cnt_
staticprotected

Counter for the connectors. This counter is used to create the unique key of the connector.

Definition at line 211 of file connector.hh.

◆ key_

Key concepts::Connector::key_
protectedinherited

Unique key of the connector.

Definition at line 129 of file connector.hh.


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