Options Class Reference

#include <Options.h>

Inheritance diagram for Options:

Public Member Functions
	Options ()
	~Options ()
int	AddOption (Option *in_oobject)
Option *	GetOption (const char *name)
template<class OptionType >
void	Get (OptionType *pvalue, const char *name)
template<class OptionType >
void	Get (OptionType *pvalue, const char *name, OptionType default_value)
template<>
void	Get (char **pvalue, const char *name, char *default_value)
Public Member Functions inherited from DataSet
	DataSet ()
	DataSet (int enum_type)
	~DataSet ()
void	Marshall (char **pmarshalled_data, int *pmarshalled_data_size, int marshall_direction)
int	GetEnum ()
int	GetEnum (int offset)
void	Echo ()
void	DeepEcho ()
int	AddObject (Object *object)
int	DeleteObject (int id)
int	Size ()
void	clear ()
Object *	GetObjectByOffset (int offset)
Object *	GetObjectById (int *poffset, int eid)
void	Presort ()
void	Sort ()
DataSet *	Copy (void)
int	DeleteObject (Object *object)

Additional Inherited Members
Data Fields inherited from DataSet
std::vector< Object * >	objects
int	enum_type
int	sorted
int	presorted
int	numsorted
int *	sorted_ids
int *	id_offsets

Detailed Description

Definition at line 9 of file Options.h.

Constructor & Destructor Documentation

Options()

Options::Options

(

)

Definition at line 23 of file Options.cpp.

                {/*{{{*/
   return;
}

~Options()

Options::~Options

(

)

Definition at line 27 of file Options.cpp.

                 {/*{{{*/
   return;
}

Member Function Documentation

AddOption()

int Options::AddOption

(

Option *

in_oobject

)

Definition at line 33 of file Options.cpp.

                                        {/*{{{*/
 
   char* name=NULL;
 
   vector<Object*>::iterator object;
   Option* option=NULL;
 
   /*In debugging mode, check that the option is not a NULL pointer*/
   _assert_(in_option);
 
   /*Also, check the option name*/
   name=in_option->Name();
 
   if(!name) _error_("input option has an empty name");
   if(strchr(name,'.')) _error_("Option \"" << name << "\" has a protected character \".\"");
   if(strchr(name,'[')) _error_("Option \"" << name << "\" has a protected character \"[\"");
   if(strchr(name,']')) _error_("Option \"" << name << "\" has a protected character \"]\"");
 
   /*Finally, check that no option of the same name already exists in the dataset*/
   for(object=objects.begin();object<objects.end();object++){
 
      option=xDynamicCast<Option*>(*object);
      if (!strcmp(option->Name(),name)){
         _error_("Options \"" << name << "\" found multiple times");
         break;
      }
   }
 
   /*OK, all checks went well, add option to dataset*/
   this->AddObject(in_option);
 
   return 1;
}

GetOption()

Option * Options::GetOption

(

const char *

name

)

Definition at line 67 of file Options.cpp.

                                          {/*{{{*/
 
   vector<Object*>::iterator object;
   Option* option=NULL;
 
   /*Go through options and find option: */
   for ( object=objects.begin() ; object < objects.end(); object++ ){
 
      option=xDynamicCast<Option*>(*object);
      //option=(Option*)(*object); //C-like cast
      /*There is a crash on some machines (Einar Olason) that needs to be fixed*/
      if(!option){
         _printf_("The dynamic_cast from Object* to Option* is failing.\n");
         _printf_("\n");
         _printf_("A quick workaround consists of using a C-like cast\n");
         _printf_("\n");
         _printf_("Open Options.cpp and change the dynamic_cast in Options::GetOption by a C-like cast\n");
         //_printf_("Open Options.h and replace the dynamic_cast of all the Get functions to C-like cats\n");
         _printf_("\n");
         _error_("Make the fix above and recompile ISSM");
      }
 
      if (!strncmp(name,option->Name(),strlen(option->Name()))){
 
         /*OK, now do we have a complete name? If not, it is a cell or a structure, we need to go further*/
         if(!strcmp(name,option->Name())){
            return option;
         }
         else{
            _error_("Cannot recover field \"" << name << "\" for an option of type " << EnumToStringx(option->ObjectEnum()));
         }
      }
   }
 
   /*Option not found return NULL pointer*/
   return NULL;
}

Get() [1/3]

template<class OptionType >

void Options::Get ( OptionType *  pvalue, const char *  name  )

inline

Definition at line 21 of file Options.h.

                                                                               { /*{{{*/
 
         /*Get option*/
         GenericOption<OptionType>* genericoption=xDynamicCast<GenericOption<OptionType>*>(GetOption(name));
 
         /*If the pointer is not NULL, the option has been found*/
         if(genericoption){
            genericoption->Get(pvalue);
         }
         /*Else, the Option does not exist, no default provided*/
         else{
            _error_("option of name \"" << name << "\" not found, and no default value has been provided");
         }
      }

Get() [2/3]

template<class OptionType >

void Options::Get ( OptionType *  pvalue, const char *  name, OptionType  default_value  )

inline

Definition at line 36 of file Options.h.

                                                                                                        { /*{{{*/
 
         /*Get option*/
         GenericOption<OptionType>* genericoption=xDynamicCast<GenericOption<OptionType>*>(GetOption(name));
 
         /*If the pointer is not NULL, the option has been found*/
         if(genericoption){
            genericoption->Get(pvalue);
         }
         else{
            if(GetOption(name)) _printf_("WARNING: option "<<name<<" found but fetched format not consistent, defaulting...\n");
            *pvalue=default_value;
         }
      }

Get() [3/3]

template<>

void Options::Get ( char **  pvalue, const char *  name, char *  default_value  )

inline

Definition at line 56 of file Options.h.

                                                                                      { /*{{{*/
 
   /*Get option*/
   GenericOption<char*>* genericoption=xDynamicCast<GenericOption<char*>*>(GetOption(name));
 
   /*If the pointer is not NULL, the option has been found*/
   if(genericoption){
      genericoption->Get(pvalue);
   }
   else{
      /*Make a copy*/
      int   stringsize=strlen(default_value)+1;
      char* outstring=xNew<char>(stringsize);
      xMemCpy<char>(outstring,default_value,stringsize);
      *pvalue=outstring;
   }
}

---

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

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