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 ()=0
	~Network destructor. More...
virtual int	edgeCount () const =0
	edgeCount represents the number of all the edges in the network. More...
virtual IEdge *	edge (int index) const =0
	edge More...
virtual int	vertexCount () const =0
	vertexCount More...
virtual IVertex *	vertex (int index) const =0
	vertex More...
Public Member Functions inherited from HydroCouple::IIdentity
virtual	~IIdentity ()=0
	IIdentity::~IIdentity is a virtual destructor. More...
virtual string	id () const =0
	Gets a unique identifier for the entity. More...
Public Member Functions inherited from HydroCouple::IDescription
virtual	~IDescription ()=0
	IDescription::~IDescription is a virtual destructor. More...
virtual string	caption () const =0
	Gets caption for the entity. More...
virtual void	setCaption (const string &caption)=0
	Sets caption for the entity. More...
virtual string	description () const =0
	Gets additional descriptive information for the entity. More...
virtual void	setDescription (const string &description)=0
	Gets additional descriptive information for the entity. More...
Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual	~IPropertyChanged ()=0
	IPropertyChanged::~IPropertyChanged is a virtual destructor. More...
virtual void	registerPropertyChangedListener (const function< void(const any &, const string &)> &propertyChangedListener)=0
	IPropertyChanged::registerPropertyChangedListener() registers a listener to be called when a property of an object changes. More...
virtual void	deRegisterPropertyChangedListener (const function< void(const any &, const string &propertyName)> &propertyChangedListener)=0
	IPropertyChanged::deRegisterPropertyChangedListener() deregisters a listener that is called when a property of an object changes. More...

Detailed Description

The INetwork class.

Constructor & Destructor Documentation

~INetwork()

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

pure virtual

~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