Hook Class Reference

#include <Hook.h>

Public Member Functions
	Hook ()
	Hook (int *ids, int num)
	~Hook ()
Object *	copy (void)
void	DeepEcho (void)
void	Echo (void)
void	Marshall (char **pmarshalled_data, int *pmarshalled_data_size, int marshall_direction)
void	configure (DataSet *dataset)
Object **	deliverp (void)
Object *	delivers (void)
int	GetNum (void)
int *	Ids (void)
void	reset (void)
Hook *	Spawn (int *indices, int numindices)

Private Attributes
int *	ids
int	num
Object **	objects
int *	offsets

Detailed Description

Definition at line 16 of file Hook.h.

Constructor & Destructor Documentation

Hook() [1/2]

Hook::Hook

(

)

Definition at line 18 of file Hook.cpp.

          {/*{{{*/
   this->num     = 0;
   this->objects = NULL;
   this->ids     = NULL;
   this->offsets = NULL;
}

Hook() [2/2]

Hook::Hook	(	int *	ids,
		int	num
	)

Definition at line 25 of file Hook.cpp.

                                 {/*{{{*/
 
   /*Get number of objects to hook*/
   this->num=in_num;
 
   /*Get out if num=0*/
   if (this->num<=0){
      /*Empty hook*/
      this->ids     = NULL;
      this->objects = NULL;
      this->offsets = NULL;
      this->num = 0;
   }
   else{
      /*Allocate: */
      this->objects=xNew<Object*>(in_num);
      this->ids=xNew<int>(in_num);
      this->offsets=xNew<int>(in_num);
 
      /*Copy ids: */
      for(int i=0;i<this->num;i++){
         this->ids[i]     = in_ids[i];
         this->objects[i] = NULL;
         this->offsets[i] = 0;
      }
   }
}

~Hook()

Hook::~Hook

(

)

Definition at line 53 of file Hook.cpp.

           {/*{{{*/
   xDelete<Object*>(this->objects);
   xDelete<int>(this->ids);
   xDelete<int>(this->offsets);
}

Member Function Documentation

copy()

Object * Hook::copy

(

void

)

Definition at line 61 of file Hook.cpp.

                      {/*{{{*/
 
   /*output: */
   Hook* output=NULL;
 
   /*initalize output: */
   output=new Hook(this->ids,this->num);
 
   for(int i=0;i<output->num;i++){
      output->objects[i] = this->objects[i];
      output->offsets[i] = this->offsets[i];
   }
 
   return (Object*)output;
}

DeepEcho()

void Hook::DeepEcho

(

void

)

Definition at line 77 of file Hook.cpp.

                       {/*{{{*/
 
   int i;
   if (num){
      _printf_("   Hook: \n");
      _printf_("      num=" << this->num << "\n");
      _printf_("      ids: ");
      for (i=0;i<this->num;i++) _printf_(this->ids[i] << " ");
      _printf_("\n");
      _printf_("      offsets: ");
      for (i=0;i<this->num;i++) _printf_(this->offsets[i] << " ");
      _printf_("\n");
      if (!objects) _printf_("      warning: object not hooked yet\n");
      else{
         _printf_("      objects:\n   ");
         for (i=0;i<this->num;i++){
            _printf_("         object " << i << "\n");
            if(objects[i]) objects[i]->DeepEcho();
            else           _printf_("            no object hooked yet (not configured)\n");
         }
      }
   }
   else{
      _printf_("   Hook: num=0 \n");
   }
}

Echo()

void Hook::Echo

(

void

)

Definition at line 104 of file Hook.cpp.

                   {/*{{{*/
   _assert_(this);
   int i;
   if (num){
      _printf_("   Hook: \n");
      _printf_("      num=" << this->num << "\n");
      _printf_("      ids: ");
      for(i=0;i<this->num;i++) _printf_(this->ids[i] << " ");
      _printf_("\n");
      _printf_("      offsets: ");
      for (i=0;i<this->num;i++) _printf_(this->offsets[i] << " ");
      _printf_("\n");
   }
   else{
      _printf_("   Hook: num=0 \n");
   }
}

Marshall()

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

Definition at line 122 of file Hook.cpp.

                                                                                             { /*{{{*/
 
   if(marshall_direction==MARSHALLING_BACKWARD) reset();
 
   MARSHALLING_ENUM(HookEnum);
   MARSHALLING(num);
   if (num<=0){
      /*Empty hook*/
      this->ids     = NULL;
      this->objects = NULL;
      this->offsets = NULL;
      this->num = 0;
   }
   else{
      MARSHALLING_DYNAMIC(ids,int,num);
      MARSHALLING_DYNAMIC(offsets,int,num);
      MARSHALLING_DYNAMIC(objects,Object*,num);
   }
 
}

configure()

void Hook::configure

(

DataSet *

dataset

)

Definition at line 145 of file Hook.cpp.

                                    {/*{{{*/
 
   /*intermediary: */
   Object* object=NULL;
   int i;
 
   /*Checks if debugging mode*/
   _assert_(this->num==0 || this->ids!=NULL);
 
   for(i=0;i<this->num;i++){
 
      /*is this object id -1? If so, drop this search, it was not requested: */
      if (this->ids[i]==-1) continue;
 
      /*Check whether existing this->objects are correct: */
      if(this->objects[i]){
         if(this->objects[i]->Id()==this->ids[i]) continue; //this node is good.
         else this->objects[i]=NULL; //this node was incorrect, reset it.
      }
 
      /*May be the object this->offsets into this->objects are valid?: */
      if(this->offsets[i]!=UNDEF){
         /* Look at the this->offsets[i]'th node in the nodes dataset. If it has the correct id, 
          * we are good: */
         object=(Object*)dataset->GetObjectByOffset(this->offsets[i]);
         if (object->Id()==this->ids[i]){
            this->objects[i]=object;
            continue;
         }
         else this->offsets[i]=UNDEF; //object offset was wrong, reset it.
      }
      else this->offsets[i]=UNDEF;
 
      /*Now, for this->objects that did not get resolved, and for which we have no offset, chase them in the dataset, by id: */
      if(this->objects[i]==NULL){
         this->objects[i]=xDynamicCast<Object*>(dataset->GetObjectById(this->offsets+i,this->ids[i])); //remember the offset for later on.
         /*check the id is correct!: */
         if (this->objects[i]->Id()!=this->ids[i]) _error_("wrong id: " << this->objects[i]->Id() << " vs " << this->ids[i] << "  in resolved pointer!");
      }
   }
}

deliverp()

Object ** Hook::deliverp

(

void

)

Definition at line 187 of file Hook.cpp.

                           {/*{{{*/
   return objects;
}

delivers()

Object * Hook::delivers

(

void

)

Definition at line 191 of file Hook.cpp.

                          {/*{{{*/
 
   /*first, check that we only have one T object in our object list: */
   if (this->num!=1) _error_("trying to deliver a single hook object when hook holds " << this->num << " objects" << "\n");
 
   /*check NULL: */
   if (this->objects==NULL) _error_("hook is not pointing to any object, objects pointer is NULL");
 
   return *objects;
}

GetNum()

int Hook::GetNum

(

void

)

Definition at line 203 of file Hook.cpp.

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

Ids()

int * Hook::Ids

(

void

)

Definition at line 207 of file Hook.cpp.

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

reset()

void Hook::reset

(

void

)

Definition at line 211 of file Hook.cpp.

                {/*{{{*/
 
   /*intermediary: */
   Object* object=NULL;
   int i;
 
   for(i=0;i<this->num;i++){
         this->objects[i]=NULL; //reset this node.
   }
}

Spawn()

Hook * Hook::Spawn	(	int *	indices,
		int	numindices
	)

Definition at line 222 of file Hook.cpp.

                                             {/*{{{*/
 
   /*output: */
   Hook* output=NULL;
 
   /*allocate: */
   output=new Hook();
 
   /*If this Hook is empty, simply return*/
   if(this->num==0){
      output->num=0;
      return output;
   }
 
   /*Else, check that we are requesting a half of num*/
   if(numindices>this->num) _error_("Cannot spawn hook with " << numindices << " objects from a Hook of " << this->num << " objects");
 
   /*go pickup the correct objects, ids and offsets :*/
   output->num=numindices;
   if(output->num<1) _error_("Trying to spawn an empty ElementProperties!");
 
   output->objects = xNew<Object*>(output->num);
   output->ids     = xNew<int>(output->num);
   output->offsets = xNew<int>(output->num);
 
   for(int i=0;i<output->num;i++){
      output->objects[i] = this->objects[indices[i]];
      output->ids[i]     = this->ids[indices[i]];
      output->offsets[i] = this->offsets[indices[i]];
   }
 
   return output;
}

Field Documentation

ids

int* Hook::ids

private

Definition at line 20 of file Hook.h.

num

int Hook::num

private

Definition at line 21 of file Hook.h.

objects

Object** Hook::objects

private

Definition at line 22 of file Hook.h.

offsets

int* Hook::offsets

private

Definition at line 23 of file Hook.h.

---

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

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