VERTEX Class Reference
[Topology]

Represents a corner of a FACE and/or the end of an EDGE. More...

#include <vertex.hxx>

Inheritance diagram for VERTEX:

Collaboration diagram for VERTEX:

List of all members.

Public Member Functions

virtual void add ()

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

void add_edge (EDGE *edge)

Adds a pointer to the given EDGE to those pointers already in this VERTEX.

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.

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.

int count_edges () const

Counts the number of EDGEs pointed to by this VERTEX.

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.

void delete_edge (EDGE *edge)

Removes the pointer to the specified EDGE from this VERTEX.

EDGE * edge () const

Gets an EDGE at a VERTEX known to contain at most one pointer to an EDGE.

EDGE * edge (int i) const

Gets the ith EDGE pointed to by this VERTEX.

logical edge_linked (EDGE *edge) const

Tests whether or not the specified EDGE is pointed to by this VERTEX.

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

Converts pointers from copy indices into real pointers.

virtual 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.

APOINT * geometry () const

Returns the APOINT that defines the position of this VERTEX.

virtual double get_tolerance ()

Returns the tolerance of the tolerant TVERTEX made from this VERTEX.

virtual double get_tolerance () const

Returns the tolerance of the tolerant TVERTEX made from this VERTEX.

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.

TVERTEX * make_tolerant (double tol)

Makes a tolerant TVERTEX from this VERTEX.

logical needs_rollback () const

Checks whether or not the record is already backed up.

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.

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_edge (EDGE *edge, logical reset_pattern=TRUE)

Sets the owning EDGE of this VERTEX to the specified EDGE.

void set_geometry (APOINT *point, logical reset_pattern=TRUE)

Sets the geometry of this VERTEX to the specified APOINT.

virtual void set_use_count (int use)

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.

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.

VERTEX (APOINT *point)

Constructs a VERTEX described by the specified APOINT.

VERTEX ()

Constructs a VERTEX (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.

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.

Protected Attributes

EDGE * edge_ptr

Pointer to one EDGE on which this VERTEX lies.

APOINT * geometry_ptr

Pointer to the position of this VERTEX in space.

Detailed Description

Represents a corner of a FACE and/or the end of an EDGE.

Role: A vertex is a 0-dimensional, topological entity that is used to bound an edge or a tedge. Generally, an edge is bounded by two distinct vertices; however, if the edge is closed, both ends of the edge are bounded by the same vertex. A vertex embodies the user's view of a corner of a face or the junction point of two edges. Each vertex is represented by a point in the geometric model. Two vertices can not exist at the same point.

A vertex maintains pointers to one or more of the edges which it bounds. Generally, a vertex contains a pointer to one of the edges it bounds. The other edges can be found by following the next, previous, and partner pointers of the coedges of the edges. When a body is nonmanifold at a vertex (i.e., more than one manifold group of faces meet at a vertex or a wire attaches to a face at a vertex), then the vertex must maintain a pointer to an edge in each group of faces and wires. The other edges in a manifold group of faces or a wire can be found by following coedge pointers.

Users may be interested in the topological traversal function sg_q_edges_around_vertex or sg_q_coedges_around_vertex, which return a list of edges or coedges that share a given vertex. Users may also find the topological traversal functions located in q_vert.hxx useful for generating lists of vertices on other topological entities.

See also:: APOINT, EDGE

Constructor & Destructor Documentation

VERTEX::VERTEX ( )

Constructs a VERTEX (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.

VERTEX::VERTEX ( APOINT * point )

Constructs a VERTEX described by the specified APOINT.

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 a VERTEX using the specified parameters. The argument specifies the APOINT entity defining the position of this VERTEX in space. The constructor increments the APOINT's use count to reflect this new use.

Parameters:

point

the APOINT describing the constructed VERTEX.

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 CURVE, EE_LIST, SPAGROUP, PCURVE, PHLV5_OCC, APOINT, REFINEMENT, RH_MATERIAL, RH_TEXTURE_SPACE, SURFACE, and VERTEX_TEMPLATE.

void VERTEX::add_edge ( EDGE * edge )

Adds a pointer to the given EDGE to those pointers already in this VERTEX.

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:

edge

the EDGE whose pointer is to be added.

static MethodFunction VERTEX::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.

Reimplemented in TVERTEX.

virtual logical VERTEX::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.

Reimplemented in TVERTEX.

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 VERTEX::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, 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.

Reimplemented in TVERTEX.

virtual logical VERTEX::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.

Reimplemented in TVERTEX.

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.

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* VERTEX::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.

Reimplemented in TVERTEX.

virtual void VERTEX::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.

Reimplemented in TVERTEX.

int VERTEX::count_edges ( ) const

Counts the number of EDGEs pointed to by this VERTEX.

Role: The number of EDGEs ending in a VERTEX is equal to or, greater than, the number of pointers in the VERTEX.

virtual void VERTEX::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.

Reimplemented in TVERTEX.

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 ANNOTATION, ATTRIB_TAG, ATTRIB, CELL, CFACE, CSHELL, CURVE, EE_LIST, SPAGROUP, ID_ATTRIB, PCURVE, PHLV5_OCC, APOINT, REFINEMENT, RH_MATERIAL, RH_TEXTURE_SPACE, SUPERCELL, SURFACE, TRANSFORM, and VERTEX_TEMPLATE.

void VERTEX::delete_edge ( EDGE * edge )

Removes the pointer to the specified EDGE from this VERTEX.

Role: Does nothing if no such pointer exists.

Parameters:

edge

the EDGE whose pointer is to be deleted.

EDGE* VERTEX::edge ( ) const [inline]

Gets an EDGE at a VERTEX known to contain at most one pointer to an EDGE.

Role: Returns NULL if this VERTEX contains more than one EDGE pointer.

EDGE* VERTEX::edge ( int i ) const

Gets the ith EDGE pointed to by this VERTEX.

Role: Use this function when the VERTEX contains pointers to more than one EDGE. Given an argument of zero (0), it returns the expected result if the EDGE contains one pointer. It returns NULL if i is either too great or negative.

Parameters:

i

zero-based index of the desired EDGE.

logical VERTEX::edge_linked ( EDGE * edge ) const

Tests whether or not the specified EDGE is pointed to by this VERTEX.

Parameters:

edge

the EDGE to test.

void VERTEX::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.

Reimplemented in TVERTEX.

virtual void VERTEX::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.

Reimplemented in TVERTEX.

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.

Reimplemented in GA_WORKSPACE.

virtual void ENTITY::full_size	(	SizeAccumulator &	est,
		logical	countSelf = `TRUE`
	)			const `[virtual, inherited]`

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 in ATTRIB_CELL_INT_PRECEDENCE, ATTRIB_GEN_NAME, ATTRIB_GEN_STRING, ATTRIB_GEN_WSTRING, ATTRIB_BLEND, ATTRIB_FFBLEND, CELL, SPACOLLECTION, CONE, CSHELL, CURVE, EE_LIST, ELLIPSE, GA_WORKSPACE, SPAGROUP, HELIX, INTCURVE, LAW, PCURVE, PLANE, APOINT, SPHERE, SPLINE, STRAIGHT, SUPERCELL, SURFACE, TEXT_ENT, TORUS, UNDEFC, and ATTRIB_VAR_BLEND.

APOINT* VERTEX::geometry ( ) const [inline]

Returns the APOINT that defines the position of this VERTEX.

virtual double VERTEX::get_tolerance ( ) [virtual]

Returns the tolerance of the tolerant TVERTEX made from this VERTEX.

Role: This routine is for backwards compatibility. It saves the evaluated range and cannot be declared const.

Reimplemented in TVERTEX.

virtual double VERTEX::get_tolerance ( ) const [virtual]

Returns the tolerance of the tolerant TVERTEX made from this VERTEX.

Role: This const version of this function is less efficient than the non-const version because it cannot store the computed parameter range in the EDGE for future use, but is required for constant EDGEs.

Reimplemented in TVERTEX.

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

Returns a pointer to the history stream for this ENTITY.

logical VERTEX::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 VERTEX::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.

Reimplemented in TVERTEX.

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

Returns TRUE if this ENTITY can be deep copied.

Reimplemented from ENTITY.

Reimplemented in TVERTEX.

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, PHLV5_OCC, APOINT, REFINEMENT, RH_MATERIAL, RH_TEXTURE_SPACE, SURFACE, and VERTEX_TEMPLATE.

virtual int VERTEX::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.

Reimplemented in TVERTEX.

virtual void VERTEX::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.

Reimplemented in TVERTEX.

TVERTEX* VERTEX::make_tolerant ( double tol )

Makes a tolerant TVERTEX from this VERTEX.

Parameters:

tol

the specified tolerance.

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

Checks whether or not the record is already backed up.

ENTITY* VERTEX::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 CURVE, SPAGROUP, PCURVE, PHLV5_OCC, APOINT, REFINEMENT, RH_MATERIAL, RH_TEXTURE_SPACE, SURFACE, and VERTEX_TEMPLATE.

void VERTEX::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.

Reimplemented in TVERTEX.

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.

void VERTEX::roll_notify	(	BULLETIN_TYPE	bulletin_type,
		ENTITY *	ent
	)			`[virtual]`

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 from ENTITY.

Reimplemented in TVERTEX.

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

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

virtual void VERTEX::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.

Reimplemented in TVERTEX.

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 VERTEX::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.

Reimplemented in TVERTEX.

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 VERTEX::set_edge	(	EDGE *	edge,
		logical	reset_pattern = `TRUE`
	)

Sets the owning EDGE of this VERTEX to the specified EDGE.

Role: Deletes any existing pointers to EDGEs in this VERTEX and then places a pointer to the given EDGE in the VERTEX. 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:

	edge	the new parent EDGE.
	reset_pattern	internal use only.

void VERTEX::set_geometry	(	APOINT *	point,
		logical	reset_pattern = `TRUE`
	)

Sets the geometry of this VERTEX to the specified APOINT.

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:

	point	the new APOINT.
	reset_pattern	internal use only.

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, PHLV5_OCC, APOINT, REFINEMENT, RH_MATERIAL, RH_TEXTURE_SPACE, SURFACE, and VERTEX_TEMPLATE.

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

Returns the size, in bytes, of this ENTITY.

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

Reimplemented from ENTITY.

Reimplemented in TVERTEX.

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* VERTEX::type_name ( ) const [virtual]

Returns a name for this ENTITY's type.

Role: For the ENTITY class, unknown is returned.

Reimplemented from ENTITY.

Reimplemented in TVERTEX.

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, PHLV5_OCC, APOINT, REFINEMENT, RH_MATERIAL, RH_TEXTURE_SPACE, SURFACE, and VERTEX_TEMPLATE.

Member Data Documentation

EDGE* VERTEX::edge_ptr [protected]

Pointer to one EDGE on which this VERTEX lies.

Role: A NULL value may indicate that the VERTEX has a vertedge attribute that holds pointers to several EDGEs at the VERTEX.

APOINT* VERTEX::geometry_ptr [protected]

Pointer to the position of this VERTEX in space.


Public Member Functions
virtual void	add ()
	If this `ENTITY` is use counted, adds one to the count.
void	add_edge (EDGE *edge)
	Adds a pointer to the given `EDGE` to those pointers already in this `VERTEX`.
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.
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.
int	count_edges () const
	Counts the number of `EDGEs` pointed to by this `VERTEX`.
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`.
void	delete_edge (EDGE *edge)
	Removes the pointer to the specified `EDGE` from this `VERTEX`.
EDGE *	edge () const
	Gets an `EDGE` at a `VERTEX` known to contain at most one pointer to an `EDGE`.
EDGE *	edge (int i) const
	Gets the ith `EDGE` pointed to by this `VERTEX`.
logical	edge_linked (EDGE *edge) const
	Tests whether or not the specified `EDGE` is pointed to by this `VERTEX`.
virtual void	fix_pointers (ENTITY *[], SCAN_TYPE reason=SCAN_COPY)
	Converts pointers from copy indices into real pointers.
virtual 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.
APOINT *	geometry () const
	Returns the `APOINT` that defines the position of this `VERTEX`.
virtual double	get_tolerance ()
	Returns the tolerance of the tolerant `TVERTEX` made from this `VERTEX`.
virtual double	get_tolerance () const
	Returns the tolerance of the tolerant `TVERTEX` made from this `VERTEX`.
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.
TVERTEX *	make_tolerant (double tol)
	Makes a tolerant `TVERTEX` from this `VERTEX`.
logical	needs_rollback () const
	Checks whether or not the record is already backed up.
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.
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_edge (EDGE *edge, logical reset_pattern=TRUE)
	Sets the owning `EDGE` of this `VERTEX` to the specified `EDGE`.
void	set_geometry (APOINT *point, logical reset_pattern=TRUE)
	Sets the geometry of this `VERTEX` to the specified `APOINT`.
virtual void	set_use_count (int use)
	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.
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`.
	VERTEX (APOINT *point)
	Constructs a `VERTEX` described by the specified `APOINT`.
	VERTEX ()
	Constructs a `VERTEX` (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.
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.
Protected Attributes
EDGE *	edge_ptr
	Pointer to one `EDGE` on which this `VERTEX` lies.
APOINT *	geometry_ptr
	Pointer to the position of this `VERTEX` in space.

VERTEX Class Reference [Topology]

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

VERTEX Class Reference
[Topology]