This class represents an edge used by AIFMesh objects. An AIFEdge natively saves relations with its incident vertices (AIFVertex) and with its incident faces (AIFFace).
More...
#include <AIFEdge.hpp>
This class represents an edge used by AIFMesh objects. An AIFEdge natively saves relations with its incident vertices (AIFVertex) and with its incident faces (AIFFace).
- See also
- AIFVertex
-
AIFFace
Definition at line 48 of file AIFEdge.hpp.
◆ EdgeContainerType
◆ face_type
◆ FaceContainerType
◆ ptr
◆ ptr_edge
◆ ptr_face
◆ ptr_vertex
◆ self
◆ vertex_type
◆ VertexContainerType
◆ AIFEdge() [1/2]
| FEVV::DataStructures::AIF::AIFEdge::AIFEdge |
( |
| ) |
|
|
inlineprivate |
◆ AIFEdge() [2/2]
| FEVV::DataStructures::AIF::AIFEdge::AIFEdge |
( |
const self & |
other | ) |
|
|
inlineprivate |
AIFEdge copy constructor
Be careful, it create a new AIFEdge with the same native
incidence relations.
Definition at line 93 of file AIFEdge.hpp.
◆ get_first_vertex()
| ptr_vertex FEVV::DataStructures::AIF::AIFEdge::get_first_vertex |
( |
| ) |
const |
|
inline |
begin/first vertex getter
- Returns
- The begin/first vertex of the involved edge.
Definition at line 158 of file AIFEdge.hpp.
◆ get_second_vertex()
| ptr_vertex FEVV::DataStructures::AIF::AIFEdge::get_second_vertex |
( |
| ) |
const |
|
inline |
end/second vertex getter
- Returns
- The end/second vertex of the involved edge.
Definition at line 164 of file AIFEdge.hpp.
◆ GetDegree()
| unsigned int FEVV::DataStructures::AIF::AIFEdge::GetDegree |
( |
| ) |
|
|
inline |
Degree getter
- Returns
- The number of incident faces of the involved edge.
Definition at line 150 of file AIFEdge.hpp.
◆ GetIncidentFaces() [1/2]
| boost::iterator_range< FaceContainerType::iterator > FEVV::DataStructures::AIF::AIFEdge::GetIncidentFaces |
( |
| ) |
|
|
inline |
Native incidence relations getter
- Returns
- An iterator range on the incident faces (AIFFace pointer) of the involved edge.
Definition at line 140 of file AIFEdge.hpp.
◆ GetIncidentFaces() [2/2]
| boost::iterator_range< FaceContainerType::const_iterator > FEVV::DataStructures::AIF::AIFEdge::GetIncidentFaces |
( |
| ) |
const |
|
inline |
Native incidence relations getter
- Returns
- An iterator range on the incident faces (AIFFace pointer) of the involved edge.
Definition at line 129 of file AIFEdge.hpp.
◆ GetIncidentVertices()
| boost::iterator_range< VertexContainerType::const_iterator > FEVV::DataStructures::AIF::AIFEdge::GetIncidentVertices |
( |
| ) |
|
|
inline |
Native incidence relations getter
- Returns
- An iterator range on the incident vertices (AIFVertex pointer) of the involved edge.
Definition at line 118 of file AIFEdge.hpp.
◆ GetIndex()
| std::size_t FEVV::DataStructures::AIF::AIFEdge::GetIndex |
( |
| ) |
const |
|
inline |
Index getter
- Returns
- The index of the involved edge.
Definition at line 170 of file AIFEdge.hpp.
◆ New() [1/2]
Static constructor method
- Returns
- A pointer to a new instance of AIFEdge class.
Definition at line 22 of file AIFEdge.inl.
◆ New() [2/2]
Static constructor method
- Parameters
-
- Returns
- A pointer to a new instance of AIFEdge class.
Definition at line 30 of file AIFEdge.inl.
◆ operator!=()
| bool FEVV::DataStructures::AIF::AIFEdge::operator!= |
( |
const self & |
other | ) |
const |
|
inline |
difference operator
- Parameters
-
| other | The second edge to compare with the current one. |
- Returns
- True if the current AIFEdge is different from other one. Else return false;
Definition at line 212 of file AIFEdge.hpp.
◆ operator<()
| bool FEVV::DataStructures::AIF::AIFEdge::operator< |
( |
const self & |
other | ) |
const |
|
inline |
Less operator (natural ordering)
- Parameters
-
| other | The second edge to compare with the current one. |
- Returns
- True if the current AIFEdge is strictly less than the other one. Else return false;
Definition at line 37 of file AIFEdge.inl.
◆ operator<=()
| bool FEVV::DataStructures::AIF::AIFEdge::operator<= |
( |
const self & |
other | ) |
const |
|
inline |
Less or equals operator
- Parameters
-
| other | The second edge to compare with the current one. |
- Returns
- True if the current AIFEdge is less or equal to other one. Else return false;
Definition at line 219 of file AIFEdge.hpp.
◆ operator==()
| bool FEVV::DataStructures::AIF::AIFEdge::operator== |
( |
const self & |
other | ) |
const |
|
inline |
equality operator
- Parameters
-
| other | The second edge to compare with the current one. |
- Returns
- True if the current AIFEdge is equal to other one. Else return false;
Definition at line 46 of file AIFEdge.inl.
◆ operator>()
| bool FEVV::DataStructures::AIF::AIFEdge::operator> |
( |
const self & |
other | ) |
const |
|
inline |
Greater operator
- Parameters
-
| other | The second edge to compare with the current one. |
- Returns
- True if the current AIFEdge is strictly greater to other one. Else return false;
Definition at line 236 of file AIFEdge.hpp.
◆ operator>=()
| bool FEVV::DataStructures::AIF::AIFEdge::operator>= |
( |
const self & |
other | ) |
const |
|
inline |
Greater or equals operator
- Parameters
-
| other | The second edge to compare with the current one. |
- Returns
- True if the current AIFEdge is greater or equal to other one. Else return false;
Definition at line 229 of file AIFEdge.hpp.
◆ Print()
| void FEVV::DataStructures::AIF::AIFEdge::Print |
( |
| ) |
const |
|
inline |
Print the textual description of the involved edge on the
standard output.
Definition at line 53 of file AIFEdge.inl.
◆ set_first_vertex()
| void FEVV::DataStructures::AIF::AIFEdge::set_first_vertex |
( |
ptr_vertex |
V1 | ) |
|
|
inline |
First vertex setter
- Parameters
-
| v1 | The new first vertex of the involved edge. |
Definition at line 180 of file AIFEdge.hpp.
◆ set_second_vertex()
| void FEVV::DataStructures::AIF::AIFEdge::set_second_vertex |
( |
ptr_vertex |
V2 | ) |
|
|
inline |
Second vertex setter
- Parameters
-
| v2 | The new second vertex of the involved edge. |
Definition at line 185 of file AIFEdge.hpp.
◆ SetIndex()
| void FEVV::DataStructures::AIF::AIFEdge::SetIndex |
( |
std::size_t |
idx | ) |
|
|
inline |
Index setter
- Parameters
-
| The | index of the involved edge. |
Definition at line 175 of file AIFEdge.hpp.
◆ AIFEdgeComparator
◆ AIFTopologyHelpers
◆ m_incident_PtrFaces
◆ m_incident_vertices
◆ m_Index
| std::size_t FEVV::DataStructures::AIF::AIFEdge::m_Index |
|
private |
The documentation for this class was generated from the following files:
- /Users/mac/builds/efd823a3/0/MEPP-team/MEPP2/FEVV/DataStructures/AIF/AIFEdge.hpp
- /Users/mac/builds/efd823a3/0/MEPP-team/MEPP2/FEVV/DataStructures/AIF/AIFEdge.inl
