Home

WIRE Class Reference
[Topology]

Represents a collection of edges that are owned by a body but are not attached to faces and do not enclose any volume. More...

#include <wire.hxx>

Inheritance diagram for WIRE:

Inheritance graph
[legend]
Collaboration diagram for WIRE:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual void add ()
 If this ENTITY is use counted, adds one to the count.
virtual logical apply_transform (SPAtransf const &, ENTITY_LIST &, logical=FALSE, logical=TRUE)
 Transforms this ENTITY.
ATTRIB * attrib () const
 Returns this ENTITY's attribute pointer, or NULL if there is no attached attribute.
ENTITY * backup ()
 Creates a duplicate record and a change bulletin, if needed, as a backup for roll back.
BODY * body () const
 Returns the owner of this WIRE if the former is a BODY, otherwise NULL.
SPAbox * bound () const
 Returns a geometric bounding region (box) for this WIRE.
int bulletin_count () const
 Returns the number of bulletins referring to this ENTITY.
virtual logical call_method (METHOD_ID const &, METHOD_ARGS const &)
 Executes the implementation function for a routine virtual method.
COEDGE * coedge () const
 Returns a pointer to a COEDGE in this WIRE.
WIRECONTBIT cont () const
 Returns the containment information for this WIRE.
virtual ENTITY * copy_data (ENTITY_LIST &, pointer_map *pm=NULL, logical dpcpy_skip=FALSE, SCAN_TYPE reason=SCAN_COPY) const
 Allocates a new ENTITY and calls copy_common to fill it in.
virtual void copy_scan (ENTITY_LIST &, SCAN_TYPE reason=SCAN_COPY, logical dpcpy_skip=FALSE) const
 Adds dependent ENTITYs of this ENTITY to the list of ENTITYs to be copied.
virtual void debug_ent (FILE *) const
 Prints the type and address of this ENTITY, roll back pointer, attributes, and any unknown subtype information.
virtual logical deletable () const
 Indicates whether or not this ENTITY is normally destroyed by lose.
virtual void fix_pointers (ENTITY *[], SCAN_TYPE reason=SCAN_COPY)
 Converts pointers from copy indices into real pointers.
HISTORY_STREAM * history () const
 Returns a pointer to the history stream for this ENTITY.
virtual int identity (int=0) const
 Returns a type identifier for this ENTITY.
virtual logical is_deepcopyable () const
 Returns TRUE if this ENTITY can be deep copied.
virtual logical is_use_counted () const
 Indicates if this ENTITY is use-counted or not.
virtual int lookup (logical) const
 Looks up this ENTITY in the appropriate debug list.
virtual void lose ()
 Posts a delete bulletin to the bulletin board indicating the instance is no longer used in the active model.
logical needs_rollback () const
 Checks whether or not the record is already backed up.
WIRE * next (PAT_NEXT_TYPE next_type=PAT_CAN_CREATE) const
 Returns a pointer to the next WIRE in a complete enumeration of all the WIREs in a BODY or SHELL.
WIRE * next_in_list (PAT_NEXT_TYPE=PAT_CAN_CREATE) const
 Returns a pointer to the next WIRE in the list of WIREs contained directly by a BODY, SHELL, or SUBSHELL.
ENTITY * owner () const
 Returns a pointer to the owning entity.
virtual void remove (logical lose_if_zero=TRUE)
 Decrements the use count of this ENTITY.
void restore_common ()
 Restores data for a record from disc to memory.
void restore_end (char *id_str)
 Terminates a restore record.
BULLETIN *& rollback () const
 Returns the pointer to the bulletin board entry for this ENTITY.
virtual void save (ENTITY_LIST &) const
 Performs a save operation.
void set_attrib (ATTRIB *attr)
 Changes the attribute pointer of this ENTITY to point to the given attribute.
void set_body (BODY *body)
 Sets the WIRE's owning BODY to the specified BODY.
void set_bound (SPAbox *in_box)
 Sets the bounding region (box) of this WIRE to the specified box.
void set_coedge (COEDGE *coedge)
 Sets the first COEDGE in the list of COEDGEs belonging to this WIRE.
void set_cont (WIRECONTBIT cont)
 Sets the containment for this WIRE.
void set_next (WIRE *wire, logical reset_pattern=TRUE)
 Sets the next WIRE in the BODY's list of WIREs to the given WIRE.
void set_owner (ENTITY *owner)
 Set this WIRE's owner to be the specified BODY or SHELL.
void set_shell (SHELL *shell, logical reset_pattern=TRUE)
 Sets the WIRE's owning SHELL to the specified SHELL.
void set_subshell (SUBSHELL *subshell)
 Sets the SUBSHELL directly containing this WIRE to be the given SUBSHELL.
virtual void set_use_count (int use)
 Sets the reference use count of this ENTITY.
SHELL * shell () const
 Return a pointer to the owning SHELL.
virtual unsigned size () const
 Returns the size, in bytes, of this ENTITY.
SUBSHELL * subshell () const
 Returns a pointer to the SUBSHELL directly containing this WIRE.
tag_id_type tag (logical assign_new=TRUE) const
 Data reading routine.
virtual const char * type_name () const
 Returns a name for this ENTITY's type.
virtual int use_count () const
 Returns the use count of this ENTITY.
 WIRE (COEDGE *coedge, WIRE *wire)
 Constructs a WIRE from a list of COEDGEs and a connected WIRE already in the owning BODY.
 WIRE ()
 Constructs a WIRE (default constructor).

Static Public Member Functions

static MethodFunction add_method (METHOD_ID const &, MethodFunction)
 Registers an implementation function for a run-time virtual method.

Protected Member Functions

virtual logical bulletin_no_change_vf (ENTITY const *other, logical identical_comparator) const
 Virtual function for comparing subclass data - called by bulletin_no_change.
void check_destroy () const
 Checks that entity deletion is legitimate.
void copy_common (ENTITY_LIST &list, const ENTITY *from, pointer_map *pm=NULL, logical dpcpy_skip=FALSE, SCAN_TYPE reason=SCAN_COPY)
 Fills in this ENTITY with data from the copied ENTITY, converting pointers into indices in the supplied ENTITY_LIST.
void fix_common (ENTITY *[], SCAN_TYPE reason=SCAN_COPY)
 Converts pointers from copy indices into real pointers.
void fixup_copy (ENTITY *rollback) const
 Fixes any pointers in the ENTITY after copying for backup.
logical holds_pattern () const
 Returns TRUE if this entity can have a pattern_holder.
logical is_unknown_entity (void) const
 Returns TRUE if this is an unknown entity.
virtual void roll_notify (BULLETIN_TYPE bulletin_type, ENTITY *ent)
 Fields notifications of rollback operations.
void save_begin (logical terminator=FALSE) const
 Starts a save record.
void save_common (ENTITY_LIST &) const
 Handles the save operation.
void save_end (ENTITY_LIST &list) const
 Terminates a save record.

Detailed Description

Represents a collection of edges that are owned by a body but are not attached to faces and do not enclose any volume.


Role: A wire represents a connected collection of unembedded edges. It is owned by a body or a shell, the latter necessarily if the wire is attached to corners of faces in the shell, or if it is internal to a lump (which will own the shell). Isolated wires used to be owned by bodies, and may remain so, though they might logically go into a shell owned by a lump owned by the body.

Usually each edge has one coedge. Coedges are linked in circular lists around each vertex using next and previous pointers according to which end of the coedge lies at the vertex. When Booleans are used to slice (imprint) one body with another, a wire is returned that has two coedges per edge; the coedges have attributes giving details of the intersections of the body boundaries at each edge.

See also:
COEDGE, ENTITY, SUBSHELL, BODY, SHELL, SUBSHELL

Constructor & Destructor Documentation

WIRE::WIRE (  ) 

Constructs a WIRE (default constructor).



Role: Requests memory for this object but does not populate it. The allocation constructor is used primarily by restore. Applications should call this constructor only with the overloaded new operator, because this reserves the memory on the heap, a requirement to support roll back and history management.

WIRE::WIRE ( COEDGE *  coedge,
WIRE *  wire 
)

Constructs a WIRE from a list of COEDGEs and a connected WIRE already in the owning BODY.



Role: Requests memory for this object and populates it with the data supplied as the argument. Applications should call this constructor only with the overloaded new operator, because this reserves the memory on the heap, a requirement to support roll back and history management.

Creates and initializes a WIRE, setting its COEDGE back pointers. The arguments define the first COEDGE in this WIRE and the next WIRE in a list of WIREs on the BODY, respectively.

Parameters:
coedge the first COEDGE in the constructed WIRE.
wire the next WIRE in the owning BODY.

Member Function Documentation

virtual void ENTITY::add (  )  [virtual, inherited]

If this ENTITY is use counted, adds one to the count.



Role: If this ENTITY is not use counted, signals an error.

Every held pointer to a use counted ENTITY should be declared by calling add. There should a corresponding call to remove when the user is done with the pointer. For normal ENTITYs, simply call lose when the ENTITY is no longer part of the active model. For use counted ENTITYs, the implementations of add and remove come from macros in usecount.hxx. Use counted ENTITYs implemented without the macros should implement these virtual methods manually.

Reimplemented in SPAGROUP, CURVE, EE_LIST, PCURVE, APOINT, and SURFACE.

static MethodFunction WIRE::add_method ( METHOD_ID const &  method_id,
MethodFunction  method_func 
) [static]

Registers an implementation function for a run-time virtual method.



Role: (Supplied by the ENTITY_FUNCTIONS and UTILITY_DEF macros.)

Parameters:
method_id method id.
method_func method function.

Reimplemented from ENTITY.

virtual logical WIRE::apply_transform ( SPAtransf const &  t,
ENTITY_LIST &  list,
logical  negate = FALSE,
logical  reset_pattern = TRUE 
) [virtual]

Transforms this ENTITY.



Role: The ENTITY_LIST is used to prevent sub-entities from being transformed more than once. This method is not included with the standard ENTITY methods in order to allow nontransformable ENTITYs to use the default implementation. (Supplied by the TRANSFORM_FUNCTION and TRANSFORM_DEF macros.)

Parameters:
t the transform to apply.
list list of entities to which the transform has already been applied.
negate negation flag.
reset_pattern internal use only.

Reimplemented from ENTITY.

ATTRIB* ENTITY::attrib (  )  const [inline, inherited]

Returns this ENTITY's attribute pointer, or NULL if there is no attached attribute.

ENTITY* ENTITY::backup (  )  [inherited]

Creates a duplicate record and a change bulletin, if needed, as a backup for roll back.



Role: The duplication is done via the virtual function make_copy, to let each derived type do its own backup. Before performing a change, each routine checks whether the data structure is posted on the bulletin board. If not, the posting is done automatically. Called by all system change functions.

BODY* WIRE::body (  )  const

Returns the owner of this WIRE if the former is a BODY, otherwise NULL.



Role: Each WIRE may belong to only one BODY.

SPAbox* WIRE::bound (  )  const [inline]

Returns a geometric bounding region (box) for this WIRE.



Role: Returns a box that includes the entire WIRE (with respect to the internal coordinate system of the BODY). The return may be NULL if the bound was not calculated since the WIRE was last modified.

int ENTITY::bulletin_count (  )  const [inline, inherited]

Returns the number of bulletins referring to this ENTITY.

virtual logical WIRE::bulletin_no_change_vf ( ENTITY const *  other,
logical  identical_comparator 
) const [protected, virtual]

Virtual function for comparing subclass data - called by bulletin_no_change.



Role: For the identical_comparator argument to be TRUE, it requires an exact match when comparing doubles and returns the result of memcmp as a default (for non-overridden subclasses). FALSE indicates tolerant compares and returns FALSE as a default.

Parameters:
other other entity.
identical_comparator comparator.

Reimplemented from ENTITY.

virtual logical WIRE::call_method ( METHOD_ID const &  method_id,
METHOD_ARGS const &  method_args 
) [virtual]

Executes the implementation function for a routine virtual method.



Role: (Supplied by the ENTITY_FUNCTIONs and UTILITY_DEF macros).

Parameters:
method_id method id.
method_args method args.

Reimplemented from ENTITY.

void ENTITY::check_destroy (  )  const [inline, protected, inherited]

Checks that entity deletion is legitimate.



Role: This method complains if there is an attempt to delete an entity other than through the private member function destroy, which is carefully controlled.

COEDGE* WIRE::coedge (  )  const [inline]

Returns a pointer to a COEDGE in this WIRE.



Role: No significance is placed upon the choice of this COEDGE, which may change during modeling operations.

WIRECONTBIT WIRE::cont (  )  const [inline]

Returns the containment information for this WIRE.



Role: A return value of ALL_OUTSIDE indicates that the WIRE represents material in space, while ALL_INSIDE indicates that the WIRE represents an infinitesimally small hole through material.

void ENTITY::copy_common ( ENTITY_LIST &  list,
const ENTITY *  from,
pointer_map *  pm = NULL,
logical  dpcpy_skip = FALSE,
SCAN_TYPE  reason = SCAN_COPY 
) [protected, inherited]

Fills in this ENTITY with data from the copied ENTITY, converting pointers into indices in the supplied ENTITY_LIST.



Role: Supports the copy operation. (Supplied by the ENTITY_FUNCTIONS and COPY_DEF macros.) Whenever the operation encounters a pointer to a dependent ENTITY, it find the index of the latter in the supplied ENTITY_LIST and sets the corresponding pointer in the copy to that index.

Parameters:
list list of ENTITYs being copied.
from original ENTITY being copied.
pm pointer map.
dpcpy_skip Used only by the base ENTITY and base ATTRIB class. No other derived entity or attribute should need to utilize this value. This logical indicates how non- deepcopyable attributes are handled during a deep copy. If TRUE, the copy will continue even if it encounters attributes marked as not deep-copyable. By default (FALSE), if any attributes that are found to be not deep-copyable, a sys_error will be thrown. (This flag only effects how attributes are handled; any non-deepcopyable non-attribute entities encountered will cause a sys_error to be thrown regardless of this flag's setting.)
reason type of scan.

virtual ENTITY* WIRE::copy_data ( ENTITY_LIST &  list,
pointer_map *  pm = NULL,
logical  dpcpy_skip = FALSE,
SCAN_TYPE  reason = SCAN_COPY 
) const [virtual]

Allocates a new ENTITY and calls copy_common to fill it in.



Role: Supports the copy operation. (Supplied by the ENTITY_FUNCTIONS and UTILITY_DEF macros.)

Parameters:
list ENTITYs to copy.
pm pointer map.
dpcpy_skip Used only by the base ENTITY and base ATTRIB class. No other derived entity or attribute should need to utilize this value. This logical indicates how non- deepcopyable attributes are handled during a deep copy. If TRUE, the copy will continue even if it encounters attributes marked as not deep-copyable. By default (FALSE), if any attributes that are found to be not deep-copyable, a sys_error will be thrown. (This flag only effects how attributes are handled; any non-deepcopyable non-attribute entities encountered will cause a sys_error to be thrown regardless of this flag's setting.)
reason scan type.

Reimplemented from ENTITY.

virtual void WIRE::copy_scan ( ENTITY_LIST &  list,
SCAN_TYPE  reason = SCAN_COPY,
logical  dpcpy_skip = FALSE 
) const [virtual]

Adds dependent ENTITYs of this ENTITY to the list of ENTITYs to be copied.



Role: Supports the copy operation. (Supplied by the ENTITY_FUNCTIONS and SCAN_DEF macros.) The default type of scan (reason) is SCAN_COPY.

Parameters:
list ENTITYs to copy.
reason type of copy.
dpcpy_skip Used only by the base ENTITY and base ATTRIB class. No other derived entity or attribute should need to utilize this value. This logical indicates how non- deepcopyable attributes are handled during a deep copy. If TRUE, the copy will continue even if it encounters attributes marked as not deep-copyable. By default (FALSE), if any attributes that are found to be not deep-copyable, a sys_error will be thrown. (This flag only effects how attributes are handled; any non-deepcopyable non-attribute entities encountered will cause a sys_error to be thrown regardless of this flag's setting.)

Reimplemented from ENTITY.

virtual void WIRE::debug_ent ( FILE *  file_pointer  )  const [virtual]

Prints the type and address of this ENTITY, roll back pointer, attributes, and any unknown subtype information.



Role: This method is called by DEBUG_LIST::debug for an entirely unknown ENTITY type, or at the start of any derived class's debug_ent method. Each derived class's debug_ent method uses the debug function described in the Spatial Product Documentation to print information added at that level. (Supplied by the ENTITY_FUNCTIONS and DEBUG_DEF macros.)

Parameters:
file_pointer file pointer.

Reimplemented from ENTITY.

virtual logical ENTITY::deletable (  )  const [virtual, inherited]

Indicates whether or not this ENTITY is normally destroyed by lose.



Role: Returns FALSE if the ENTITY is shared among multiple owners by means of a use count, and so gets destroyed implicitly when every owner has been lost. Most ENTITYs are destroyed explicitly using lose, so the default returns TRUE.

Reimplemented in CELL, CSHELL, SPAGROUP, VERTEX_TEMPLATE, ANNOTATION, ATTRIB_TAG, ATTRIB, CURVE, EE_LIST, PCURVE, APOINT, SURFACE, TRANSFORM, and ID_ATTRIB.

void WIRE::fix_common ( ENTITY *  array[],
SCAN_TYPE  reason = SCAN_COPY 
) [protected]

Converts pointers from copy indices into real pointers.



Role: Called by fix_pointers. For ENTITY, converts the attribute pointer, and any pointers in the unknown_entity_text record. (Supplied by the ENTITY_FUNCTIONS and FIX_POINTER_DEF macros.)

Parameters:
array ENTITY pointers to fix.
reason type of scan.

Reimplemented from ENTITY.

virtual void WIRE::fix_pointers ( ENTITY *  entity_array[],
SCAN_TYPE  reason = SCAN_COPY 
) [virtual]

Converts pointers from copy indices into real pointers.



Role: The fix_pointers method for each entity in the restore array is called, with the given array as an argument. This calls fix_common, which calls its parent's fix_common, and then corrects any pointers in the derived class. In practice there is never anything special for fix_pointers to do, but it is retained for consistency and compatibility. (Supplied by the ENTITY_FUNCTIONS and UTILITY_DEF macros.)

Parameters:
entity_array ENTITY pointers to fix.
reason type of scan.

Reimplemented from ENTITY.

void ENTITY::fixup_copy ( ENTITY *  rollback  )  const [protected, inherited]

Fixes any pointers in the ENTITY after copying for backup.



Role: For ENTITY, this method has nothing to do, but because it is called by all data types, it is required to terminate the copy chain. (Supplied by the ENTITY_FUNCTIONS and SIMPLE_COPY_CONE macros.)

Parameters:
rollback the ENTITY to copy for backup.

HISTORY_STREAM* ENTITY::history (  )  const [inline, inherited]

Returns a pointer to the history stream for this ENTITY.

logical WIRE::holds_pattern (  )  const [inline, protected, virtual]

Returns TRUE if this entity can have a pattern_holder.

For internal use only.

Reimplemented from ENTITY.

virtual int WIRE::identity ( int  level = 0  )  const [virtual]

Returns a type identifier for this ENTITY.



Role: If level is unspecified or 0, returns the type identifier ENTITY_TYPE. If level is specified, returns ENTITY_TYPE for that level of derivation from ENTITY. The level of this class is defined as ENTITY_LEVEL.

A positive level specifies the level of derivation down from the ENTITY class to examine. ENTITY itself has level 0. If level is unspecified or 0, the type of the most specific class of object is returned. If level is 1, the type of the class one level down from ENTITY is returned. If level is 2, the type of the parent class 2 levels down from ENTITY is returned, and so on. If level is greater than the level of the instance, -1 ("unknown") is returned.

A negative level similarly specifies the level of derivation up from the most specific class of object returned.

(Supplied by the ENTITY_FUNCTIONS and UTILITY_DEF macros.)

Parameters:
level the derivation level at which the object is to be identified.

Reimplemented from ENTITY.

virtual logical WIRE::is_deepcopyable (  )  const [virtual]

Returns TRUE if this ENTITY can be deep copied.

Reimplemented from ENTITY.

logical ENTITY::is_unknown_entity ( void   )  const [protected, inherited]

Returns TRUE if this is an unknown entity.

An unknown entity is one that is restored from SAT/SAB but is not native to the running app.

virtual logical ENTITY::is_use_counted (  )  const [virtual, inherited]

Indicates if this ENTITY is use-counted or not.



Role: The default implementation returns FALSE.

Reimplemented in CURVE, PCURVE, APOINT, and SURFACE.

virtual int WIRE::lookup ( logical  insert  )  const [virtual]

Looks up this ENTITY in the appropriate debug list.



Role: This method is not included among the standard ENTITY methods because often subclasses may wish to be included in their parent's debug list. This is done simply by not including a lookup method in the subclass.

When the logical argument is TRUE, the ENTITY is inserted into the debug list if it does not already exist in the list. If it is FALSE and the ENTITY does not exist in the list, a -1 is returned. (Supplied by the LOOK_FUNCTION and LOOKUP_DEF macros.)

Parameters:
insert flag to insert into debug list.

Reimplemented from ENTITY.

virtual void WIRE::lose (  )  [virtual]

Posts a delete bulletin to the bulletin board indicating the instance is no longer used in the active model.



Role: The lose methods for attached attributes are also called.

Reimplemented from ENTITY.

logical ENTITY::needs_rollback (  )  const [inline, inherited]

Checks whether or not the record is already backed up.

WIRE* WIRE::next ( PAT_NEXT_TYPE  next_type = PAT_CAN_CREATE  )  const

Returns a pointer to the next WIRE in a complete enumeration of all the WIREs in a BODY or SHELL.



Role: The order is not defined and may change when SUBSHELLs are recomputed.

The next_type argument controls how the next method treats patterns, and can take any one of three values:

PAT_CAN_CREATE: If the next wire is to be generated from a pattern, create it if it doesn't yet exist and return its pointer.
PAT_NO_CREATE: If the next wire is to be generated from a pattern, but hasn't yet been created, bypass it and return the pointer of the next already-created wire (if any).
PAT_IGNORE: behave as though there is no pattern on the wire.

Parameters:
next_type (see Role).

WIRE* WIRE::next_in_list ( PAT_NEXT_TYPE  = PAT_CAN_CREATE  )  const [inline]

Returns a pointer to the next WIRE in the list of WIREs contained directly by a BODY, SHELL, or SUBSHELL.



Role: The next_type argument controls how the next method treats patterns, and can take any one of three values:

PAT_CAN_CREATE:
If the next wire is to be generated from a pattern, create it if it doesn't yet exist and return its pointer.
PAT_NO_CREATE:
If the next wire is to be generated from a pattern, but hasn't yet been created, bypass it and return the pointer of the next already-created wire (if any).
PAT_IGNORE:
Behave as though there is no pattern on the wire.

Parameters:
next_type (see Role).

ENTITY* WIRE::owner (  )  const [virtual]

Returns a pointer to the owning entity.

Reimplemented from ENTITY.

virtual void ENTITY::remove ( logical  lose_if_zero = TRUE  )  [virtual, inherited]

Decrements the use count of this ENTITY.



Role: If the use count reaches 0, the ENTITY's lose method is called if the argument lose_if_zero is set to TRUE. (If the entity is not use counted, an error is signaled.)

Every held pointer to a use counted ENTITY should be declared by calling add. There should a corresponding call to remove when the user is done with the pointer. For normal ENTITYs, simply call lose when the ENTITY is no longer part of the active model. For use counted ENTITYs, the implementations of add and remove come from macros in usecount.hxx. Use counted ENTITYs implemented without the macros should implement these virtual methods manually.

Parameters:
lose_if_zero flag to lose the ENTITY when the use count drops to 0.

Reimplemented in SPAGROUP, CURVE, PCURVE, APOINT, and SURFACE.

void WIRE::restore_common (  ) 

Restores data for a record from disc to memory.



Role: Writes pointers as indices (fix_pointers turns them back into pointers) and returns a pointer to the ENTITY made. Generally, "common" functions that do the main work are protected, as they are called only from the main entry functions or by themselves up the derivation tree.

This method is public, however, because the main restore function is not a member function, and making it a friend would make it unable to be declared static, i.e., local to the defining module. (Supplied by the ENTITY_FUNCTIONS and RESTORE_DEF macros.) 

    read_ptr  Pointer to record in save file for first attribute owned by entity.
    if (restore_version_number >= ENTITY_TAGS_VERSION)
       read_int      new tag

Reimplemented from ENTITY.

void ENTITY::restore_end ( char *  id_str  )  [inherited]

Terminates a restore record.



Role: Reads any trailing text and fills in the unknown text pointer. Used only by the save/restore system.

Parameters:
id_str the id string.

virtual void ENTITY::roll_notify ( BULLETIN_TYPE  bulletin_type,
ENTITY *  ent 
) [protected, virtual, inherited]

Fields notifications of rollback operations.



Role: The first argument specifies the type of bulletin being rolled back (create, delete or change). In the case of a change notification, the second argument contains the information to be restored into this object. The base implementation, which is used for almost every derived class, does nothing at all.

Parameters:
bulletin_type type of bulletin being rolled back.
ent information to be restored into this argument.

Reimplemented in ATTRIB_DM2ACIS, ATTRIB_FFBLEND, ATTRIB_INTCOED, ANNOTATION, ASM_MODEL_REF, ATTRIB_PHL_VW, COEDGE, CURVE, EDGE, EE_LIST, FACE, LOOP, PCURVE, APOINT, SURFACE, TCOEDGE, TEDGE, TVERTEX, VERTEX, WCS, ID_ATTRIB, ATTRIB_COL, RH_LIGHT, RH_BACKGROUND, and RH_FOREGROUND.

BULLETIN*& ENTITY::rollback (  )  const [inline, inherited]

Returns the pointer to the bulletin board entry for this ENTITY.

virtual void WIRE::save ( ENTITY_LIST &  entity_list  )  const [virtual]

Performs a save operation.



Role: Calls save_begin, the particular class's save_common, and then save_end. (Supplied by the ENTITY_FUNCTIONS and UTILITY_DEF macros.)

This save method is just like any other save, except that it calls save_begin with an optional argument to suppress writing of a trailing dash, because save_common does not write out an identifier, or call any parent class's save_common.

Parameters:
entity_list ENTITYs to save.

Reimplemented from ENTITY.

void ENTITY::save_begin ( logical  terminator = FALSE  )  const [protected, inherited]

Starts a save record.



Role: Writes a preamble to a save file record, which contains any subclass identifiers not known to this version of ACIS. Called by the save method.

Parameters:
terminator terminator flag.

void WIRE::save_common ( ENTITY_LIST &  entity_list  )  const [protected]

Handles the save operation.



Role: Writes out the savable data associated with the base class. In the case of ENTITY, saveable data is simply the attribute pointer. In the case of child classes derived from ENTITY, class-specific save_common methods handle the class-specific data. Called by the save method. (Supplied by the ENTITY_FUNCTIONS and SAVE_DEF macros.)

Each derived class's save_common method first writes out that class's identifier, calls its parent class's save_common method, and then writes out data particular to the derived class. Thus the save record consists of identifiers in leaf-to-base order, followed by class data in base-to-leaf order. As it writes out any ENTITY pointers, it adds them to the ENTITY_LIST, so that any dependent data also gets written to the file.

Parameters:
entity_list ENTITYs to save

Reimplemented from ENTITY.

void ENTITY::save_end ( ENTITY_LIST &  list  )  const [protected, inherited]

Terminates a save record.



Role: Writes out any data associated with subclasses not known to this version of ACIS before terminating the record. Called by the save method.

Parameters:
list list of entities.

void ENTITY::set_attrib ( ATTRIB *  attr  )  [inherited]

Changes the attribute pointer of this ENTITY to point to the given attribute.



Parameters:
attr the new attribute.

void WIRE::set_body ( BODY *  body  ) 

Sets the WIRE's owning BODY to the specified BODY.



Role: Before performing the change, it checks if the data structure is posted on the bulletin board. If not, the method calls backup to put an entry on the bulletin board.

Parameters:
body the new parent BODY.

void WIRE::set_bound ( SPAbox *  in_box  )  [inline]

Sets the bounding region (box) of this WIRE to the specified box.



Role: Sets the WIRE's SPAbox pointer to point to the given SPAbox. Before performing the change, it checks if the data structure is posted on the bulletin board. If not, the method calls backup to put an entry on the bulletin board.

Parameters:
box the new SPAbox.

void WIRE::set_coedge ( COEDGE *  coedge  ) 

Sets the first COEDGE in the list of COEDGEs belonging to this WIRE.



Role: Before performing the change, it checks if the data structure is posted on the bulletin board. If not, the method calls backup to put an entry on the bulletin board.

Parameters:
coedge the new COEDGE.

void WIRE::set_cont ( WIRECONTBIT  cont  ) 

Sets the containment for this WIRE.



Parameters:
cont the new containment.

void WIRE::set_next ( WIRE *  wire,
logical  reset_pattern = TRUE 
)

Sets the next WIRE in the BODY's list of WIREs to the given WIRE.



Role: Before performing the change, it checks if the data structure is posted on the bulletin board. If not, the method calls backup to put an entry on the bulletin board.

Parameters:
wire the new next WIRE.
reset_pattern internal use only.

void WIRE::set_owner ( ENTITY *  owner  ) 

Set this WIRE's owner to be the specified BODY or SHELL.



Parameters:
owner the new owning ENTITY.

void WIRE::set_shell ( SHELL *  shell,
logical  reset_pattern = TRUE 
)

Sets the WIRE's owning SHELL to the specified SHELL.



Parameters:
shell the new parent SHELL.
reset_pattern internal use only.

void WIRE::set_subshell ( SUBSHELL *  subshell  ) 

Sets the SUBSHELL directly containing this WIRE to be the given SUBSHELL.



Parameters:
subshell the new parent SUBSHELL.

virtual void ENTITY::set_use_count ( int  use  )  [virtual, inherited]

Sets the reference use count of this ENTITY.



Role: If the ENTITY is not use counted, this method does nothing.

Parameters:
use new use count.

Reimplemented in CURVE, PCURVE, APOINT, and SURFACE.

SHELL* WIRE::shell (  )  const

Return a pointer to the owning SHELL.



Role: Returns NULL if the owning ENTITY is not a SHELL.

virtual unsigned WIRE::size (  )  const [virtual]

Returns the size, in bytes, of this ENTITY.



Role: (Supplied by the ENTITY_FUNCTIONS and UTILITY_DEF macros.)

Reimplemented from ENTITY.

SUBSHELL* WIRE::subshell (  )  const [inline]

Returns a pointer to the SUBSHELL directly containing this WIRE.



Role: Returns NULL if the WIRE is directly contained by its ENTITY, BODY, or SHELL.

tag_id_type ENTITY::tag ( logical  assign_new = TRUE  )  const [inline, inherited]

Data reading routine.



Parameters:
assign_new flag to assign a new tag number or not.

virtual const char* WIRE::type_name (  )  const [virtual]

Returns a name for this ENTITY's type.



Role: For the ENTITY class, unknown is returned.

Reimplemented from ENTITY.

virtual int ENTITY::use_count (  )  const [virtual, inherited]

Returns the use count of this ENTITY.



Role: Returns zero if the ENTITY is not use counted.

Reimplemented in CURVE, PCURVE, APOINT, and SURFACE.