HydroCouple
2.0.0
HydroCouple Interface Definitions
|
The INetworkComponentDataItem class. More...
#include <hydrocouplespatial.h>
Public Member Functions | |
virtual | ~INetworkComponentDataItem ()=0 |
virtual INetwork * | network () const =0 |
network associated with this INetworkComponentDataItem. More... | |
virtual MeshDataType | meshDataType () const =0 |
meshDataType represents the type of mesh data. More... | |
virtual IDimension * | edgeDimension () const =0 |
edgeDimension represents the dimension for the edges. More... | |
virtual IDimension * | nodeDimension () const =0 |
nodeDimension represents the dimension for the nodes. More... | |
virtual void | getValue (int edgeDimensionIndex, int nodeDimensionIndex, void *data) const =0 |
getValue for given edge dimension index and node dimension index. More... | |
virtual void | setValue (int edgeDimensionIndex, int nodeDimensionIndex, const void *data)=0 |
setValue for given edge dimension index and node dimension index. 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... | |
The INetworkComponentDataItem class.
|
pure virtual |
|
pure virtual |
edgeDimension represents the dimension for the edges.
|
pure virtual |
getValue for given edge dimension index and node dimension index.
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 a pointer to data that is to be written. Must be allocated beforehand with the correct data type. |
|
pure virtual |
meshDataType represents the type of mesh data.
|
pure virtual |
network associated with this INetworkComponentDataItem.
|
pure virtual |
nodeDimension represents the dimension for the nodes.
|
pure virtual |
setValue for given edge dimension index and node dimension index.
edgeDimensionIndex | is the edge dimension index from where to write data. |
nodeDimensionIndex | is the node dimension index from where to write data. |
data | is a pointer data thata to is to be copied |