Main Page | Modules

Control Point Geometry Parameter
[NEES NTCP Types]

Functions

Detailed Description

This section describes the functions which may be executed to access the values of a NTCP geometry parameter associated with a control point.

Function Documentation

int nees_ntcp_geom_parameter_init (  nees_ntcp_geom_parameter_t *  geom_parameter  ) 
 

Construct a new geometry parameter for a control point.

Parameters:
geom_parameter A pointer to a nees_ntcp_geom_parameter_t. This function will allocated a new geometry parameter and modify the value pointed to by this to point to the new geometry parameter. The plugin must destroy this geometry parameter when it is no longer needed by calling nees_ntcp_control_point_geom_parameter_destroy().
Returns:
This function returns 0 if the geometry parameter was allocated successfully; otherwise, it returns a non-zero value and the value of control_point is undefined.
Return values:
NEES_NTCP_CONTROL_PLUGIN_OK The geometry parameter was successfully initialized.
NEES_NTCP_CONTROL_PLUGIN_INVALID_PARAMETER The geom_parameter passed to this function was NULL.
NEES_NTCP_CONTROL_PLUGIN_OUT_OF_MEMORY There is not enough free memory to initialize the geometry parameter.

int nees_ntcp_geom_parameter_copy (  const nees_ntcp_geom_parameter_t  original,
nees_ntcp_geom_parameter_t *  copy
) 
 

Copy a geometry parameter.

Parameters:
original The original geometry parameter to copy.
copy A pointer to a nees_ntcp_geom_parameter_t. This function will allocated a new geometry parameter and modify the value pointed to by this to point to the new parameter. The name and values of the copy will match that of the original parameter. The plugin must destroy this geometry parameter when no longer needed by calling nees_ntcp_control_point_geom_parameter_destroy().
Returns:
This function returns 0 if the arguments to this function are valid and the parameter was copied successfully; it returns a non-zero value otherwise.
Return values:
NEES_NTCP_CONTROL_PLUGIN_OK The geometry parameter was successfully copied to copy.
NEES_NTCP_CONTROL_PLUGIN_INVALID_PARAMETER One of the parameters to this function was null.
NEES_NTCP_CONTROL_PLUGIN_OUT_OF_MEMORY There is not enough free memory to copy the geometry parameter.

int nees_ntcp_geom_parameter_destroy (  nees_ntcp_geom_parameter_t  geom_parameter  ) 
 

Destroy a geometry parameter.

Parameters:
geom_parameter The geometry parameter to destroy. After this function returns, the plugin must no longer access this geometry parameter. A plugin should only pass geometry parameters to this function which it had created by calling nees_ntcp_geom_parameter_init(), nees_ntcp_geom_parameter_copy(), or nees_ntcp_control_point_get_geometry_parameter().
Returns:
This function returns 0 if the arguments to this function are valid and the geometry parameter was destroyed successfully; it returns a non-zero value otherwise.
Return values:
NEES_NTCP_CONTROL_PLUGIN_OK The geometry parameter was successfully destroyed.
NEES_NTCP_CONTROL_PLUGIN_INVALID_PARAMETER The geom_parameter passed to this function was null.

int nees_ntcp_geom_parameter_get_axis (  const nees_ntcp_geom_parameter_t  geom_parameter,
nees_ntcp_geom_axis_t *  result_axis
) 
 

Get the axis of a geometry parameter.

Parameters:
geom_parameter The geometry parameter to query.
result_axis A pointer to a nees_ntcp_geom_axis_t. This function will modify the value pointed to by this geometry parameter to contain the current axis of the geometry parameter passed as the geom_parameter argument.
Returns:
This function returns 0 if the arguments to this function are valid and the result_axis was modified successfully; it returns a non-zero value otherwise.
Return values:
NEES_NTCP_CONTROL_PLUGIN_OK The geometry parameter's axis was successfully copied to result_axis.
NEES_NTCP_CONTROL_PLUGIN_INVALID_PARAMETER One of the parameters passed to this function was null.
See also:
nees_ntcp_geom_axis_t

int nees_ntcp_geom_parameter_get_parameter_name (  nees_ntcp_geom_parameter_t  geom_parameter,
nees_ntcp_geom_parameter_name_t *  result_name
) 
 

Get the name of a geometry parameter.

Parameters:
geom_parameter The geometry parameter to query.
result_name A pointer to a nees_ntcp_geom_parameter_name_t. This function will modify the value pointed to by this geometry parameter to contain the current parameter name of the geometry parameter passed as the geom_parameter argument.
Returns:
This function returns 0 if the arguments to this function are valid and the result_parameter_name was modified successfully; it returns a non-zero value otherwise.
Return values:
NEES_NTCP_CONTROL_PLUGIN_OK The geometry parameter's name was successfully copied to result_name.
NEES_NTCP_CONTROL_PLUGIN_INVALID_PARAMETER One of the parameters passed to this function was null.
See also:
nees_ntcp_geom_parameter_name_t

int nees_ntcp_geom_parameter_get_value (  nees_ntcp_geom_parameter_t  geom_parameter,
double *  result_value
) 
 

Get the value of a geometry parameter.

Parameters:
geom_parameter The geometry parameter to query.
result_value A pointer to a double. This function will modify the value pointed to by this geometry parameter to contain the current value of the geometry parameter passed as the geom_parameter argument.
Returns:
This function returns 0 if the arguments to this function are valid and the result_value was modified successfully; it returns a non-zero value otherwise.
Return values:
NEES_NTCP_CONTROL_PLUGIN_OK The geometry parameter's value was successfully copied to result_value.
NEES_NTCP_CONTROL_PLUGIN_INVALID_PARAMETER One of the parameters passed to this function was null.

int nees_ntcp_geom_parameter_set_all (  nees_ntcp_geom_parameter_t  geom_parameter,
nees_ntcp_geom_axis_t  axis,
nees_ntcp_geom_parameter_name_t  name,
double  value
) 
 

Set all data values of a geometry parameter.

Parameters:
geom_parameter The geometry parameter to modify.
axis The new value of the axis. If this is NEES_NTCP_AXIS_NONE then the value of the axis in the geometry parameter will not be modified.
name The new value of the axis. If this is NEES_NTCP_PARAMETER_NONE then the value of the axis in the geometry parameter will not be modified.
value The new value of the geometry parameter.
Returns:
This function returns 0 if the arguments to this function are valid and the geom_parameter was modified successfully; it returns a non-zero value otherwise.
Return values:
NEES_NTCP_CONTROL_PLUGIN_OK The geometry parameter was modified to contain the passed values.
NEES_NTCP_CONTROL_PLUGIN_INVALID_PARAMETER The geom_paramter passed to this function was null, or one of the axis or name values contains an illegal value.

int nees_ntcp_geom_parameter_set_axis (  nees_ntcp_geom_parameter_t  geom_parameter,
nees_ntcp_geom_axis_t  axis
) 
 

Set the axis of a geometry parameter.

Parameters:
geom_parameter The geometry parameter to modify.
axis The new value of the axis. If this is NEES_NTCP_AXIS_NONE then the value of the axis in the geometry parameter will not be modified.
Returns:
This function returns 0 if the arguments to this function are valid and the geom_parameter was modified successfully; it returns a non-zero value otherwise.
Return values:
NEES_NTCP_CONTROL_PLUGIN_OK The geometry parameter was modified to have the new value of axis.
NEES_NTCP_CONTROL_PLUGIN_INVALID_PARAMETER The geom_paramter passed to this function was null, or the axis value is invalid.

int nees_ntcp_geom_parameter_set_parameter_name (  nees_ntcp_geom_parameter_t  geom_parameter,
nees_ntcp_geom_parameter_name_t  parameter_name
) 
 

Set the parameter name of a geometry parameter.

Parameters:
geom_parameter The geometry parameter to modify.
parameter_name The new value of the axis. If this is NEES_NTCP_PARAMETER_NONE then the value of the axis in the geometry parameter will not be modified.
Returns:
This function returns 0 if the arguments to this function are valid and the geom_parameter was modified successfully; it returns a non-zero value otherwise.
Return values:
NEES_NTCP_CONTROL_PLUGIN_OK The geometry parameter was modified to have the new value of parameter_name.
NEES_NTCP_CONTROL_PLUGIN_INVALID_PARAMETER The geom_paramter passed to this function was null, or the parameter_name value is invalid.

int nees_ntcp_geom_parameter_set_value (  nees_ntcp_geom_parameter_t  geom_parameter,
double  value
) 
 

Set the value of a geometry parameter.

Parameters:
geom_parameter The geometry parameter to modify.
value The new value of the geometry parameter.
Returns:
This function returns 0 if the arguments to this function are valid and the geom_parameter was modified successfully; it returns a non-zero value otherwise.
Return values:
NEES_NTCP_CONTROL_PLUGIN_OK The geometry parameter was modified to have the new value of value.
NEES_NTCP_CONTROL_PLUGIN_INVALID_PARAMETER The geom_paramter passed to this function was null.

about globus | grid research | globus toolkit | software development

Comments? webmaster@globus.org