GenericOption< OptionType > Class Template Reference

#include <GenericOption.h>

Inheritance diagram for GenericOption< OptionType >:

Public Member Functions
	GenericOption ()
	~GenericOption ()
Object *	copy ()
void	DeepEcho ()
void	DeepEcho (char *indent)
void	Echo ()
int	Id ()
int	ObjectEnum ()
void	Get (OptionType *pvalue)
char *	Name ()
void	Get (IssmDouble **pvalue)
void	Get (char **pvalue)
	~GenericOption ()
Public Member Functions inherited from Option
	Option ()
	~Option ()
Object *	copy ()
int	Id ()
void	Marshall (char **pmarshalled_data, int *pmarshalled_data_size, int marshall_direction)
int	ObjectEnum ()
Public Member Functions inherited from Object
virtual	~Object ()

Data Fields
char *	name
OptionType	value
int	size [2]

Detailed Description

template<class OptionType>
class GenericOption< OptionType >

Definition at line 22 of file GenericOption.h.

Constructor & Destructor Documentation

GenericOption()

template<class OptionType >

GenericOption< OptionType >::GenericOption ( )

inline

Definition at line 30 of file GenericOption.h.

                     { /*{{{*/
         name = NULL;
         size[0] = 0;
         size[1] = 0;
      } /*}}}*/

~GenericOption() [1/2]

template<class OptionType >

GenericOption< OptionType >::~GenericOption ( )

inline

Definition at line 35 of file GenericOption.h.

                      { /*{{{*/
         if(name) xDelete<char>(name);
      } /*}}}*/

~GenericOption() [2/2]

GenericOption< char * >::~GenericOption ( )

inline

Definition at line 108 of file GenericOption.h.

                                                       { /*{{{*/
   if(name)  xDelete<char>(name);
   if(value) xDelete<char>(value);
} 

Member Function Documentation

copy()

template<class OptionType >

Object* GenericOption< OptionType >::copy ( void  )

inlinevirtual

Implements Object.

Definition at line 40 of file GenericOption.h.

                    {/*{{{*/
         _error_("Not implemented yet");
      };/*}}}*/

DeepEcho() [1/2]

template<class OptionType >

void GenericOption< OptionType >::DeepEcho ( void  )

inlinevirtual

Implements Option.

Definition at line 43 of file GenericOption.h.

                     { /*{{{*/
         char  indent[81]="";
         this->DeepEcho(indent);
      } /*}}}*/

DeepEcho() [2/2]

template<class OptionType >

void GenericOption< OptionType >::DeepEcho ( char *  indent )

inlinevirtual

Implements Option.

Definition at line 47 of file GenericOption.h.

                                 { /*{{{*/
 
         char  cstr[81];
 
         _printf_(indent << "          name: \"" << name << "\"\n");
         _printf_(indent << "          size: " << size[0] <<"x"<<size[1]<< "\n");
         _printf_(indent << "         value: " << value << "\n");
      } /*}}}*/

Echo()

template<class OptionType >

void GenericOption< OptionType >::Echo ( void  )

inlinevirtual

Implements Option.

Definition at line 55 of file GenericOption.h.

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

Id()

template<class OptionType >

int GenericOption< OptionType >::Id ( void  )

inlinevirtual

Implements Object.

Definition at line 58 of file GenericOption.h.

               {/*{{{*/
         _error_("Not implemented yet");
      };/*}}}*/

ObjectEnum()

template<class OptionType >

int GenericOption< OptionType >::ObjectEnum ( void  )

inlinevirtual

Implements Object.

Definition at line 61 of file GenericOption.h.

                       {/*{{{*/
         return GenericOptionEnum;
      };/*}}}*/

Get() [1/3]

template<class OptionType >

void GenericOption< OptionType >::Get ( OptionType *  pvalue )

inline

Definition at line 66 of file GenericOption.h.

                                   {/*{{{*/
         *pvalue=value; 
      };/*}}}*/

Name()

template<class OptionType >

char* GenericOption< OptionType >::Name ( )

inlinevirtual

Implements Option.

Definition at line 69 of file GenericOption.h.

                  {/*{{{*/
         return name;
      };/*}}}*/

Get() [2/3]

void GenericOption< IssmDouble * >::Get ( IssmDouble **  pvalue )

inline

Definition at line 87 of file GenericOption.h.

                                                                          { /*{{{*/
 
   /*Copy vector*/
   int numel = this->size[0]*this->size[1];
   IssmDouble* outvalue=xNew<IssmDouble>(numel);
   for(int i=0;i<numel;i++) outvalue[i]=this->value[i];
 
   /*Assign output pointer*/
   *pvalue=outvalue;
} /*}}}*/

Get() [3/3]

void GenericOption< char * >::Get ( char **  pvalue )

inline

Definition at line 97 of file GenericOption.h.

                                                              { /*{{{*/
 
   int   stringsize=strlen(this->value)+1;
   char* outstring=xNew<char>(stringsize);
   xMemCpy<char>(outstring,this->value,stringsize);
 
   *pvalue=outstring;
} 

Field Documentation

name

template<class OptionType >

char* GenericOption< OptionType >::name

Definition at line 25 of file GenericOption.h.

value

template<class OptionType >

OptionType GenericOption< OptionType >::value

Definition at line 26 of file GenericOption.h.

size

template<class OptionType >

int GenericOption< OptionType >::size[2]

Definition at line 27 of file GenericOption.h.

---

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

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