HydroCouple::Spatial::INetwork Class Reference

The INetwork class. More...

#include <hydrocouplespatial.h>

Inheritance diagram for HydroCouple::Spatial::INetwork:

Collaboration diagram for HydroCouple::Spatial::INetwork:

Public Member Functions
virtual	~INetwork ()=default
	~Network destructor.
virtual int	edgeCount () const =0
	edgeCount represents the number of all the edges in the network.
virtual IEdge *	edge (int index) const =0
	edge
virtual int	vertexCount () const =0
	vertexCount
virtual IVertex *	vertex (int index) const =0
	vertex
Public Member Functions inherited from HydroCouple::IIdentity
virtual	~IIdentity ()=default
	IIdentity::~IIdentity is a virtual destructor.
virtual 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 string	caption () const =0
	Gets caption for the entity.
virtual void	setCaption (const string &caption)=0
	Sets caption for the entity.
virtual string	description () const =0
	Gets additional descriptive information for the entity.
virtual void	setDescription (const 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< string >
virtual	~ISignal ()=default
	ISignal::~ISignal is a virtual destructor.
virtual void	connect (const shared_ptr< ISlot< Args... > > &slot)=0
	connect is used to connect a slot to the signal.
virtual void	disconnect (const 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< string >
virtual void	emit (Args... args)=0
	emit is used to emit the signal.

Detailed Description

The INetwork class.

Constructor & Destructor Documentation

~INetwork()

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

virtualdefault

~Network destructor.

Member Function Documentation

edge()

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

pure virtual

edge

Parameters

index

of the edge in the network.

Returns

The edge at the specified index.

edgeCount()

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

pure virtual

edgeCount represents the number of all the edges in the network.

Returns

Count of all the edges in the network.

vertex()

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

pure virtual

vertex

Parameters

index

of the vertex in the network.

Returns

The vertex at the specified index.

vertexCount()

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

pure virtual

vertexCount

Returns

Number of vertices in the network.

---

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

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