Class documentation of Concepts

Loading...
Searching...
No Matches

#include <connector.hh>

Public Member Functions

 Key (uint key=0)
 Default constructor.
 
int operator== (const Key &key) const
 Comparison operator.
 
 operator uint () const
 Returns the key.
 
uint key () const
 Returns the key.
 

Static Public Member Functions

static uint noKey ()
 Returns a key which never occurs.
 

Friends

std::ostream & operator<< (std::ostream &os, const Key &k)
 

Detailed Description

Key class. Used for the enumeration of topological elements (connectors). It might be usefull to have topological elements with a key with more features...

Definition at line 53 of file connector.hh.

Constructor & Destructor Documentation

◆ Key()

concepts::Key::Key ( uint  key = 0)
inline

Default constructor.

Definition at line 57 of file connector.hh.

Member Function Documentation

◆ key()

uint concepts::Key::key ( ) const
inline

Returns the key.

Definition at line 66 of file connector.hh.

◆ noKey()

static uint concepts::Key::noKey ( )
inlinestatic

Returns a key which never occurs.

Definition at line 69 of file connector.hh.

◆ operator uint()

concepts::Key::operator uint ( ) const
inline

Returns the key.

Definition at line 63 of file connector.hh.

◆ operator==()

int concepts::Key::operator== ( const Key key) const
inline

Comparison operator.

Definition at line 60 of file connector.hh.


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