HydroCouple  2.0.0
HydroCouple Interface Definitions
HydroCouple::Spatial::ITINComponentDataItem Class Referenceabstract

ITINComponentDataItem represents ITIN IComponentDataItem. More...

#include <hydrocouplespatial.h>

Inheritance diagram for HydroCouple::Spatial::ITINComponentDataItem:
Collaboration diagram for HydroCouple::Spatial::ITINComponentDataItem:

Public Member Functions

virtual ~ITINComponentDataItem ()=0
 ITINComponentDataItem destructor. More...
 
virtual ITINTIN () const =0
 
- Public Member Functions inherited from HydroCouple::IComponentDataItem
virtual ~IComponentDataItem ()=0
 IComponentDataItem::~IComponentDataItem is a virtual destructor. More...
 
virtual IModelComponentmodelComponent () 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 IValueDefinitionvalueDefinition () 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...
 
- Public Member Functions inherited from HydroCouple::Spatial::IPolyhedralSurfaceComponentDataItem
virtual ~IPolyhedralSurfaceComponentDataItem ()=0
 IPolyhedralSurfaceComponentItem destructor. More...
 
virtual MeshDataType meshDataType () const =0
 meshDataType represents the type of mesh data. More...
 
virtual IPolyhedralSurfacepolyhedralSurface () const =0
 
virtual IDimensioncellDimension () const =0
 cellDimension represents the dimension for the cells. More...
 
virtual IDimensionedgeDimension () const =0
 edgeDimension represents the dimension for the edges. More...
 
virtual IDimensionnodeDimension () const =0
 nodeDimension represents the dimension for the nodes. More...
 
virtual void getValue (int cellDimensionIndex, int edgeDimensionIndex, int nodeDimensionIndex, void *data) const =0
 getValue for given cell dimension index, edge dimension index, and node dimension index. More...
 
virtual void setValue (int cellDimensionIndex, int edgeDimensionIndex, int nodeDimensionIndex, const void *data)=0
 setValues for given cell dimension index, edge dimension index, and node dimension index. More...
 

Detailed Description

Constructor & Destructor Documentation

◆ ~ITINComponentDataItem()

virtual HydroCouple::Spatial::ITINComponentDataItem::~ITINComponentDataItem ( )
pure virtual

ITINComponentDataItem destructor.

Member Function Documentation

◆ TIN()

virtual ITIN* HydroCouple::Spatial::ITINComponentDataItem::TIN ( ) const
pure virtual
Returns
The ITIN associated with this ITINComponentDataItem.

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