All Frameworks  Class Hierarchy  This Framework  Indexes

SPAds Global Function DM_print_dmod

void DM_print_dmod(	int&	`rtn_err`,
	DS_dmod*	`dmod`,
	FILE*	`file`,
	int	`walk_flag`	`=0`,
	SDM_options*	`sdmo`	`=NULL`)

Generates a deformable model report and returns 0 for success or an error.

Role: Modifies file.

Using fprintf statements, writes a report about the deformable model and its tag objects. When walk_flag is equal to 0 then the report covers only the input deformable model object. When walk_flag is equal to 1 then the report is written for deformable model and all deformable model's offspring. When walk_flag is 2 then the report is written for the deformable model, its siblings, and all their offspring.

Errors:

DM_NULL_INPUT_PTR: The deformable model cannot be NULL on entry.
DM_BAD_WALK_FLAG_VALUE: when walk_flag is not 0, 1, or 2.

Effect: Changes model

Parameters:

rtn_err: out: 0=success or negative err code.
dmod: in: target dmod to query.
file: in: stream to be written.
walk_flag: in: specify how deep to go 0=dmod only, 1=dmod & offspring 2=dmod, siblings, and offspring.
sdmo: in:SDM_options pointer.

This object is included in the file: dmapi.hxx