The ITimeNetworkComponentDataItem class. More...

#include <hydrocouplespatiotemporal.h>

Inheritance diagram for HydroCouple::SpatioTemporal::ITimeNetworkComponentDataItem:

Collaboration diagram for HydroCouple::SpatioTemporal::ITimeNetworkComponentDataItem:

Public Member Functions
virtual	~ITimeNetworkComponentDataItem ()=0
	~ITimeNetworkComponentItem. More...

virtual HydroCouple::Spatial::INetwork *	network () const =0
	network associated with this ITimeNetworkComponentItem. More...

virtual HydroCouple::Spatial::MeshDataType	meshDataType () const =0
	meshDataType The mesh data type for the network. More...

virtual IDimension *	edgeDimension () const =0
	edgeDimension The dimension for the edges of the network. More...

virtual IDimension *	nodeDimension () const =0
	nodeDimension The dimension for the nodes of the network. More...

virtual void	getValue (int timeIndex, int edgeDimensionIndex, int nodeDimensionIndex, void *data) const =0
	getValue Gets the value for given time dimension index, edge dimension index and node dimension index. More...

virtual void	setValue (int timeIndex, int edgeDimensionIndex, int nodeDimensionIndex, const void *data)=0
	setValue Sets the value for given time dimension index, edge dimension index and node dimension index. More...

Public Member Functions inherited from HydroCouple::Temporal::ITimeComponentDataItem
virtual	~ITimeComponentDataItem ()=0
	~ITimeComponentItem destructor. More...

virtual list< IDateTime * >	times () const =0
	ITimes associated with this dimension. More...

virtual IDateTime *	time (int timeIndex) const =0
	time More...

virtual int	timeCount () const =0
	timeCount More...

virtual ITimeSpan *	timeSpan () const =0
	ITimeSpan associated with this dimension. More...

virtual IDimension *	timeDimension () const =0
	IDimension of the times. More...

Public Member Functions inherited from HydroCouple::IComponentDataItem
virtual	~IComponentDataItem ()=0
	IComponentDataItem::~IComponentDataItem is a virtual destructor. More...

virtual IModelComponent *	modelComponent () const =0
	Gets the owner IModelComponent of this IComponentItem. For an IOutput component item this is the component responsible for providing the content of the IOutput. More...

virtual vector< IDimension * >	dimensions () const =0
	provides purely descriptive information of the dimensions associated with this IComponentItem More...

virtual int	dimensionLength (const vector< int > &dimensionIndexes) const =0
	dimensionLength returns the length of the dimension specified by the given dimension indexes. To get the size of the first dimension, use a null integer array as input argument. Length of indices must be a least one smaller than the numDimensions() More...

virtual IValueDefinition *	valueDefinition () const =0
	IValueDefinition for this IValueSet defines the variable type associated with this object. More...

virtual void	getValue (const vector< int > &dimensionIndexes, void *data) const =0
	Gets a multi-dimensional array of value for given dimension indexes. IndexArray = x + y * InSizeX + z * InSizeX * InSizeY etc;. More...

virtual void	setValue (const vector< int > &dimensionIndexes, const void *data)=0
	Sets a multi-dimensional array of values for given dimension indexes. More...

virtual bool	hasEditor () const =0
	hasEditor indicates whether this IComponentItem has a UI editor. More...

virtual void	showEditor ()=0
	showEditor shows the editor for this IComponentItem. More...

virtual bool	hasViewer () const =0
	hasViewer indicates whether this IComponentItem has a UI viewer. More...

virtual void	showViewer ()=0
	showViewer 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 ITimeNetworkComponentDataItem class.

Constructor & Destructor Documentation

◆ ~ITimeNetworkComponentDataItem()

virtual HydroCouple::SpatioTemporal::ITimeNetworkComponentDataItem::~ITimeNetworkComponentDataItem ( )

pure virtual

~ITimeNetworkComponentItem.

Member Function Documentation

◆ edgeDimension()

virtual IDimension* HydroCouple::SpatioTemporal::ITimeNetworkComponentDataItem::edgeDimension ( ) const

pure virtual

edgeDimension The dimension for the edges of the network.

Returns: The dimension for the edges of the network.

◆ getValue()

virtual void HydroCouple::SpatioTemporal::ITimeNetworkComponentDataItem::getValue	(	int	timeIndex,
		int	edgeDimensionIndex,
		int	nodeDimensionIndex,
		void *	data
	)		const

pure virtual

getValue Gets the value for given time dimension index, edge dimension index and node dimension index.

Parameters

timeIndex	is the time dimension index from where to obtain the requested data.
edgeDimensionIndex	is the edge dimension index from where to obtain the requested data.
nodeDimensionIndex	is the node dimension index from where to obtain the requested data.
data	is the array where data is to be written. Must be allocated beforehand with the correct data type.

◆ meshDataType()

virtual HydroCouple::Spatial::MeshDataType HydroCouple::SpatioTemporal::ITimeNetworkComponentDataItem::meshDataType ( ) const

pure virtual

meshDataType The mesh data type for the network.

Returns: The mesh data type for the network.

◆ network()

virtual HydroCouple::Spatial::INetwork* HydroCouple::SpatioTemporal::ITimeNetworkComponentDataItem::network ( ) const

pure virtual

network associated with this ITimeNetworkComponentItem.

Returns: The network associated with this ITimeNetworkComponentItem.

◆ nodeDimension()

virtual IDimension* HydroCouple::SpatioTemporal::ITimeNetworkComponentDataItem::nodeDimension ( ) const

pure virtual

nodeDimension The dimension for the nodes of the network.

Returns: The dimension for the nodes of the network.

◆ setValue()

virtual void HydroCouple::SpatioTemporal::ITimeNetworkComponentDataItem::setValue	(	int	timeIndex,
		int	edgeDimensionIndex,
		int	nodeDimensionIndex,
		const void *	data
	)

pure virtual

setValue Sets the value for given time dimension index, edge dimension index and node dimension index.

Parameters

timeIndex	is the time dimension index where data is to be written.
edgeDimensionIndex	is the edge dimension index where data is to be written.
nodeDimensionIndex	is the node dimension index where data is to be written.
data	is the input array to be written.

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

/home/runner/work/HydroCouple/HydroCouple/HydroCouple/include/hydrocouplespatiotemporal.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ITimeNetworkComponentDataItem()

Member Function Documentation

◆ edgeDimension()

◆ getValue()

◆ meshDataType()

◆ network()

◆ nodeDimension()

◆ setValue()