VectorParam Class Reference

#include <VectorParam.h>

Inheritance diagram for VectorParam:

Public Member Functions
	VectorParam ()
	VectorParam (int enum_type, Vector< IssmDouble > *value)
	~VectorParam ()
Param *	copy ()
void	DeepEcho ()
void	Echo ()
int	Id ()
void	Marshall (char **pmarshalled_data, int *pmarshalled_data_size, int marshall_direction)
int	ObjectEnum ()
void	GetParameterValue (bool *pbool)
void	GetParameterValue (int *pinteger)
void	GetParameterValue (int **pintarray, int *pM)
void	GetParameterValue (int **pintarray, int *pM, int *pN)
void	GetParameterValue (IssmDouble *pIssmDouble)
void	GetParameterValue (IssmDouble *pdouble, IssmDouble time)
void	GetParameterValue (char **pstring)
void	GetParameterValue (char ***pstringarray, int *pM)
void	GetParameterValue (IssmDouble **pIssmDoublearray, int *pM)
void	GetParameterValue (IssmDouble **pIssmDoublearray, int *pM, int *pN)
void	GetParameterValue (IssmDouble ***parray, int *pM, int **pmdims, int **pndims)
void	GetParameterValue (Matrix< IssmDouble > **pmat)
void	GetParameterValue (Vector< IssmDouble > **poutput)
void	GetParameterValue (FILE **pfid)
void	GetParameterValue (DataSet **pdataset)
int	InstanceEnum ()
void	SetEnum (int enum_in)
void	SetValue (bool boolean)
void	SetValue (int integer)
void	SetValue (IssmDouble scalar)
void	SetValue (char *string)
void	SetValue (char **stringarray, int M)
void	SetValue (IssmDouble *IssmDoublearray, int M)
void	SetValue (IssmDouble *pIssmDoublearray, int M, int N)
void	SetValue (int *intarray, int M)
void	SetValue (int *pintarray, int M, int N)
void	SetValue (Vector< IssmDouble > *vec)
void	SetValue (Matrix< IssmDouble > *mat)
void	SetValue (FILE *fid)
void	SetValue (IssmDouble **array, int M, int *mdim_array, int *ndim_array)
Public Member Functions inherited from Param
virtual	~Param ()
virtual void	GetParameterValue (IssmDouble *pdouble, int row, IssmDouble time)
virtual void	SetValue (DataSet *dataset)
Public Member Functions inherited from Object
virtual	~Object ()

Private Attributes
int	enum_type
Vector< IssmDouble > *	value

Detailed Description

Definition at line 20 of file VectorParam.h.

Constructor & Destructor Documentation

VectorParam() [1/2]

VectorParam::VectorParam

(

)

Definition at line 18 of file VectorParam.cpp.

                        {/*{{{*/
   return;
}

VectorParam() [2/2]

VectorParam::VectorParam	(	int	enum_type,
		Vector< IssmDouble > *	value
	)

Definition at line 22 of file VectorParam.cpp.

                                                                     {/*{{{*/
 
   enum_type=in_enum_type;
 
   value=NULL;
 
   if(in_value){
      value=in_value->Duplicate();
      in_value->Copy(value);
   }
}

~VectorParam()

VectorParam::~VectorParam

(

)

Definition at line 34 of file VectorParam.cpp.

                         {/*{{{*/
   delete value;
}

Member Function Documentation

copy()

Param * VectorParam::copy ( void  )

virtual

Implements Param.

Definition at line 40 of file VectorParam.cpp.

                         {/*{{{*/
 
   return new VectorParam(this->enum_type,this->value);
 
}

DeepEcho()

void VectorParam::DeepEcho ( void  )

virtual

Implements Param.

Definition at line 46 of file VectorParam.cpp.

                              {/*{{{*/
 
   _printf_("VectorParam:\n");
   _printf_("   enum: " << this->enum_type << " (" << EnumToStringx(this->enum_type) << ")\n");
   value->Echo();
}

Echo()

void VectorParam::Echo ( void  )

virtual

Implements Param.

Definition at line 53 of file VectorParam.cpp.

                          {/*{{{*/
 
   _printf_("VectorParam:\n");
   _printf_("   enum: " << this->enum_type << " (" << EnumToStringx(this->enum_type) << ")\n");
 
}

Id()

int VectorParam::Id ( void  )

virtual

Implements Object.

Definition at line 60 of file VectorParam.cpp.

{ return -1; }/*{{{*/

Marshall()

void VectorParam::Marshall ( char **  pmarshalled_data, int *  pmarshalled_data_size, int  marshall_direction  )

inlinevirtual

Implements Param.

Definition at line 38 of file VectorParam.h.

{ _error_("not implemented yet!"); };

ObjectEnum()

int VectorParam::ObjectEnum ( void  )

virtual

Implements Param.

Definition at line 62 of file VectorParam.cpp.

                               {/*{{{*/
 
   return VectorParamEnum;
 
}

GetParameterValue() [1/15]

void VectorParam::GetParameterValue ( bool *  pbool )

inlinevirtual

Implements Param.

Definition at line 42 of file VectorParam.h.

{_error_("Param "<< EnumToStringx(enum_type) << " cannot return a bool");}

GetParameterValue() [2/15]

void VectorParam::GetParameterValue ( int *  pinteger )

inlinevirtual

Implements Param.

Definition at line 43 of file VectorParam.h.

{_error_("Param "<< EnumToStringx(enum_type) << " cannot return an integer");}

GetParameterValue() [3/15]

void VectorParam::GetParameterValue ( int **  pintarray, int *  pM  )

inlinevirtual

Implements Param.

Definition at line 44 of file VectorParam.h.

{_error_("Param "<< EnumToStringx(enum_type) << " cannot return an array of integers");}

GetParameterValue() [4/15]

void VectorParam::GetParameterValue ( int **  pintarray, int *  pM, int *  pN  )

inlinevirtual

Implements Param.

Definition at line 45 of file VectorParam.h.

{_error_("Param "<< EnumToStringx(enum_type) << " cannot return an array of integers");}

GetParameterValue() [5/15]

void VectorParam::GetParameterValue ( IssmDouble *  pIssmDouble )

inlinevirtual

Implements Param.

Definition at line 46 of file VectorParam.h.

{_error_("Param "<< EnumToStringx(enum_type) << " cannot return a IssmDouble");}

GetParameterValue() [6/15]

void VectorParam::GetParameterValue ( IssmDouble *  pdouble, IssmDouble  time  )

inlinevirtual

Implements Param.

Definition at line 47 of file VectorParam.h.

{_error_("Param "<< EnumToStringx(enum_type) << " cannot return a IssmDouble for a given time");}

GetParameterValue() [7/15]

void VectorParam::GetParameterValue ( char **  pstring )

inlinevirtual

Implements Param.

Definition at line 48 of file VectorParam.h.

{_error_("Param "<< EnumToStringx(enum_type) << " cannot return a string");}

GetParameterValue() [8/15]

void VectorParam::GetParameterValue ( char ***  pstringarray, int *  pM  )

inlinevirtual

Implements Param.

Definition at line 49 of file VectorParam.h.

{_error_("Param "<< EnumToStringx(enum_type) << " cannot return a string array");}

GetParameterValue() [9/15]

void VectorParam::GetParameterValue ( IssmDouble **  pIssmDoublearray, int *  pM  )

inlinevirtual

Implements Param.

Definition at line 50 of file VectorParam.h.

{_error_("Param "<< EnumToStringx(enum_type) << " cannot return a IssmDouble array");}

GetParameterValue() [10/15]

void VectorParam::GetParameterValue ( IssmDouble **  pIssmDoublearray, int *  pM, int *  pN  )

inlinevirtual

Implements Param.

Definition at line 51 of file VectorParam.h.

{_error_("Param "<< EnumToStringx(enum_type) << " cannot return a IssmDouble array");}

GetParameterValue() [11/15]

void VectorParam::GetParameterValue ( IssmDouble ***  parray, int *  pM, int **  pmdims, int **  pndims  )

inlinevirtual

Implements Param.

Definition at line 52 of file VectorParam.h.

{_error_("Param "<< EnumToStringx(enum_type) << " cannot return a matrix array");}

GetParameterValue() [12/15]

void VectorParam::GetParameterValue ( Matrix< IssmDouble > **  pmat )

inlinevirtual

Implements Param.

Definition at line 53 of file VectorParam.h.

{_error_("Param "<< EnumToStringx(enum_type) << " cannot return a Mat");}

GetParameterValue() [13/15]

void VectorParam::GetParameterValue ( Vector< IssmDouble > **  poutput )

virtual

Implements Param.

Definition at line 70 of file VectorParam.cpp.

                                                                {/*{{{*/
   Vector<IssmDouble>*  output=NULL;
 
   if(value){
      output=value->Duplicate();
      value->Copy(output);
   }
   *poutput=output;
}

GetParameterValue() [14/15]

void VectorParam::GetParameterValue ( FILE **  pfid )

inlinevirtual

Implements Param.

Definition at line 55 of file VectorParam.h.

{_error_("Vector of enum " << enum_type << " (" << EnumToStringx(enum_type) << ") cannot return a FILE");}

GetParameterValue() [15/15]

void VectorParam::GetParameterValue ( DataSet **  pdataset )

inlinevirtual

Implements Param.

Definition at line 56 of file VectorParam.h.

{_error_("Param "<< EnumToStringx(enum_type) << " cannot return a DataSet");}

InstanceEnum()

int VectorParam::InstanceEnum ( )

inlinevirtual

Implements Param.

Definition at line 57 of file VectorParam.h.

{return enum_type;}

SetEnum()

void VectorParam::SetEnum ( int  enum_in )

inlinevirtual

Implements Param.

Definition at line 59 of file VectorParam.h.

{this->enum_type = enum_in;};

SetValue() [1/13]

void VectorParam::SetValue ( bool  boolean )

inlinevirtual

Implements Param.

Definition at line 60 of file VectorParam.h.

{_error_("Vector of enum " << enum_type << " (" << EnumToStringx(enum_type) << ") cannot hold a boolean");}

SetValue() [2/13]

void VectorParam::SetValue ( int  integer )

inlinevirtual

Implements Param.

Definition at line 61 of file VectorParam.h.

{_error_("Vector of enum " << enum_type << " (" << EnumToStringx(enum_type) << ") cannot hold an integer");}

SetValue() [3/13]

void VectorParam::SetValue ( IssmDouble  scalar )

inlinevirtual

Implements Param.

Definition at line 62 of file VectorParam.h.

{_error_("Vector of enum " << enum_type << " (" << EnumToStringx(enum_type) << ") cannot hold a scalar");}

SetValue() [4/13]

void VectorParam::SetValue ( char *  string )

inlinevirtual

Implements Param.

Definition at line 63 of file VectorParam.h.

{_error_("Vector of enum " << enum_type << " (" << EnumToStringx(enum_type) << ") cannot hold a string");}

SetValue() [5/13]

void VectorParam::SetValue ( char **  stringarray, int  M  )

inlinevirtual

Implements Param.

Definition at line 64 of file VectorParam.h.

{_error_("Vector of enum " << enum_type << " (" << EnumToStringx(enum_type) << ") cannot hold a string array");}

SetValue() [6/13]

void VectorParam::SetValue ( IssmDouble *  IssmDoublearray, int  M  )

inlinevirtual

Implements Param.

Definition at line 65 of file VectorParam.h.

{_error_("Vector of enum " << enum_type << " (" << EnumToStringx(enum_type) << ") cannot hold a IssmDouble array");}

SetValue() [7/13]

void VectorParam::SetValue ( IssmDouble *  pIssmDoublearray, int  M, int  N  )

inlinevirtual

Implements Param.

Definition at line 66 of file VectorParam.h.

{_error_("Vector of enum " << enum_type << " (" << EnumToStringx(enum_type) << ") cannot hold a IssmDouble array");}

SetValue() [8/13]

void VectorParam::SetValue ( int *  intarray, int  M  )

inlinevirtual

Implements Param.

Definition at line 67 of file VectorParam.h.

{_error_("Vector of enum " << enum_type << " (" << EnumToStringx(enum_type) << ") cannot hold a int array");}

SetValue() [9/13]

void VectorParam::SetValue ( int *  pintarray, int  M, int  N  )

inlinevirtual

Implements Param.

Definition at line 68 of file VectorParam.h.

{_error_("Vector of enum " << enum_type << " (" << EnumToStringx(enum_type) << ") cannot hold a int array");}

SetValue() [10/13]

void VectorParam::SetValue ( Vector< IssmDouble > *  vec )

virtual

Implements Param.

Definition at line 80 of file VectorParam.cpp.

                                                     {/*{{{*/
 
   /*avoid leak: */
   delete value;
 
   /*copy: */
   value=vector->Duplicate();
   vector->Copy(value);
}

SetValue() [11/13]

void VectorParam::SetValue ( Matrix< IssmDouble > *  mat )

inlinevirtual

Implements Param.

Definition at line 70 of file VectorParam.h.

{_error_("Vector of enum " << enum_type << " (" << EnumToStringx(enum_type) << ") cannot hold a Mat");}

SetValue() [12/13]

void VectorParam::SetValue ( FILE *  fid )

inlinevirtual

Implements Param.

Definition at line 71 of file VectorParam.h.

{_error_("Vector of enum " << enum_type << " (" << EnumToStringx(enum_type) << ") cannot hold a FILE");}

SetValue() [13/13]

void VectorParam::SetValue ( IssmDouble **  array, int  M, int *  mdim_array, int *  ndim_array  )

inlinevirtual

Implements Param.

Definition at line 72 of file VectorParam.h.

{_error_("Param "<< EnumToStringx(enum_type) << " cannot hold an array of matrices");}

Field Documentation

enum_type

int VectorParam::enum_type

private

Definition at line 24 of file VectorParam.h.

value

Vector<IssmDouble>* VectorParam::value

private

Definition at line 25 of file VectorParam.h.

---

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

• src/c/classes/Params/VectorParam.h
• src/c/classes/Params/VectorParam.cpp