Homec4science
Diffusion iohelper (master) Browse

iohelper/src/field_interface.hh
825badc47683master

Last Change
Raw File

field_interface.hh
View Options

/*
Copyright 2008 Guillaume ANCIAUX (guillaume.anciaux@epfl.ch)
This file is part of ParaViewHelper.
ParaViewHelper is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
ParaViewHelper is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with ParaViewHelper. If not, see <http://www.gnu.org/licenses/>.
*/
/* -------------------------------------------------------------------------- */
#ifndef __IOHELPER_FIELD_INTERFACE_HH__
#define __IOHELPER_FIELD_INTERFACE_HH__
/* -------------------------------------------------------------------------- */
enum FieldType {
REAL,
UINT,
INT,
BOOL
};
/* -------------------------------------------------------------------------- */
__BEGIN_IOHELPER__
class FieldInterface {
/* ------------------------------------------------------------------------ */
/* Constructors/Destructors */
/* ------------------------------------------------------------------------ */
public:
FieldInterface();
FieldInterface(UInt dimension,UInt n_elem, UInt stride = 0);
virtual ~FieldInterface(){};
/* ------------------------------------------------------------------------ */
/* Accessors */
/* ------------------------------------------------------------------------ */
public:
//! return the number of entities
UInt getNbDof();
//! set the number of entities stored
void setNbDof(UInt nb_dof);
//! return the dimension of the field stored
UInt getDim();
//! set the dimension of the field stored
void setDim(UInt dim);
//! set the name of the field
void setName(const std::string & n);
//! return the name of the field
const std::string & getName();
//! return the flag embbeded status
bool getFlagEmbedded();
//! set the flag embbeded status
void setFlagEmbedded(bool flag);
//! return the type of data of the field
virtual FieldType getFieldDataType()=0;
//! return the stride
bool getStride();
/* ------------------------------------------------------------------------ */
/* Class Members */
/* ------------------------------------------------------------------------ */
protected:
//! name of the field
std::string name;
//! dimension of the field
UInt dim;
//! number of entities stored
UInt nb_dof;
//! stride access
UInt stride;
//! flag for embedded behavior
bool flag_embedded_dimension;
};
/* -------------------------------------------------------------------------- */
inline FieldInterface::FieldInterface(){
this->dim = 0;
this->nb_dof = 0;
this->flag_embedded_dimension = 0;
this->stride = 0;
}
/* -------------------------------------------------------------------------- */
inline FieldInterface::FieldInterface(UInt dimension, UInt n_elem, UInt stride){
this->dim = dimension;
this->nb_dof = n_elem;
this->flag_embedded_dimension = 0;
this->stride = stride;
}
/* -------------------------------------------------------------------------- */
inline UInt FieldInterface::getNbDof(){
return nb_dof;
}
/* -------------------------------------------------------------------------- */
inline void FieldInterface::setNbDof(UInt nb){
nb_dof = nb;
}
/* -------------------------------------------------------------------------- */
inline UInt FieldInterface::getDim(){
return dim;
}
/* -------------------------------------------------------------------------- */
inline void FieldInterface::setDim(UInt nb){
dim = nb;
}
/* -------------------------------------------------------------------------- */
inline void FieldInterface::setName(const std::string & n){
name = n;
}
/* -------------------------------------------------------------------------- */
inline const std::string & FieldInterface::getName(){
return name;
}
/* -------------------------------------------------------------------------- */
inline void FieldInterface::setFlagEmbedded(bool f){
flag_embedded_dimension = f;
}
/* -------------------------------------------------------------------------- */
inline bool FieldInterface::getFlagEmbedded(){
return flag_embedded_dimension;
}
/* -------------------------------------------------------------------------- */
inline bool FieldInterface::getStride(){
return stride;
}
__END_IOHELPER__
#endif /* __IOHELPER_FIELD_INTERFACE_HH__ */
c4science · Help