DependentObject Class Reference

#include <DependentObject.h>

Inheritance diagram for DependentObject:

Public Member Functions
	DependentObject ()
	DependentObject (char *name, int type, int index)
	DependentObject (char *name, int type, int index, IssmDouble in_response)
	~DependentObject ()
Object *	copy (void)
void	DeepEcho ()
void	Echo ()
int	Id ()
int	ObjectEnum ()
void	Marshall (char **pmarshalled_data, int *pmarshalled_data_size, int marshall_direction)
int	NumDependents (void)
void	Responsex (IssmDouble *poutput_value, FemModel *femmodel)
IssmDouble	GetValue (void)
void	AddValue (IssmDouble in_value)
void	ResetResponseValue (void)
Public Member Functions inherited from Object
virtual	~Object ()

Data Fields
char *	name
int	type
int	index
IssmDouble	response_value

Detailed Description

Definition at line 15 of file DependentObject.h.

Constructor & Destructor Documentation

DependentObject() [1/3]

DependentObject::DependentObject

(

)

Definition at line 16 of file DependentObject.cpp.

                                {/*{{{*/
   this->name=NULL;
   this->type=0;
   this->index=-1;
   this->response_value=0.;
}

DependentObject() [2/3]

DependentObject::DependentObject	(	char *	name,
		int	type,
		int	index
	)

Definition at line 23 of file DependentObject.cpp.

                                                                       {/*{{{*/
 
   this->name=xNew<char>(strlen(in_name)+1); xMemCpy<char>(this->name,in_name,strlen(in_name)+1);
   this->type=in_type;
   this->index=in_index;
   if(in_type!=0 && in_type!=1)_error_("cannot create an DependentObject of type " << in_type);
   if(in_type==1)_error_("not implemented yet!");
   this->response_value=0.;
 
}

DependentObject() [3/3]

DependentObject::DependentObject	(	char *	name,
		int	type,
		int	index,
		IssmDouble	in_response
	)

Definition at line 34 of file DependentObject.cpp.

                                                                                              {/*{{{*/
 
   this->name=xNew<char>(strlen(in_name)+1); xMemCpy<char>(this->name,in_name,strlen(in_name)+1);
   this->type=in_type;
   this->index=in_index;
   if(in_type!=0 && in_type!=1)_error_("cannot create an DependentObject of type " << in_type);
   if(in_type==1)_error_("not implemented yet!");
   this->response_value=in_response;
 
}

~DependentObject()

DependentObject::~DependentObject

(

)

Definition at line 45 of file DependentObject.cpp.

                                 { //destructor/*{{{*/
   xDelete<char>(this->name);
}

Member Function Documentation

copy()

Object * DependentObject::copy ( void  )

virtual

Implements Object.

Definition at line 51 of file DependentObject.cpp.

                                  { /*{{{*/
   return new DependentObject(name,type,index,response_value);
} /*}}}*/

DeepEcho()

void DependentObject::DeepEcho ( void  )

virtual

Implements Object.

Definition at line 54 of file DependentObject.cpp.

                                  {/*{{{*/
   this->Echo();
}

Echo()

void DependentObject::Echo ( void  )

virtual

Implements Object.

Definition at line 58 of file DependentObject.cpp.

                              {/*{{{*/
 
   _printf_("DependentObject:\n");
   _printf_("   name: " << this->name << "\n");
   if(this->type==0)
      _printf_("   type: scalar\n");
   else if(this->type==1)
      _printf_("   type: vertex\n");
   else
      _error_(" unknown type: " << this->type);
   if(this->index>=0) _printf_("   index: " << this->index << "\n");
}

Id()

int DependentObject::Id ( void  )

virtual

Implements Object.

Definition at line 71 of file DependentObject.cpp.

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

ObjectEnum()

int DependentObject::ObjectEnum ( void  )

virtual

Implements Object.

Definition at line 73 of file DependentObject.cpp.

                                   {/*{{{*/
 
   return DependentObjectEnum;
 
}

Marshall()

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

inlinevirtual

Implements Object.

Definition at line 36 of file DependentObject.h.

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

NumDependents()

int DependentObject::NumDependents

(

void

)

Definition at line 81 of file DependentObject.cpp.

                                       {/*{{{*/
 
   /*Branch according to the type of variable: */
   if(type==0){ /*scalar:*/
      return 1;
   }
   else if(type==1){ /* vector:*/
      _error_("not implemented yet!");
   }
   else _error_("should not have a type of " << type);
}

Responsex()

void DependentObject::Responsex	(	IssmDouble *	poutput_value,
		FemModel *	femmodel
	)

Definition at line 93 of file DependentObject.cpp.

                                                                            {/*{{{*/
 
   /*Is this some special type of response for which we need to go in the output definitions? :*/
   if (StringToEnumx(this->name,false)==-1){
      *poutput_value=OutputDefinitionsResponsex(femmodel,this->name);
   }
   else femmodel->Responsex(poutput_value,this->name);
}

GetValue()

IssmDouble DependentObject::GetValue

(

void

)

Definition at line 102 of file DependentObject.cpp.

                                        {/*{{{*/
   return this->response_value;
}

AddValue()

void DependentObject::AddValue

(

IssmDouble

in_value

)

Definition at line 106 of file DependentObject.cpp.

                                                 {/*{{{*/
   this->response_value+=in_value;
}

ResetResponseValue()

void DependentObject::ResetResponseValue

(

void

)

Definition at line 110 of file DependentObject.cpp.

                                        {/*{{{*/
   this->response_value=0.;
}

Field Documentation

name

char* DependentObject::name

Definition at line 19 of file DependentObject.h.

type

int DependentObject::type

Definition at line 20 of file DependentObject.h.

index

int DependentObject::index

Definition at line 21 of file DependentObject.h.

response_value

IssmDouble DependentObject::response_value

Definition at line 22 of file DependentObject.h.

---

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

• src/c/classes/DependentObject.h
• src/c/classes/DependentObject.cpp