UF_MOM_ask_assoc_double_array (view source)
Defined in: uf_mom.h
Overview
This function returns the value of an associative double array in the
Event Handler attached to the specified UF_MOM object.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
gateway
int UF_MOM_ask_assoc_double_array
(
UF_MOM_id_t mom,
char * array_name,
char * index_name,
double * value
)
| UF_MOM_id_t | mom | Input | - the mom object that owns the array |
| char * | array_name | Input | - the name of the array to ask |
| char * | index_name | Input | - the name of the index |
| double * | value | Output | - the value asked for |
UF_MOM_ask_assoc_int_array (view source)
Defined in: uf_mom.h
Overview
This function returns the value of an associative integer array in the
Event Handler attached to the specified UF_MOM object.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
gateway
int UF_MOM_ask_assoc_int_array
(
UF_MOM_id_t mom,
char * array_name,
char * index_name,
int * value
)
| UF_MOM_id_t | mom | Input | - the mom object that owns the array |
| char * | array_name | Input | - the name of the array to ask |
| char * | index_name | Input | - the name of the index |
| int * | value | Output | - the value asked for |
UF_MOM_ask_assoc_string_array (view source)
Defined in: uf_mom.h
Overview
This function returns the value of an associative string array in the
Event Handler attached to the specified UF_MOM object.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
gateway
int UF_MOM_ask_assoc_string_array
(
UF_MOM_id_t mom,
char * array_name,
char * index_name,
char * * value
)
| UF_MOM_id_t | mom | Input | - the mom object that owns the array |
| char * | array_name | Input | - the name of the array to ask |
| char * | index_name | Input | - the name of the index |
| char * * | value | Output to UF_*free* | - the value asked for |
UF_MOM_ask_double_array (view source)
Defined in: uf_mom.h
Overview
This function asks the values of an double array in the Event Handler
attached to the specified UF_MOM object.
The indicies will be 0, 1, ..., num_of_values - 1.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
gateway
int UF_MOM_ask_double_array
(
UF_MOM_id_t mom,
char * array_name,
int num_of_values,
double * values
)
| UF_MOM_id_t | mom | Input | - the mom object that owns the array |
| char * | array_name | Input | - the name of the array to ask |
| int | num_of_values | Input | - the number of values to ask |
| double * | values | Input / Output | the values asked for. This must
point at num_of_values sizeof(double)
bytes |
UF_MOM_ask_double_array_2d (view source)
Defined in: uf_mom.h
Overview
This function returns the value of an element of a 2D double array in the Event
Handler attached to the specified UF_MOM object.
Environment
Internal and External
History
Originally released in NX2.0
Required License(s)
gateway
int UF_MOM_ask_double_array_2d
(
UF_MOM_id_t mom,
char * array_name,
int index1,
int index2,
double * value
)
| UF_MOM_id_t | mom | Input | - the mom object that owns the array |
| char * | array_name | Input | - the name of the array |
| int | index1 | Input | - the first index |
| int | index2 | Input | - the second index |
| double * | value | Output | - the value |
UF_MOM_ask_int_array (view source)
Defined in: uf_mom.h
Overview
This function asks the values of an integer array in the Event Handler
attached to the specified UF_MOM object.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
gateway
int UF_MOM_ask_int_array
(
UF_MOM_id_t mom,
char * array_name,
int num_of_values,
int * values
)
| UF_MOM_id_t | mom | Input | - the mom object that owns the array |
| char * | array_name | Input | - the name of the array to ask |
| int | num_of_values | Input | - the number of values to ask |
| int * | values | Input / Output | the values asked for, this must
point at num_of_values sizeof(int) bytes |
UF_MOM_ask_interp_from_param (view source)
Defined in: uf_mom.h
Overview
Given the param argument passed as the first argument to a CAM exit
this function returns its associated TCL interpreter.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
gateway
int UF_MOM_ask_interp_from_param
(
void * param,
void * * interp
)
| void * | param | Input | - see above |
| void * * | interp | Output to UF_*free* | - see above |
UF_MOM_ask_mom (view source)
Defined in: uf_mom.h
Overview
This function extracts and returns the UF_MOM object that is associated
with the User Exit (ufusr style) first parameter 'param'. This is useful
when coding an entry point in a library that is going to be called by
using the TCL extension MOM_run_user_function <library> <entry point>.
This enables you to get the UF_MOM_id_t that you need to pass to other
UF_MOM user function functions.
<entry point> has a ufusr signature.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
gateway
int UF_MOM_ask_mom
(
void * param,
UF_MOM_id_t * mom_id
)
UF_MOM_ask_string (view source)
Defined in: uf_mom.h
Overview
This function returns the value of the TCL variable 'var_name' as it
currently is in the interpreter owned by 'mom_id'.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
gateway
int UF_MOM_ask_string
(
UF_MOM_id_t mom_id,
char * var_name,
const char * * var_val
)
| UF_MOM_id_t | mom_id | Input | - see above |
| char * | var_name | Input | - see above |
| const char * * | var_val | Output to UF_*free* | - see above |
UF_MOM_ask_string_array (view source)
Defined in: uf_mom.h
Overview
This function asks the values of a string array in the Event Handler
attached to the specified UF_MOM object.
The indicies will be 0, 1, ..., num_of_values - 1.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
gateway
int UF_MOM_ask_string_array
(
UF_MOM_id_t mom,
char * array_name,
int num_of_values,
char * * values
)
| UF_MOM_id_t | mom | Input | - the mom object that owns the array |
| char * | array_name | Input | - the name of the array to ask |
| int | num_of_values | Input | - the number of values to ask |
| char * * | values | Output to UF_*free* | - the values asked for. The caller
has already allocated memory for the
pointers. The memory pointed at by the
pointers is allocated by this function
and must be freed by caller. |
UF_MOM_execute_command (view source)
Defined in: uf_mom.h
Overview
This function execute a given command in the TCL Interpreter via Tcl_Eval
Environment
Internal and External
History
Originally released in NX2
Required License(s)
cam_base
int UF_MOM_execute_command
(
UF_MOM_id_t mom,
char * command
)
| UF_MOM_id_t | mom | Input | - the mom object |
| char * | command | Input | - the name of the command to be eval'ed |
UF_MOM_extend_xlator (view source)
Defined in: uf_mom.h
Overview
This function attaches the entry point 'c_func' to the TCL procedure
named 'command_name' in the TCL interpreter owned by the UF_MOM_id_t
object 'mom_id'. After this call is completed, any calls to 'command_name'
from the interpreter will cause 'c_func' to be executed.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
cam_base
int UF_MOM_extend_xlator
(
UF_MOM_id_t mom_id,
char * command_name,
UF_MOM_command_func c_func
)
UF_MOM_set_assoc_double_array (view source)
Defined in: uf_mom.h
Overview
This function sets the value of an associative double array in the
Event Handler attached to the specified UF_MOM object.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
cam_base
int UF_MOM_set_assoc_double_array
(
UF_MOM_id_t mom,
char * array_name,
char * index_name,
double value
)
| UF_MOM_id_t | mom | Input | - the mom object that owns the array |
| char * | array_name | Input | - the name of the array to set |
| char * | index_name | Input | - the name of the index |
| double | value | Input | - the value to set |
UF_MOM_set_assoc_int_array (view source)
Defined in: uf_mom.h
Overview
This function sets the value of an associative integer array in the
Event Handler attached to the specified UF_MOM object.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
cam_base
int UF_MOM_set_assoc_int_array
(
UF_MOM_id_t mom,
char * array_name,
char * index_name,
int value
)
| UF_MOM_id_t | mom | Input | - the mom object that owns the array |
| char * | array_name | Input | - the name of the array to set |
| char * | index_name | Input | - the name of the index |
| int | value | Input | - the value to set |
UF_MOM_set_assoc_string_array (view source)
Defined in: uf_mom.h
Overview
This function sets the value of an associative string array in the
Event Handler attached to the specified UF_MOM object.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
cam_base
int UF_MOM_set_assoc_string_array
(
UF_MOM_id_t mom,
char * array_name,
char * index_name,
char * value
)
| UF_MOM_id_t | mom | Input | - the mom object that owns the array |
| char * | array_name | Input | - the name of the array to set |
| char * | index_name | Input | - the name of the index |
| char * | value | Input | - the value to set |
UF_MOM_set_double (view source)
Defined in: uf_mom.h
Overview
This function sets the value of the TCL variable 'var_name' to the
value 'var_val' in the interpreter owned by 'mom_id'.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
cam_base
int UF_MOM_set_double
(
UF_MOM_id_t mom_id,
char * var_name,
double var_val
)
| UF_MOM_id_t | mom_id | Input | - see above |
| char * | var_name | Input | - see above |
| double | var_val | Input | - see above |
UF_MOM_set_double_array (view source)
Defined in: uf_mom.h
Overview
This function sets the values of an double array in the Event Handler
attached to the specified UF_MOM object.
The indicies will be 0, 1, ..., num_of_values - 1.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
cam_base
int UF_MOM_set_double_array
(
UF_MOM_id_t mom,
char * array_name,
int num_of_values,
double values [ ]
)
| UF_MOM_id_t | mom | Input | - the mom object that owns the array |
| char * | array_name | Input | - the name of the array to set |
| int | num_of_values | Input | - the number of values to set |
| double | values [ ] | Input | - the values to set |
UF_MOM_set_int (view source)
Defined in: uf_mom.h
Overview
This function sets the value of the TCL variable 'var_name' to the
value 'var_val' in the interpreter owned by 'mom_id'.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
cam_base
int UF_MOM_set_int
(
UF_MOM_id_t mom_id,
char * var_name,
int var_val
)
| UF_MOM_id_t | mom_id | Input | - see above |
| char * | var_name | Input | - see above |
| int | var_val | Input | - see above |
UF_MOM_set_int_array (view source)
Defined in: uf_mom.h
Overview
This function sets the values of an integer array in the Event Handler
attached to the specified UF_MOM object.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
cam_base
int UF_MOM_set_int_array
(
UF_MOM_id_t mom,
char * array_name,
int num_of_values,
int values [ ]
)
| UF_MOM_id_t | mom | Input | - the mom object that owns the array |
| char * | array_name | Input | - the name of the array to set |
| int | num_of_values | Input | - the number of values to set |
| int | values [ ] | Input | the values to set |
UF_MOM_set_string (view source)
Defined in: uf_mom.h
Overview
This function sets the value of the TCL variable 'var_name' to the
value 'var_val' in the interpreter owned by 'mom_id'.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
cam_base
int UF_MOM_set_string
(
UF_MOM_id_t mom_id,
char * var_name,
char * var_val
)
| UF_MOM_id_t | mom_id | Input | - see above |
| char * | var_name | Input | - see above |
| char * | var_val | Input | - see above |
UF_MOM_set_string_array (view source)
Defined in: uf_mom.h
Overview
This function sets the values of a string array in the Event Handler
attached to the specified UF_MOM object.
The indicies will be 0, 1, ..., num_of_values - 1.
Environment
Internal and External
History
Originally released in V14.0
Required License(s)
cam_base
int UF_MOM_set_string_array
(
UF_MOM_id_t mom,
char * array_name,
int num_of_values,
char * * values
)
| UF_MOM_id_t | mom | Input | - the mom object that owns the array |
| char * | array_name | Input | - the name of the array to set |
| int | num_of_values | Input | - the number of values to set |
| char * * | values | Input | - the values to set |