#include <torus.hxx>
Public Member Functions | |
| virtual void | add () |
If this ENTITY is use counted, adds one to the count. | |
| void | add_owner (ENTITY *owner, logical count=TRUE) |
Adds the owner argument to the list of owners. | |
| 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. | |
| 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. | |
| const SPAposition & | centre () const |
Returns the center position of this TORUS. | |
| 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 this SURFACE is normally destroyed by lose. | |
| const surface & | equation () const |
Returns the surface equation of this TORUS, for reading only. | |
| surface & | equation_for_update () |
| Returns the surface equation for update operations. | |
| virtual void | fix_pointers (ENTITY *[], SCAN_TYPE reason=SCAN_COPY) |
| Converts pointers from copy indices into real pointers. | |
| void | full_size (SizeAccumulator &est, logical countSelf=TRUE) const |
Increments the SizeAccumulator by the size, in bytes, of everything owned by this ENTITY and, optionally, of the ENTITY itself. | |
| int | get_owners (ENTITY_LIST &list) const |
Copies the list of owners of this SURFACE to the list argument. | |
| 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. | |
| double | major_radius () const |
Returns the major radius of this TORUS. | |
| SPAbox | make_box (LOOP *loop=NULL, const SPAtransf *t=NULL, logical tight_box=FALSE, SPAbox *untransformed_box=NULL) const |
Returns a bounding box for this TORUS. | |
| double | minor_radius () const |
Returns the minor radius of this TORUS. | |
| logical | needs_rollback () const |
| Checks whether or not the record is already backed up. | |
| const SPAunit_vector & | normal () const |
Returns the normal vector of this TORUS. | |
| void | operator*= (const SPAtransf &t) |
Transforms this TORUS. | |
| ENTITY * | owner () const |
Returns the first owner of this SURFACE. | |
| virtual void | remove (logical lose_if_zero=TRUE) |
Decrements the use count of this ENTITY. | |
| void | remove_owner (ENTITY *owner, logical count=TRUE, logical lose=TRUE) |
Removes the owner argument from the list of owners. | |
| void | restore_common () |
| Restores data for a record from disc to memory. | |
| void | restore_end (char *id_str) |
| Terminates a restore record. | |
| void | roll_notify (BULLETIN_TYPE, ENTITY *) |
| Fields notifications of rollback operations. | |
| 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_centre (const SPAposition ¢er) |
Sets this TORUS's center point to the given position. | |
| void | set_major_radius (double major_radius) |
Sets this TORUS's major radius to the given value. | |
| void | set_minor_radius (double minor_radius) |
Sets this TORUS's minor radius to the given value. | |
| void | set_normal (const SPAunit_vector &normal) |
Sets this TORUS's normal to the given unit vector. | |
| virtual void | set_use_count (int val) |
Sets the reference use count of this ENTITY. | |
| virtual unsigned | size () const |
Returns the size, in bytes, of this ENTITY. | |
| tag_id_type | tag (logical assign_new=TRUE) const |
| Data reading routine. | |
| TORUS (const torus &tor) | |
Constructs a TORUS from the specified torus. | |
| TORUS (const SPAposition ¢er, const SPAunit_vector &normal, double major_radius, double minor_radius) | |
Constructs a TORUS with specified center, normal, major radius, and minor radius. | |
| TORUS () | |
Constructs a TORUS (default constructor). | |
| surface * | trans_surface (const SPAtransf &t=*(SPAtransf *) NULL_REF, logical negate=FALSE) const |
Returns the transformed surface equation of this TORUS. | |
| 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. | |
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. | |
| 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. | |
Role: TORUS is a model geometry class that contains a pointer to a (lowercase) torus, the corresponding construction geometry class. In general, a model geometry class is derived from ENTITY and is used to define a permanent model object. It provides model management functionality, in addition to the geometry definition.
TORUS is one of several classes derived from SURFACE to define a specific type of surface. The torus class defines a torus as a circular thickening of a circular spine, defined by a center, normal, major radius, and minor radius.
Along with the usual SURFACE and ENTITY class methods, TORUS has member methods to provide access to specific implementations of the geometry. For example, methods are available to set and retrieve the radius, center, and other information about a torus.
A use count allows multiple references to a TORUS. The construction of a new TORUS initializes the use count to 0. Methods are provided to increment and decrement the use count, and after the use count returns to 0, the entity is deleted.
| TORUS::TORUS | ( | ) |
Constructs a TORUS (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.
| TORUS::TORUS | ( | const SPAposition & | center, | |
| const SPAunit_vector & | normal, | |||
| double | major_radius, | |||
| double | minor_radius | |||
| ) |
Constructs a TORUS with specified center, normal, major radius, and minor radius.
Role: Requests memory for this object and populates it with the data supplied as arguments. 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.
| TORUS::TORUS | ( | const torus & | tor | ) |
Constructs a TORUS from the specified torus.
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.
| virtual void SURFACE::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 from ENTITY.
| static MethodFunction TORUS::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.)
| method_id | method id. | |
| method_func | method function. |
Reimplemented from SURFACE.
| void SURFACE::add_owner | ( | ENTITY * | owner, | |
| logical | count = TRUE | |||
| ) | [inherited] |
Adds the owner argument to the list of owners.
| owner | owner to be added. | |
| count | flag to increment use count or not. |
| virtual logical SURFACE::apply_transform | ( | SPAtransf const & | t, | |
| ENTITY_LIST & | list, | |||
| logical | negate = FALSE, |
|||
| logical | reset_pattern = TRUE | |||
| ) | [virtual, inherited] |
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.)
| 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.
| int ENTITY::bulletin_count | ( | ) | const [inline, inherited] |
Returns the number of bulletins referring to this ENTITY.
| virtual logical TORUS::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 identical_comparator to be TRUE 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.
| other | other entity. | |
| identical_comparator | comparator. |
Reimplemented from SURFACE.
| virtual logical TORUS::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).
| method_id | method id. | |
| method_args | method args. |
Reimplemented from SURFACE.
| const SPAposition& TORUS::centre | ( | ) | const [inline] |
Returns the center position of this TORUS.
| 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.
| 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.
| 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* TORUS::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.)
| 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 SURFACE.
| virtual void TORUS::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.
| 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 SURFACE.
| virtual void TORUS::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.)
| file_pointer | file pointer. |
Reimplemented from SURFACE.
| virtual logical SURFACE::deletable | ( | ) | const [virtual, inherited] |
Indicates whether this SURFACE is normally destroyed by lose.
Role: The method returns FALSE, indicating that SURFACEs are, by default, shared among multiple owners by means of use-count tracking, and so are destroyed implicitly when every owner has been lost. Classes derived from SURFACE may of course override this behavior
Reimplemented from ENTITY.
| const surface& TORUS::equation | ( | ) | const [virtual] |
| surface& TORUS::equation_for_update | ( | ) | [virtual] |
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.)
| array | ENTITY pointers to fix. | |
| reason | type of scan. |
Reimplemented from SURFACE.
| virtual void TORUS::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.)
| entity_array | ENTITY pointers to fix. | |
| reason | type of scan. |
Reimplemented from SURFACE.
| 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.)
| rollback | the ENTITY to copy for backup. |
Reimplemented in GA_WORKSPACE.
| void TORUS::full_size | ( | SizeAccumulator & | est, | |
| logical | countSelf = TRUE | |||
| ) | const [virtual] |
Increments the SizeAccumulator by the size, in bytes, of everything owned by this ENTITY and, optionally, of the ENTITY itself.
Role: If countSelf is TRUE, increments the SizeAccumulator by the size, in bytes, of the ENTITY and everything owned by the ENTITY. If countSelf is FALSE, increments the SizeAccumulator by the size, in bytes, of everything owned by the ENTITY, but not including the size of the ENTITY itself.
For example, if an ENTITY contained a character string and full_size were called with countSelf == FALSE, the SizeAccumulator would be incremented by the size, in bytes, of the character string.
Reimplemented from SURFACE.
| int SURFACE::get_owners | ( | ENTITY_LIST & | list | ) | const [inherited] |
Copies the list of owners of this SURFACE to the list argument.
Role: Returns the number of owners copied.
| list | list of owners. |
| HISTORY_STREAM* ENTITY::history | ( | ) | const [inline, inherited] |
Returns a pointer to the history stream for this ENTITY.
| logical SURFACE::holds_pattern | ( | ) | const [inline, protected, virtual, inherited] |
Returns TRUE if this entity can have a pattern_holder.
For internal use only.
Reimplemented from ENTITY.
| virtual int TORUS::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.)
| level | the derivation level at which the object is to be identified. |
Reimplemented from SURFACE.
| virtual logical TORUS::is_deepcopyable | ( | ) | const [virtual] |
| 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 SURFACE::is_use_counted | ( | ) | const [virtual, inherited] |
| virtual int SURFACE::lookup | ( | logical | insert | ) | const [virtual, inherited] |
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.)
| insert | flag to insert into debug list. |
Reimplemented from ENTITY.
| virtual void TORUS::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 SURFACE.
| double TORUS::major_radius | ( | ) | const [inline] |
Returns the major radius of this TORUS.
| SPAbox TORUS::make_box | ( | LOOP * | loop = NULL, |
|
| const SPAtransf * | t = NULL, |
|||
| logical | tight_box = FALSE, |
|||
| SPAbox * | untransformed_box = NULL | |||
| ) | const [virtual] |
Returns a bounding box for this TORUS.
Role: Returns a SPAbox bounding the complete surface. If tight_box is TRUE, then a tighter box bounding the supplied LOOP list is computed. If untransformed_box is supplied, it will be expanded to include the untransformed box just computed.
| loop | list of LOOP | |
| t | | |
| tight_box | | |
| untransformed_box | |
Reimplemented from SURFACE.
| double TORUS::minor_radius | ( | ) | const [inline] |
Returns the minor radius of this TORUS.
| logical ENTITY::needs_rollback | ( | ) | const [inline, inherited] |
Checks whether or not the record is already backed up.
| const SPAunit_vector& TORUS::normal | ( | ) | const [inline] |
Returns the normal vector of this TORUS.
| void TORUS::operator*= | ( | const SPAtransf & | t | ) | [virtual] |
| ENTITY* SURFACE::owner | ( | ) | const [virtual, inherited] |
| virtual void SURFACE::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.
| lose_if_zero | flag to lose the ENTITY when the use count drops to 0. |
Reimplemented from ENTITY.
| void SURFACE::remove_owner | ( | ENTITY * | owner, | |
| logical | count = TRUE, |
|||
| logical | lose = TRUE | |||
| ) | [inherited] |
Removes the owner argument from the list of owners.
| owner | owner to be removed. | |
| count | flag to decrement the use count. | |
| lose | flag to lose if use count is zero. |
| void TORUS::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 SURFACE.
| 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.
| id_str | the id string. |
| void SURFACE::roll_notify | ( | BULLETIN_TYPE | bulletin_type, | |
| ENTITY * | ent | |||
| ) | [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.
| bulletin_type | type of bulletin being rolled back. | |
| ent | information to be restored into this argument. |
Reimplemented from ENTITY.
| BULLETIN*& ENTITY::rollback | ( | ) | const [inline, inherited] |
Returns the pointer to the bulletin board entry for this ENTITY.
| virtual void TORUS::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.
| entity_list | ENTITYs to save. |
Reimplemented from SURFACE.
| 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.
| terminator | terminator flag. |
| void TORUS::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.
| entity_list | ENTITYs to save |
Reimplemented from SURFACE.
| 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.
| list | list of entities. |
| void ENTITY::set_attrib | ( | ATTRIB * | attr | ) | [inherited] |
Changes the attribute pointer of this ENTITY to point to the given attribute.
| attr | the new attribute. |
| void TORUS::set_centre | ( | const SPAposition & | center | ) |
Sets this TORUS's center point to the given position.
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.
| center | the new center. |
| void TORUS::set_major_radius | ( | double | major_radius | ) |
Sets this TORUS's major radius to the given value.
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.
| major_radius | the new major radius. |
| void TORUS::set_minor_radius | ( | double | minor_radius | ) |
Sets this TORUS's minor radius to the given value.
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.
| minor_radius | the new minor radius. |
| void TORUS::set_normal | ( | const SPAunit_vector & | normal | ) |
Sets this TORUS's normal to the given unit vector.
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.
| normal | the new normal. |
| virtual void SURFACE::set_use_count | ( | int | use | ) | [virtual, inherited] |
| virtual unsigned TORUS::size | ( | ) | const [virtual] |
| tag_id_type ENTITY::tag | ( | logical | assign_new = TRUE |
) | const [inline, inherited] |
Data reading routine.
| assign_new | flag to assign a new tag number or not. |
| virtual const char* TORUS::type_name | ( | ) | const [virtual] |
| virtual int SURFACE::use_count | ( | ) | const [virtual, inherited] |