Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
MiDataSet Class Referenceabstract

MeshViz Generic data set interface. More...

#include <MeshVizXLM/mesh/data/MiDataSet.h>

+ Inheritance diagram for MiDataSet:

Public Types

enum  DataBinding {
  PER_CELL ,
  PER_NODE
}
 Data binding. More...
 

Public Member Functions

virtual ~MiDataSet ()
 
virtual size_t getTimeStamp () const =0
 Returns for this dataset a unique time stamp across all datasets in the application.
 
virtual std::string getName () const =0
 Returns the name of this data set.
 
virtual DataBinding getBinding () const =0
 Returns the data binding of this data set.
 

Protected Member Functions

virtual std::ostream & toStream (std::ostream &s) const
 Performs an output operation on a stream which is returned afterward.
 

Friends

std::ostream & operator<< (std::ostream &s, const MiDataSet &dataset)
 Outputs the mesh to a stream using the toStream protected method implemented in all derived classes.
 

Detailed Description

MeshViz Generic data set interface.

A generic abstract interface for a data set usable in any extract of a mesh.

Definition at line 41 of file MiDataSet.h.

Member Enumeration Documentation

◆ DataBinding

Data binding.

Enumerator
PER_CELL 

The data set contains one data value per cell.

PER_NODE 

The data set contains one data value per node.

Definition at line 60 of file MiDataSet.h.

Constructor & Destructor Documentation

◆ ~MiDataSet()

virtual MiDataSet::~MiDataSet ( )
inlinevirtual

Definition at line 44 of file MiDataSet.h.

Member Function Documentation

◆ getBinding()

virtual DataBinding MiDataSet::getBinding ( ) const
pure virtual

Returns the data binding of this data set.

◆ getName()

virtual std::string MiDataSet::getName ( ) const
pure virtual

Returns the name of this data set.

◆ getTimeStamp()

virtual size_t MiDataSet::getTimeStamp ( ) const
pure virtual

Returns for this dataset a unique time stamp across all datasets in the application.

When the content of the dataset changes, the time stamp must increase. The time stamp allows extractors to identify this dataset and to be aware of any changes to it.

Note
MxTimeStamp can be used to generate a valid time stamp.

◆ toStream()

virtual std::ostream & MiDataSet::toStream ( std::ostream &  s) const
inlineprotectedvirtual

Performs an output operation on a stream which is returned afterward.

This method is protected since only called by the output operator <<. This method is not pure virtual and output by default the geometry and topology of a mesh. Whenever a different output is needed, this method can be implemented in the subclass to get a different output format. No std::ostream& operator << needs to be defined in any subclass. This allows you to benefit from the virtual inheritance when using the output operator on an abstract class.

Definition at line 82 of file MiDataSet.h.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  s,
const MiDataSet dataset 
)
friend

Outputs the mesh to a stream using the toStream protected method implemented in all derived classes.

Definition at line 73 of file MiDataSet.h.


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