Flow123d  JS_before_hm-1804-gf2ad740aa
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Edge Class Reference

#include <accessors.hh>

Collaboration diagram for Edge:
Collaboration graph
[legend]

Public Member Functions

 Edge ()
 Default invalid edge accessor constructor. More...
 
 Edge (const Mesh *mesh, unsigned int edge_idx)
 Valid edge accessor constructor. More...
 
SideIter side (const unsigned int i) const
 Gets side iterator of the i -th side. More...
 
bool is_valid () const
 
unsigned int idx () const
 Returns edge global index. More...
 
void inc ()
 Incremental function of the Edge iterator. More...
 
bool operator== (const Edge &other) const
 Comparison operator of the iterator. More...
 
unsigned int n_sides () const
 Returns number of sides aligned with the edge. More...
 

Private Member Functions

const EdgeDataedge_data () const
 Getter for edge data from mesh. More...
 

Private Attributes

const Meshmesh_
 Pointer to the mesh owning the node. More...
 
unsigned int edge_idx_
 Index into Mesh::edges vector. More...
 

Detailed Description

Definition at line 308 of file accessors.hh.

Constructor & Destructor Documentation

◆ Edge() [1/2]

Edge::Edge ( )
inline

Default invalid edge accessor constructor.

Definition at line 154 of file accessors_impl.hh.

◆ Edge() [2/2]

Edge::Edge ( const Mesh mesh,
unsigned int  edge_idx 
)
inline

Valid edge accessor constructor.

Definition at line 159 of file accessors_impl.hh.

Member Function Documentation

◆ edge_data()

const EdgeData * Edge::edge_data ( ) const
inlineprivate

Getter for edge data from mesh.

Definition at line 164 of file accessors_impl.hh.

Here is the caller graph for this function:

◆ idx()

unsigned int Edge::idx ( ) const
inline

Returns edge global index.

Definition at line 326 of file accessors.hh.

◆ inc()

void Edge::inc ( )
inline

Incremental function of the Edge iterator.

Definition at line 332 of file accessors.hh.

◆ is_valid()

bool Edge::is_valid ( ) const
inline

Definition at line 322 of file accessors.hh.

Here is the caller graph for this function:

◆ n_sides()

unsigned int Edge::n_sides ( ) const
inline

Returns number of sides aligned with the edge.

Definition at line 343 of file accessors.hh.

Here is the caller graph for this function:

◆ operator==()

bool Edge::operator== ( const Edge other) const
inline

Comparison operator of the iterator.

Definition at line 338 of file accessors.hh.

◆ side()

SideIter Edge::side ( const unsigned int  i) const
inline

Gets side iterator of the i -th side.

Definition at line 171 of file accessors_impl.hh.

Here is the caller graph for this function:

Member Data Documentation

◆ edge_idx_

unsigned int Edge::edge_idx_
private

Index into Mesh::edges vector.

Definition at line 350 of file accessors.hh.

◆ mesh_

const Mesh* Edge::mesh_
private

Pointer to the mesh owning the node.

Definition at line 348 of file accessors.hh.


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