All Frameworks  Class Hierarchy  This Framework  Indexes

SPAds Global Function DM_get_vector_load

void DM_get_vector_load(	int&	`rtn_err`,
	DS_dmod*	`dmod`,
	int	`tag`,
	double*	`image_vec`,
	double&	`gain`,
	SDM_options*	`sdmo`	`=NULL`)

Gets the vector load data and places it into return arguments and returns 0 for success or an error.

Role: Modifies image_vec, and gain.

Looks for a vector load identified by tag in the entire patch hierarchy. When the tag specifies a DS_vector_load, fills all the output arguments appropriately and returns 0. Changes the active deformable model to the one containing the load. Otherwise, returns the error DM_TAG_OBJECT_NOT_FOUND and leaves output arguments unmodified.

Errors:

DM_NULL_INPUT_PTR: The deformable model cannot be NULL on entry.
DM_NULL_OUTPUT_PTR: The image vector is NULL on entry.
DM_TAG_OBJECT_NOT_FOUND: The input tag cannot identify a deformable model, a load, a spring, a spring set, an attractor object, or a constraint in the model hierarchy.

Effect: Changes model

Parameters:

rtn_err: out: 0=success or negative err code.
dmod: in: member of target dmod hierarchy to search.
tag: in: load identifier.
image_vec: out: image_vec for vector_load direction sized:[image_dim].
gain: out: magnitude of load gain.
sdmo: in:SDM_options pointer note: sets active dmod.

This object is included in the file: dmapi.hxx