TpaParameters

TpaParameters

Synopsis




#define             TPA_PARAMETERS_GET_PRIVATE          (obj)
                    TpaParameter;
                    TpaParametersPrivate;
                    TpaParameters;
gboolean            tpa_parameters_add                  (TpaParameters *self,
                                                         const gchar *name,
                                                         GType type);
gboolean            tpa_parameters_add_signature        (TpaParameters *self,
                                                         const gchar *name,
                                                         const gchar *signature);
gboolean            tpa_parameters_remove               (TpaParameters *self,
                                                         const gchar *name);
GPtrArray*          tpa_parameters_get_all              (TpaParameters *self);
GPtrArray*          tpa_parameters_get_required         (TpaParameters *self);
GPtrArray*          tpa_parameters_get_register         (TpaParameters *self);
GValue*             tpa_parameters_get_default_value    (TpaParameters *self,
                                                         const gchar *name);
gchar*              tpa_parameters_get_default_value_as_string
                                                        (TpaParameters *self,
                                                         const gchar *name);
guint               tpa_parameters_get_default_value_as_uint
                                                        (TpaParameters *self,
                                                         const gchar *name);
gint                tpa_parameters_get_default_value_as_int
                                                        (TpaParameters *self,
                                                         const gchar *name);
gboolean            tpa_parameters_get_default_value_as_boolean
                                                        (TpaParameters *self,
                                                         const gchar *name);
gboolean            tpa_parameters_set_default_value    (TpaParameters *self,
                                                         const gchar *name,
                                                         GValue *value);
gboolean            tpa_parameters_set_default_value_as_string
                                                        (TpaParameters *self,
                                                         const gchar *name,
                                                         const gchar *value_as_string);
gboolean            tpa_parameters_set_default_value_as_uint
                                                        (TpaParameters *self,
                                                         const gchar *name,
                                                         guint value_as_uint);
gboolean            tpa_parameters_set_default_value_as_int
                                                        (TpaParameters *self,
                                                         const gchar *name,
                                                         gint value_as_int);
gboolean            tpa_parameters_set_default_value_as_boolean
                                                        (TpaParameters *self,
                                                         const gchar *name,
                                                         gboolean value_as_boolean);
GValue*             tpa_parameters_get_value            (TpaParameters *self,
                                                         const gchar *name);
gchar*              tpa_parameters_get_value_as_string  (TpaParameters *self,
                                                         const gchar *name);
guint               tpa_parameters_get_value_as_uint    (TpaParameters *self,
                                                         const gchar *name);
gint                tpa_parameters_get_value_as_int     (TpaParameters *self,
                                                         const gchar *name);
gboolean            tpa_parameters_get_value_as_boolean (TpaParameters *self,
                                                         const gchar *name);
gboolean            tpa_parameters_set_value            (TpaParameters *self,
                                                         const gchar *name,
                                                         GValue *value);
gboolean            tpa_parameters_set_value_as_string  (TpaParameters *self,
                                                         const gchar *name,
                                                         const gchar *value_as_string);
gboolean            tpa_parameters_set_value_as_uint    (TpaParameters *self,
                                                         const gchar *name,
                                                         guint value_as_uint);
gboolean            tpa_parameters_set_value_as_int     (TpaParameters *self,
                                                         const gchar *name,
                                                         gint value_as_int);
gboolean            tpa_parameters_set_value_as_boolean (TpaParameters *self,
                                                         const gchar *name,
                                                         gboolean value_as_boolen);
void                tpa_parameters_reset                (TpaParameters *self);
TpaParameterFlags   tpa_parameters_get_flags            (TpaParameters *self,
                                                         const gchar *name);
#define             tpa_parameters_has_required_flag    (self, name)
#define             tpa_parameters_has_register_flag    (self, name)
#define             tpa_parameters_has_default_flag     (self, name)
gboolean            tpa_parameters_set_flags            (TpaParameters *self,
                                                         const gchar *name,
                                                         TpaParameterFlags flags);
#define             tpa_parameters_set_required_flag    (self, name)
#define             tpa_parameters_set_register_flag    (self, name)
#define             tpa_parameters_set_default_flag     (self, name)
GHashTable*         tpa_parameters_get_formatted_table  (TpaParameters *self);

Object Hierarchy


  GObject
   +----TpaParameters

Description

Details

TPA_PARAMETERS_GET_PRIVATE()

#define             TPA_PARAMETERS_GET_PRIVATE(obj)

obj :

TpaParameter

typedef struct _TpaParameter TpaParameter;


TpaParametersPrivate

typedef struct _TpaParametersPrivate TpaParametersPrivate;


TpaParameters

typedef struct _TpaParameters TpaParameters;


tpa_parameters_add ()

gboolean            tpa_parameters_add                  (TpaParameters *self,
                                                         const gchar *name,
                                                         GType type);

Add parameter name, if a parameter with same name was already added it will fail.

self : TpaParameters instance.
name : New Parameter name.
type : Parameter GType.
Returns : FALSE if fail.

tpa_parameters_add_signature ()

gboolean            tpa_parameters_add_signature        (TpaParameters *self,
                                                         const gchar *name,
                                                         const gchar *signature);

self :
name :
signature :
Returns :

tpa_parameters_remove ()

gboolean            tpa_parameters_remove               (TpaParameters *self,
                                                         const gchar *name);

Remove parameter if no parameter is found it will fail.

self : TpaParameters instance.
name : New Parameter name.
Returns : FALSE if fail.

tpa_parameters_get_all ()

GPtrArray*          tpa_parameters_get_all              (TpaParameters *self);

Get all parameters names available.

self : TpaParameters instance.
Returns : GPtrArray with parameters names.

tpa_parameters_get_required ()

GPtrArray*          tpa_parameters_get_required         (TpaParameters *self);

Get all parameters names available that has required flag.

self : TpaParameters instance.
Returns : GPtrArray with parameters names.

tpa_parameters_get_register ()

GPtrArray*          tpa_parameters_get_register         (TpaParameters *self);

Get all parameters names available that has register flag.

self : TpaParameters instance.
Returns : GPtrArray with parameters names.

tpa_parameters_get_default_value ()

GValue*             tpa_parameters_get_default_value    (TpaParameters *self,
                                                         const gchar *name);

Get copy of parameter default value that must be free.

self : TpaParameters instance
name : Parameter name.
Returns : NULL if fail.

tpa_parameters_get_default_value_as_string ()

gchar*              tpa_parameters_get_default_value_as_string
                                                        (TpaParameters *self,
                                                         const gchar *name);

Function to get any parameter default value to string. Note that self function convert parameter value to string.

Supports convertions to: boolean: "true" for TRUE value. "false" for FALSE value. double integer string

self : TpaParameters instance
name : Parameter name.
Returns : NULL if fail.

tpa_parameters_get_default_value_as_uint ()

guint               tpa_parameters_get_default_value_as_uint
                                                        (TpaParameters *self,
                                                         const gchar *name);

Fast function to get parameter default value that has known type as unsigned integer. DO NOT USE IT FOR NON-UINTEGER PARAMETERS.

self : TpaParameters instance
name : Parameter name.
Returns : 0 if fail.

tpa_parameters_get_default_value_as_int ()

gint                tpa_parameters_get_default_value_as_int
                                                        (TpaParameters *self,
                                                         const gchar *name);

Fast function to get parameter default value that has known type as integer. DO NOT USE IT FOR NON-INTEGER PARAMETERS.

self : TpaParameters instance
name : Parameter name.
Returns : 0 if fail.

tpa_parameters_get_default_value_as_boolean ()

gboolean            tpa_parameters_get_default_value_as_boolean
                                                        (TpaParameters *self,
                                                         const gchar *name);

Fast function to get parameter default value that has known type as boolean. DO NOT USE IT FOR NON-BOOLEAN PARAMETERS.

self : TpaParameters instance
name : Parameter name.
Returns : -1 if fail.

tpa_parameters_set_default_value ()

gboolean            tpa_parameters_set_default_value    (TpaParameters *self,
                                                         const gchar *name,
                                                         GValue *value);

Set parameter default value, givin value must hold the same type as parameter.

self : TpaParameters instance
name : Parameter name.
value : New GValue value.
Returns : FALSE if fail.

tpa_parameters_set_default_value_as_string ()

gboolean            tpa_parameters_set_default_value_as_string
                                                        (TpaParameters *self,
                                                         const gchar *name,
                                                         const gchar *value_as_string);

Function to set any string default value to parameter value. Note that self function convert the given value to parameter type if it is not string type.

Supports convertions to: boolean: "true" for TRUE value. "false" for FALSE value. double integer string

self : TpaParameters instance
name : Parameter name.
value_as_string : New string value or string to be converted.
Returns : FALSE if fail.

tpa_parameters_set_default_value_as_uint ()

gboolean            tpa_parameters_set_default_value_as_uint
                                                        (TpaParameters *self,
                                                         const gchar *name,
                                                         guint value_as_uint);

Fast function to set parameter default value that has known type as unsigned integer. DO NOT USE IT FOR NON-UINTEGER PARAMETERS.

self : TpaParameters instance
name : Parameter name.
value_as_uint : New integer value.
Returns : FALSE if fail.

tpa_parameters_set_default_value_as_int ()

gboolean            tpa_parameters_set_default_value_as_int
                                                        (TpaParameters *self,
                                                         const gchar *name,
                                                         gint value_as_int);

Fast function to set parameter default value that has known type as integer. DO NOT USE IT FOR NON-INTEGER PARAMETERS.

self : TpaParameters instance
name : Parameter name.
value_as_int : New integer value.
Returns : FALSE if fail.

tpa_parameters_set_default_value_as_boolean ()

gboolean            tpa_parameters_set_default_value_as_boolean
                                                        (TpaParameters *self,
                                                         const gchar *name,
                                                         gboolean value_as_boolean);

Fast function to set parameter dafault value that has known type as boolean. DO NOT USE IT FOR NON-BOOLEAN PARAMETERS.

self : TpaParameters instance
name : Parameter name.
value_as_boolean : New boolean value.
Returns : FALSE if fail.

tpa_parameters_get_value ()

GValue*             tpa_parameters_get_value            (TpaParameters *self,
                                                         const gchar *name);

Get copy of parameter value that must be free.

self : TpaParameters instance
name : Parameter name.
Returns : NULL if fail.

tpa_parameters_get_value_as_string ()

gchar*              tpa_parameters_get_value_as_string  (TpaParameters *self,
                                                         const gchar *name);

Function to get any parameter value to string. Note that self function convert parameter value to string.

Supports convertions to: boolean: "true" for TRUE value. "false" for FALSE value. double integer string

self : TpaParameters instance
name : Parameter name.
Returns : NULL if fail.

tpa_parameters_get_value_as_uint ()

guint               tpa_parameters_get_value_as_uint    (TpaParameters *self,
                                                         const gchar *name);

Fast function to get parameter value that has known type as unsigned integer. DO NOT USE IT FOR NON-UINTEGER PARAMETERS.

self : TpaParameters instance
name : Parameter name.
Returns : 0 if fail.

tpa_parameters_get_value_as_int ()

gint                tpa_parameters_get_value_as_int     (TpaParameters *self,
                                                         const gchar *name);

Fast function to get parameter value that has known type as integer. DO NOT USE IT FOR NON-INTEGER PARAMETERS.

self : TpaParameters instance
name : Parameter name.
Returns : 0 if fail.

tpa_parameters_get_value_as_boolean ()

gboolean            tpa_parameters_get_value_as_boolean (TpaParameters *self,
                                                         const gchar *name);

Fast function to get parameter value that has known type as boolean. DO NOT USE IT FOR NON-BOOLEAN PARAMETERS.

self : TpaParameters instance
name : Parameter name.
Returns : -1 if fail.

tpa_parameters_set_value ()

gboolean            tpa_parameters_set_value            (TpaParameters *self,
                                                         const gchar *name,
                                                         GValue *value);

Set parameter value, givin value must hold the same type as parameter.

self : TpaParameters instance
name : Parameter name.
value : New GValue value.
Returns : FALSE if fail.

tpa_parameters_set_value_as_string ()

gboolean            tpa_parameters_set_value_as_string  (TpaParameters *self,
                                                         const gchar *name,
                                                         const gchar *value_as_string);

Function to set any string value to parameter value. Note that this function convert the given value to parameter type if it is not string type.

Supports convertions to: boolean: "true" for TRUE value "false" for FALSE value double integer string

self : TpaParameters instance
name : Parameter name.
value_as_string : New string value or string to be converted.
Returns : FALSE if fail.

tpa_parameters_set_value_as_uint ()

gboolean            tpa_parameters_set_value_as_uint    (TpaParameters *self,
                                                         const gchar *name,
                                                         guint value_as_uint);

Fast function to set parameter value that has known type as unsigned integer. DO NOT USE IT FOR NON-UINTEGER PARAMETERS.

self : TpaParameters instance
name : Parameter name.
value_as_uint : New unsigned integer value.
Returns : FALSE if fail.

tpa_parameters_set_value_as_int ()

gboolean            tpa_parameters_set_value_as_int     (TpaParameters *self,
                                                         const gchar *name,
                                                         gint value_as_int);

Fast function to set parameter value that has known type as integer. DO NOT USE IT FOR NON-INTEGER PARAMETERS.

self : TpaParameters instance
name : Parameter name.
value_as_int : New integer value.
Returns : FALSE if fail.

tpa_parameters_set_value_as_boolean ()

gboolean            tpa_parameters_set_value_as_boolean (TpaParameters *self,
                                                         const gchar *name,
                                                         gboolean value_as_boolen);

Fast function to set parameter value that has known type as boolean. DO NOT USE IT FOR NON-BOOLEAN PARAMETERS.

self : TpaParameters instance
name : Parameter name.
value_as_boolen :
Returns : FALSE if fail.

tpa_parameters_reset ()

void                tpa_parameters_reset                (TpaParameters *self);

Reset all parameters to its default values. Note that this operation discard old parameter value.

self : TpaParameters instance

tpa_parameters_get_flags ()

TpaParameterFlags   tpa_parameters_get_flags            (TpaParameters *self,
                                                         const gchar *name);

Get parameter flags.

self : TpaParameters instance
name : Parameter name.
Returns : TpaParameterFlags

tpa_parameters_has_required_flag()

#define             tpa_parameters_has_required_flag(self, name)

self :
name :

tpa_parameters_has_register_flag()

#define             tpa_parameters_has_register_flag(self, name)

self :
name :

tpa_parameters_has_default_flag()

#define             tpa_parameters_has_default_flag(self, name)

self :
name :

tpa_parameters_set_flags ()

gboolean            tpa_parameters_set_flags            (TpaParameters *self,
                                                         const gchar *name,
                                                         TpaParameterFlags flags);

Set parameter flags.

self : TpaParameters instance
name :
flags :
Returns : FALSE if fail.

tpa_parameters_set_required_flag()

#define             tpa_parameters_set_required_flag(self, name)

self :
name :

tpa_parameters_set_register_flag()

#define             tpa_parameters_set_register_flag(self, name)

self :
name :

tpa_parameters_set_default_flag()

#define             tpa_parameters_set_default_flag(self, name)

self :
name :

tpa_parameters_get_formatted_table ()

GHashTable*         tpa_parameters_get_formatted_table  (TpaParameters *self);

Function to format parameters into a new GHashTable to be sent to connection managers.

self : TpaParameters instance
Returns : formatted parameters into a GHashTable or NULL if fail.