Home

entity_gvertex Class Reference
[Graph Theory]

Creates an instance of a graph vertex that holds an entity pointer as data. More...

#include <generic_graph.hxx>

Inheritance diagram for entity_gvertex:

Inheritance graph
[legend]
Collaboration diagram for entity_gvertex:

Collaboration graph
[legend]

List of all members.

Public Member Functions

void add () const
 The C++ classes of gvertex and gedge are use counted in the same way that laws are use counted.
void clear_kind ()
 Sets the user-defined kind array for this graph item to NULL.
 entity_gvertex (char const *name, ENTITY *ptr)
 Creates an instance of a graph vertex which also has a data pointer to an owning entity.
ENTITYget_entity () const
 Returns a pointer to the entity stored as data on the graph vertex.
int get_kind_size () const
 Returns the size of the kind array.
logical is_kind (int which) const
 Determines whether or not this graph vertex is of the specified kind.
char const * name () const
 Every graph vertices can be supplied a character string as a name.
logical operator!= (gvertex const &in_vertex) const
 Determines whether or not the supplied vertex is not equal to this graph vertex.
logical operator== (gvertex const &in_vertex) const
 Determines whether or not the supplied vertex is equal to this graph vertex.
void remove ()
 The C++ classes of gvertex and gedge are use counted in the same way that laws are use counted.
void set_kind (int which, logical value)
 Assigns a user-defined kind to this graph edge.


Detailed Description

Creates an instance of a graph vertex that holds an entity pointer as data.



Role: This is the same as the gvertex class, except that it holds a pointer to an entity that the graph vertex refers to. Initially, this can be a CELL or a FACE. This is a way for the graph theory tools to interface with a geometric model.

To make a gvertex or gedge contain data, derive a class from the base classes of gvertex and gedge. Use a technique similar to the entity_gvertex class which enables it to contain an entity pointer.

See also:
ENTITY

Constructor & Destructor Documentation

entity_gvertex::entity_gvertex ( char const *  name,
ENTITY ptr 
)

Creates an instance of a graph vertex which also has a data pointer to an owning entity.



Parameters:
name name of vertex.
ptr pointer of ENTITY.


Member Function Documentation

void gvertex::add (  )  const [inherited]

The C++ classes of gvertex and gedge are use counted in the same way that laws are use counted.



Role: That is to say that the are copied by calling the add method and deleted by calling the remove method.

void gvertex::clear_kind (  )  [inherited]

Sets the user-defined kind array for this graph item to NULL.

kind is actually a dynamic array.

Role: The value argument specifies whether or not this graph edge is of the kind number specified.

ENTITY* entity_gvertex::get_entity (  )  const [virtual]

Returns a pointer to the entity stored as data on the graph vertex.



Role: Initially, the entity can be a CELL or a FACE.

Reimplemented from gvertex.

int gvertex::get_kind_size (  )  const [inherited]

Returns the size of the kind array.

logical gvertex::is_kind ( int  which  )  const [inherited]

Determines whether or not this graph vertex is of the specified kind.



Parameters:
which kind to test.

char const* gvertex::name (  )  const [inherited]

Every graph vertices can be supplied a character string as a name.



Role: This method returns its name.

logical gvertex::operator!= ( gvertex const &  in_vertex  )  const [inherited]

Determines whether or not the supplied vertex is not equal to this graph vertex.



Parameters:
in_vertex gvertex.

logical gvertex::operator== ( gvertex const &  in_vertex  )  const [inherited]

Determines whether or not the supplied vertex is equal to this graph vertex.



Parameters:
in_vertex supplied vertex.

void gvertex::remove (  )  [inherited]

The C++ classes of gvertex and gedge are use counted in the same way that laws are use counted.



Role: That is to say that the are copied by calling the add method and deleted by calling the remove method.

void gvertex::set_kind ( int  which,
logical  value 
) [inherited]

Assigns a user-defined kind to this graph edge.

kind is actually a dynamic array.

Role: The value argument specifies whether or not this graph edge is of the kind number specified.

Parameters:
which kind of use.
value turn on or off.