All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

SPAintr Class insanity_data

SPAbase.ACIS_OBJECT
  |
  +---SPAbase.error_info
    |
    +---SPAkern.entity_error_info
      |
      +---insanity_data

Usage: you must use this class as is. You should never derive it.

public class insanity_data

This class holds information about problems (insanities) found when checking an ACIS model.

Role: As an ACIS model is checked, a list of problems or insanities is generated. The information about each insanity is stored an insanity_data object. The insanity_data objects are stored and accessed using the insanity_list class. The insanity_data class provides member methods for accessing information about the insanity.

See also:: insanity_list

Constructor and Destructor Index

o insanity_data(): C++ allocation constructor requests memory for this object but does not populate it.
o insanity_data(ENTITY*,int,insanity_type,primary_fail_fn,subsequent_fail_fn,insanity_sub_category&): Makes an insanity data.

Method Index

o get_aux_msg(): Gets the auxiliary message (with any parameters filled in) as a new string.
o get_ent(): Gets ENTITY.
o get_insane_id(): Gets insane_id.
o get_message(): Gets the error or insanity message.
o get_par_pos(SPApar_pos&): Sets uv to the related surface parameter position for the error, if relevant.
o get_sub_category(): Returns the sub-category for this instance.
o get_type(): Gets insanity type.
o print_message(FILE*): Prints the message into the file.
o recheck(): Re-checks the sanity of the entity with the failed check function.
o set_par_pos(SPApar_pos&): Set the parameter position property for this instance.

Constructor and Destructor

o insanity_data

public insanity_data(

)

C++ allocation constructor requests memory for this object but does not populate it.

o insanity_data

public insanity_data(	ENTITY*	`e`,
	int	`id`,
	insanity_type	`type`,
	primary_fail_fn	`pfunc`	`= NULL`,
	subsequent_fail_fn	`sub_pfunc`	`= NULL`,
	const insanity_sub_category&	`sub_category`	`= NO_SUB_CATEGORY` )

Makes an insanity data.

Parameters:

e: entity to check.
id: insanity id.
type: type of insanity.
pfunc: primary function.
sub_pfunc: subsequent function.
sub_category: insanity sub category - default is NO_SUB_CATEGORY.

Methods

o get_aux_msg

public char* get_aux_msg(

)const

Gets the auxiliary message (with any parameters filled in) as a new string. The caller is responsible for deleting the returned string. If no auxiliary message is present, a null pointer is returned.

Typically, a non-null auxiliary message will contain tab and newline characters, and may be broken over several lines.

o get_ent

public ENTITY* get_ent(

)const

Gets ENTITY.

o get_insane_id

public int get_insane_id(

)const

Gets insane_id. The insanity message string can be obtained from insanity_data::get_message().

o get_message

public const char* get_message(

)

Gets the error or insanity message.

o get_par_pos

public logical get_par_pos( SPApar_pos& uv) const

Sets uv to the related surface parameter position for the error, if relevant. Returns TRUE if a relevant parameter position exists, otherwise FALSE. The uv position is undefined if the method returns FALSE.

Parameters:

uv: (Output) parameter position for error.

o get_sub_category

public insanity_sub_category get_sub_category(

)const

Returns the sub-category for this instance.

o get_type

public insanity_type get_type(

)const

Gets insanity type.

o print_message

public void print_message( FILE* fptr)

Prints the message into the file.

Parameters:

fptr: file pointer.

o recheck

public insanity_list* recheck(

)

Re-checks the sanity of the entity with the failed check function.

o set_par_pos

public void set_par_pos( const SPApar_pos& uv)

Set the parameter position property for this instance.

Parameters:

uv: The parameter position to set.

This object is included in the file: insanity_list.hxx