HydroCouple::Spatial::INetwork Class Reference

INetwork represents a graph structure of connected vertices and edges. More...

#include <hydrocouplespatial.h>

Inheritance diagram for HydroCouple::Spatial::INetwork:

Collaboration diagram for HydroCouple::Spatial::INetwork:

Public Member Functions
virtual	~INetwork ()=default
	INetwork destructor.
virtual int64_t	edgeCount () const =0
	The number of edges in the network.
virtual IEdge *	edge (int64_t index) const =0
	The IEdge at the specified index.
virtual int64_t	vertexCount () const =0
	The number of vertices in the network.
virtual IVertex *	vertex (int64_t index) const =0
	The IVertex at the specified index.
virtual const IMeshView *	meshView () const =0
	Bulk structure-of-arrays view of this network's geometry and connectivity.
Public Member Functions inherited from HydroCouple::IIdentity
virtual	~IIdentity ()=default
	IIdentity::~IIdentity is a virtual destructor.
virtual const std::string &	id () const =0
	Gets a unique identifier for the entity.
Public Member Functions inherited from HydroCouple::IDescription
virtual	~IDescription ()=default
	IDescription::~IDescription is a virtual destructor.
virtual const std::string &	caption () const =0
	Gets caption for the entity.
virtual void	setCaption (const std::string &caption)=0
	Sets caption for the entity.
virtual const std::string &	description () const =0
	Gets additional descriptive information for the entity.
virtual void	setDescription (const std::string &description)=0
	Gets additional descriptive information for the entity.
Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual	~IPropertyChanged ()=default
	IPropertyChanged::~IPropertyChanged is a virtual destructor.
Public Member Functions inherited from HydroCouple::ISignal< std::string >
virtual	~ISignal ()=default
	ISignal::~ISignal is a virtual destructor.
virtual void	connect (const std::shared_ptr< ISlot< Args... > > &slot)=0
	connect is used to connect a slot to the signal.
virtual void	disconnect (const std::shared_ptr< ISlot< Args... > > &slot)=0
	disconnect is used to disconnect a slot from the signal.
virtual void	blockSignals (bool block)=0
	blockSignals is used to block signals from being emitted.

Additional Inherited Members
Protected Member Functions inherited from HydroCouple::ISignal< std::string >
virtual void	emit (Args... args)=0
	emit is used to emit the signal.

Detailed Description

INetwork represents a graph structure of connected vertices and edges.

Constructor & Destructor Documentation

~INetwork()

virtual HydroCouple::Spatial::INetwork::~INetwork ( )

virtualdefault

INetwork destructor.

Member Function Documentation

edge()

virtual IEdge * HydroCouple::Spatial::INetwork::edge ( int64_t index ) const

nodiscardpure virtual

The IEdge at the specified index.

Parameters

[in]

index

of the edge to retrieve.

edgeCount()

virtual int64_t HydroCouple::Spatial::INetwork::edgeCount ( ) const

nodiscardpure virtual

The number of edges in the network.

meshView()

virtual const IMeshView * HydroCouple::Spatial::INetwork::meshView ( ) const

nodiscardpure virtual

Bulk structure-of-arrays view of this network's geometry and connectivity.

This is the accessor partitioners, interpolating adapters, IO writers, and device staging must use; the per-entity object accessors above are a convenience for spot queries and editing.

Returns

The IMeshView over this network; never nullptr.

vertex()

virtual IVertex * HydroCouple::Spatial::INetwork::vertex ( int64_t index ) const

nodiscardpure virtual

The IVertex at the specified index.

Parameters

[in]

index

of the vertex to retrieve.

vertexCount()

virtual int64_t HydroCouple::Spatial::INetwork::vertexCount ( ) const

nodiscardpure virtual

The number of vertices in the network.

---

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

• /home/runner/work/HydroCouple/HydroCouple/include/hydrocouplespatial.h