MeVis/Foundation/Sources/ML/include/mlFieldContainer.h

Go to the documentation of this file.

// **InsertLicense** code
//-------------------------------------------------------------------------
//-------------------------------------------------------------------------
#ifndef __mlFieldContainer_H
#define __mlFieldContainer_H

// ML-includes
#ifndef __mlInitSystemML_H
#include "mlInitSystemML.h"
#endif
#ifndef __mlLinearAlgebra_H
#include "mlLinearAlgebra.h"
#endif
#ifndef __mlImageVector_H
#include "mlImageVector.h"
#endif
#ifndef __mlSubImageBox_H
#include "mlSubImageBox.h"
#endif

#include "mlBase.h"
#include "mlFieldSensor.h"
#include "mlFields.h"

class SoNode;

ML_START_NAMESPACE


#ifdef ML_DEPRECATED
#define ML_DEPRECATED_FIELDS_WITH_VALUE_POINTER ML_DEPRECATED
#endif

#ifdef ML_DEPRECATED
class BaseOp;
#endif
class InputConnector;
class OutputConnector;
class SubImageBoxd;


// Disable own usage of deprecation
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable : 4996 )
#endif

//-------------------------------------------------------------------------
//-------------------------------------------------------------------------
class MLEXPORT FieldContainer : public Base {

  ML_DISALLOW_COPY_AND_ASSIGN(FieldContainer);

public:
  FieldContainer();

  virtual ~FieldContainer();

  Field* addField(const char* name, const char* type, const char* value);

  Field* addField(Field* field);

  BoolField* addBool(const char* name);
  BoolField* addBool(const char* name, bool value);
    
  IntField* addInt(const char*  name);
  IntField* addInt(const char*  name, MLint value);
    
  EnumField* addEnum(const char* name, const char* const * enumerationItemNames, MLint numEnumerationItems);

  EnumField* addEnum(const char* name, const std::vector<std::string> &enumerationItemNames);

  FloatField* addFloat(const char* name);
  FloatField* addFloat(const char* name, float value);

  ProgressField* addProgress(const char* name);
  ProgressField* addProgress(const char* name, float value);

  DoubleField* addDouble(const char* name);
  DoubleField* addDouble(const char* name, double value);

  LongDoubleField* addLongDouble(const char* name);
  LongDoubleField* addLongDouble(const char* name, MLldouble value);

  StringField* addString(const char* name);
  StringField* addString(const char* name, const std::string& value);

  NotifyField* addNotify(const char* name);

  BaseField* addBase(const char* name);
  BaseField* addBase(const char* name, Base* value);

  SoNodeField* addSoNode(const char* name);
  SoNodeField* addSoNode(const char* name, SoNode* value);

  PointerField* addPointer(const char* name);

  Vector2Field* addVector2(const char* name);
  Vector2Field* addVector2(const char* name, const Vector2& value);
  Vector2Field* addVector2(const char* name, double x, double y);

  Vector3Field* addVector3(const char* name);
  Vector3Field* addVector3(const char* name, const Vector3& value);
  Vector3Field* addVector3(const char* name, double x, double y, double z);

  Vector4Field* addVector4(const char* name);
  Vector4Field* addVector4(const char* name, const Vector4& value);
  Vector4Field* addVector4(const char* name, double x, double y, double z, double w);

  Vector5Field* addVector5(const char* name);
  Vector5Field* addVector5(const char* name, const Vector5& value);

  Vector6Field* addVector6(const char* name);
  Vector6Field* addVector6(const char* name, const Vector6& value);

  Vector10Field* addVector10(const char* name);
  Vector10Field* addVector10(const char* name, const Vector10& value);

  ImageVectorField* addImageVector(const char* name);
  ImageVectorField* addImageVector(const char* name, const ImageVector& value);
  ImageVectorField* addImageVector(const char* name, MLint x, MLint y, MLint z, MLint c, MLint t, MLint u);

  SubImageBoxField* addSubImageBox(const char* name);
  SubImageBoxField* addSubImageBox(const char* name, const SubImageBox& value);

  SubImageBoxdField* addSubImageBoxd(const char* name);
  SubImageBoxdField* addSubImageBoxd(const char* name, const SubImageBoxd& value);

  ColorField* addColor(const char* name);
  ColorField* addColor(const char* name, float r, float g, float b);
  ColorField* addColor(const char* name, const Vector3& value);

  PlaneField* addPlane(const char* name);
  PlaneField* addPlane(const char* name, double f0, double f1, double f2, double f3);
  PlaneField* addPlane(const char* name, const Plane& value);

  RotationField* addRotation(const char* name);
  RotationField* addRotation(const char* name, const Rotation& value);

  Matrix2Field*  addMatrix2(const char* name);
  Matrix2Field*  addMatrix2(const char* name, const Matrix2& value);

  Matrix3Field*  addMatrix3(const char* name);
  Matrix3Field*  addMatrix3(const char* name, const Matrix3& value);

  Matrix4Field*  addMatrix4(const char* name);
  Matrix4Field*  addMatrix4(const char* name, const Matrix4& value);

  Matrix5Field*  addMatrix5(const char* name);
  Matrix5Field*  addMatrix5(const char* name, const Matrix5& value);

  Matrix6Field*  addMatrix6(const char* name);
  Matrix6Field*  addMatrix6(const char* name, const Matrix6& value);

  MatrixField* addMatrix(const char* name);
  MatrixField* addMatrix(const char* name, const Matrix4& value);

  MLDataTypeField* addMLDataType(const char* name);
  MLDataTypeField* addMLDataType(const char* name, MLDataType value);

  UniversalTypeField* addUniversalType(const char* name);

  size_t getNumFields() const;

  bool hasField(const std::string& name) const;

  Field* getField(const std::string& name) const ;

  Field* getField(MLint index) const ;

  MLint getFieldIndex(Field* field) const;

  void setFieldStringValue(const std::string& name, const std::string& value);

  std::string getFieldStringValue(const std::string& name) const;

  virtual void activateAttachments()  { enableNotifications(true); }

  virtual void deactivateAttachments(){ enableNotifications(false); }

private:
  bool removeField(Field* field);

  void enableNotifications(bool flag);

protected:
  // Permit access from Field to call handleNotificationInternal
  friend class Field;

  virtual void handleNotificationInternal(Field* /*field*/, FieldSensor::Strength /*strength*/) {};

private:
  std::vector <Field*>                _fields;
  
public:



  virtual InputConnectorField* addInputConnector(const char* /*name*/, Module* /*module*/, MLint /*i*/) { return NULL; }

  virtual OutputConnectorField* addOutputConnector(const char* /*name*/, Module* /*module*/, MLint /*i*/) { return NULL; }


#ifdef ML_DEPRECATED


  
public:
  ML_DEPRECATED InputConnectorField* addInputConnector(Module* module, MLint i);

  ML_DEPRECATED OutputConnectorField* addOutputConnector(Module* module, MLint i);
  
  inline ML_DEPRECATED Vector2Field* addVec2f(const char*  name) { return addVector2(name); }  
  inline ML_DEPRECATED Vector2Field* addDeprecatedVec2f(const char*  name, Vector2 *var0) { return addDeprecatedVector2(name, var0); }  
  inline ML_DEPRECATED Vector3Field* addVec3f(const char*  name) { return addVector3(name); }  
  inline ML_DEPRECATED Vector3Field* addDeprecatedVec3f(const char*  name, Vector3 *var0) { return addDeprecatedVector3(name, var0); }  
  inline ML_DEPRECATED Vector4Field* addVec4f(const char*  name) { return addVector4(name); }  
  inline ML_DEPRECATED Vector4Field* addDeprecatedVec4f(const char*  name, Vector4 *var0) { return addDeprecatedVector4(name, var0); }  
  inline ML_DEPRECATED Vector5Field* addVec5f(const char* name) { return addVector5(name); }  
  inline ML_DEPRECATED Vector6Field* addVec6f(const char*  name) { return addVector6(name); }  
  inline ML_DEPRECATED Vector6Field* addDeprecatedVec6f(const char*  name, Vector6 *var0) { return addDeprecatedVector6(name, var0); }  
  inline ML_DEPRECATED Vector10Field* addVec10f(const char*  name) { return addVector10(name); }  
  inline ML_DEPRECATED ImageVectorField* addVector(const char*  name) { return addImageVector(name); }   
  inline ML_DEPRECATED ImageVectorField* addDeprecatedVector(const char*  name, ImageVector *var0) { return addDeprecatedImageVector(name, var0); }   
  inline ML_DEPRECATED SubImageBoxField* addSubImgBox(const char*  name) { return addSubImageBox(name); }   
  inline ML_DEPRECATED SubImageBoxField* addDeprecatedSubImgBox(const char*  name, SubImageBox *var0) { return addDeprecatedSubImageBox(name, var0); }   
  inline ML_DEPRECATED SubImageBoxdField* addSubImgBoxf(const char*  name) { return addSubImageBoxd(name); }  
  inline ML_DEPRECATED SubImageBoxdField* addDeprecatedSubImgBoxf(const char*  name, SubImageBoxd *var0) { return addDeprecatedSubImageBoxd(name, var0); }  
  inline ML_DEPRECATED Matrix2Field*  addMat2(const char* name) { return addMatrix2(name); }  
  inline ML_DEPRECATED Matrix3Field*  addMat3(const char* name) { return addMatrix3(name); }  
  inline ML_DEPRECATED Matrix4Field*  addMat4(const char* name) { return addMatrix4(name); }  
  inline ML_DEPRECATED Matrix5Field*  addMat5(const char* name) { return addMatrix5(name); }  
  inline ML_DEPRECATED Matrix6Field*  addMat6(const char* name) { return addMatrix6(name); }
  
    
#endif // ML_DEPRECATED
  
  
  
#ifdef ML_DEPRECATED_FIELDS_WITH_VALUE_POINTER
  


public:
  
  ML_DEPRECATED BoolField* addDeprecatedBool(const char* name, bool *var);
  ML_DEPRECATED IntField* addDeprecatedInt(const char*  name, MLint *var);
  ML_DEPRECATED ToggleField* addDeprecatedToggle(const char* name);
  ML_DEPRECATED ToggleField* addDeprecatedToggle(const char* name, int *var);
  ML_DEPRECATED EnumField* addDeprecatedEnum(const char* name, const char* const * enumNames, MLint enumNum, int *var);
  ML_DEPRECATED FloatField* addDeprecatedFloat(const char*  name, float *var);
  ML_DEPRECATED ProgressField* addDeprecatedProgress(const char*  name, float *var);
  ML_DEPRECATED DoubleField* addDeprecatedDouble(const char*  name, double *var);
  ML_DEPRECATED Vector2Field* addDeprecatedVector2(const char*  name, Vector2 *var0);
  ML_DEPRECATED Vector3Field* addDeprecatedVector3(const char*  name, Vector3 *var0);
  ML_DEPRECATED Vector4Field* addDeprecatedVector4(const char*  name, Vector4 *var0);
  ML_DEPRECATED Vector6Field* addDeprecatedVector6(const char*  name, Vector6 *var0);
  ML_DEPRECATED ImageVectorField* addDeprecatedImageVector(const char*  name, ImageVector *var0);
  ML_DEPRECATED SubImageBoxField* addDeprecatedSubImageBox(const char*  name, SubImageBox *var0);
  ML_DEPRECATED SubImageBoxdField* addDeprecatedSubImageBoxd(const char*  name, SubImageBoxd *var0);
  ML_DEPRECATED ColorField* addDeprecatedColor(const char*  name, Vector3 *var0);
  ML_DEPRECATED MatrixField* addDeprecatedMatrix(const char*  name, Matrix4* mat);
  ML_DEPRECATED MLDataTypeField* addDeprecatedMLDataType(const char* name, MLDataType* dt);
 
  
#endif // ML_DEPRECATED_FIELDS_WITH_VALUE_POINTER
  
  ML_ABSTRACT_CLASS_HEADER(FieldContainer)

};
  
// re-enable deprecation warnings
#ifdef _MSC_VER
#pragma warning(pop)
#endif

ML_END_NAMESPACE

//-----------------------------------------------------------------------------------
//   Stream output for std::ostream
//-----------------------------------------------------------------------------------
namespace std 
{

  MLEXPORT std::ostream& operator<<(std::ostream& s, const ML_NAMESPACE::FieldContainer &fc);

}



#endif //of __mlFieldContainer_H