Home

curvature_error_info Class Reference
[Offset Face and Wire]

Error information from an offset surface operation. More...

#include <offserr_info.hxx>

Inheritance diagram for curvature_error_info:

Inheritance graph
[legend]
Collaboration diagram for curvature_error_info:

Collaboration graph
[legend]

List of all members.

Public Member Functions

void add ()
 Increments the use count.
void add_entities (const ENTITY_LIST &entities)
 Adds entities to this error_info, if not already there.
void add_entity (ENTITY *ent)
 Adds an entity to this error_info, if not already there.
 curvature_error_info (SPApar_pos *uv_param, int num_par, double offset_distance, ENTITY *face=NULL, double rad_crv=0)
 Constructor.
char const * error_message () const
 Returns the message string of the error that this error_info_base object is encapsulating.
err_mess_type error_number () const
 Returns the error number of the error that this error_info_base object is encapsulating.
i_aux_data_holderget_aux_data () const
 Queries the auxiliary data provided by this error_info object.
void get_entities_alive (ENTITY_LIST &entities) const
 Adds all the alive entities that belong to this error_info to the incoming list of ENTITYs.
ENTITYget_entity ()
 Get error ENTITY.
int get_num_param ()
 Size of error uv parameters array.
double get_offset_distance ()
 Returns the offset distance.
logical get_positive_offset ()
 Returns if offset is positive.
double get_rad_crv ()
 Return radius of curvature.
const SPApar_posget_uv_param ()
 Array of UV error parameters.
logical has_reasons () const
 Returns TRUE if this error_info_base object has at least one reason; returns FALSE otherwise.
logical is_entity_dead ()
 Is error ENTITY dead.
void reasons (error_info_base_list &err_reasons) const
 Adds all the reasons of this error_info_base into the given list, err_reasons.
void reasons (error_info_list &err_reasons) const
 Adds all the reasons of this error_info to the given list, err_reasons.
void remove ()
 Decrements the use count.
void set_entity (ENTITY *ent)
 Set error ENTITY.
spa_outcome_severity_type severity () const
 Returns the severity of the error that this error_info_base object is encapsulating.
virtual int type () const
 Type ID of this object.
virtual ~curvature_error_info ()
 Destructor.

Static Public Member Functions

static int id ()
 Error ID.

Private Attributes

logical _entity_dead
 Is entity dead.
int _num_par
 number of parameters
double _offset_distance
 the offset distance (with respect to the sense of the face)
double _rad_crv
 the smaller of the two principal radii of curvature


Detailed Description

Error information from an offset surface operation.

Constructor & Destructor Documentation

curvature_error_info::curvature_error_info ( SPApar_pos uv_param,
int  num_par,
double  offset_distance,
ENTITY face = NULL,
double  rad_crv = 0 
)

Constructor.

Parameters:
uv_param Parameters at which error occurs number of uv parameters
offset_distance offset distance
face face where error took place radius of curvature

virtual curvature_error_info::~curvature_error_info (  )  [virtual]

Destructor.


Member Function Documentation

void error_info_base::add (  )  [inherited]

Increments the use count.

Customers should only have to pay attention to use counting if they explicitly call add.

void error_info::add_entities ( const ENTITY_LIST entities  )  [inherited]

Adds entities to this error_info, if not already there.



Any dead entity in the given list would not get added.

Parameters:
entities ENTITY_LIST to add

void error_info::add_entity ( ENTITY ent  )  [inherited]

Adds an entity to this error_info, if not already there.

Parameters:
ent pointer to an ENTITY that is to be added. This should not point to a NULL or a dead entity.

char const* error_info_base::error_message (  )  const [inherited]

Returns the message string of the error that this error_info_base object is encapsulating.

err_mess_type error_info_base::error_number (  )  const [inherited]

Returns the error number of the error that this error_info_base object is encapsulating.

i_aux_data_holder* error_info::get_aux_data (  )  const [inherited]

Queries the auxiliary data provided by this error_info object.

Returns NULL if no additional/auxiliary information is available. Note that the object (i.e., the i_aux_data_holder) returned by this function is owned by the caller and the memory needs to be cleaned up after use.

void error_info::get_entities_alive ( ENTITY_LIST entities  )  const [inherited]

Adds all the alive entities that belong to this error_info to the incoming list of ENTITYs.

Note that this method does not clear the given list of entities.

Parameters:
entities ENTITY_LIST to which the alive entities are added.

ENTITY* curvature_error_info::get_entity (  ) 

Get error ENTITY.

int curvature_error_info::get_num_param (  )  [inline]

Size of error uv parameters array.

double curvature_error_info::get_offset_distance (  )  [inline]

Returns the offset distance.

logical curvature_error_info::get_positive_offset (  )  [inline]

Returns if offset is positive.

double curvature_error_info::get_rad_crv (  )  [inline]

Return radius of curvature.

const SPApar_pos* curvature_error_info::get_uv_param (  )  [inline]

Array of UV error parameters.

logical error_info_base::has_reasons (  )  const [inherited]

Returns TRUE if this error_info_base object has at least one reason; returns FALSE otherwise.

static int curvature_error_info::id (  )  [static]

Error ID.

Reimplemented from offset_error_info.

logical curvature_error_info::is_entity_dead (  )  [inline]

Is error ENTITY dead.

void error_info_base::reasons ( error_info_base_list err_reasons  )  const [inherited]

Adds all the reasons of this error_info_base into the given list, err_reasons.

In some cases, an error_info_base may need to provide some additional information about the errors or problems that would have caused the error that is indicated by this error_info_base object. These additional errors and problems are stored as reasons. For example, an error_info_base object encapsulating the error 'Operation failed due to check errors' might include the list of check errors in the 'reasons' list.

Parameters:
err_reasons error_info_base_list to which the reasons are added.

void error_info::reasons ( error_info_list err_reasons  )  const [inherited]

Adds all the reasons of this error_info to the given list, err_reasons.

In some cases, error_info may need to provide some additional information about the errors or problems that would have caused the error that is indicated by this error_info object. These additional errors and problems are stored as 'reasons'. For example, an error_info object encapsulating the error 'Operation failed due to check errors' might include the list of check errors in the 'reasons' list.

Parameters:
err_reasons error_info_list to which the reasons are added

void error_info_base::remove (  )  [inherited]

Decrements the use count.

Customers should only have to pay attention to use counting if they explicitly call add.

void curvature_error_info::set_entity ( ENTITY ent  ) 

Set error ENTITY.

spa_outcome_severity_type error_info_base::severity (  )  const [inherited]

Returns the severity of the error that this error_info_base object is encapsulating.

virtual int curvature_error_info::type (  )  const [virtual]

Type ID of this object.

Reimplemented from offset_error_info.


Member Data Documentation

Is entity dead.

number of parameters

the offset distance (with respect to the sense of the face)

the smaller of the two principal radii of curvature