All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

SPAasm Class entity_handle_holder

SPAbase.ACIS_OBJECT
  |
  +---entity_handle_holder

Usage: you must use this class as is. You should never derive it.

public class entity_handle_holder

Holds a pointer to an entity_handle
Role: The entity_handle_holder object is a container for an entity_handle object which automates use counting for the entity_handle object.
Clients of entity_handle objects should use this holder object to ensure that the entity_handle object is not deleted when cleanup is performed. Cleanup is performed by cleanup asmi routines (asmi_cleanup, asmi_model_cleanup, asmi_model_cleanup_tree, asmi_cleanup_handles, asmi_model_cleanup_handles), which examine all entity_handle objects which are managed (owned) by a set of asm_model objects and destroy any object with a use count of zero, i.e. which are not being held by an entity_handle_holder object or by an entity_handle_list object with the ASM_HOLD behavior set.

See also:: entity_handle

Constructor and Destructor Index

o entity_handle_holder(): Default constructor.
o entity_handle_holder(entity_handle*): Constructor.
o ~entity_handle_holder(): Destructor.

Method Index

o get(): Returns the entity_handle pointer.
o operator=(entity_handle_holder&): Assignment operator.
o release(): Releases the entity_handle pointer.
o set(entity_handle*): Sets the entity_handle pointer.

Constructor and Destructor

o entity_handle_holder

public entity_handle_holder(

)

Default constructor.
Role: Sets the entity_handle pointer to NULL.

o entity_handle_holder

public entity_handle_holder( entity_handle* hdl)

Constructor.
Role: Sets the entity_handle pointer. If this pointer is not NULL, the use count is incremented.

Parameters:

hdl: pointer to entity_handle to hold.

o ~entity_handle_holder

public ~entity_handle_holder(

)

Destructor.
Role: Decrements the use count of the entity_handle object.

Methods

o get

public entity_handle* get(

)const

Returns the entity_handle pointer.

o operator=

public entity_handle_holder& operator=( const entity_handle_holder& hdl_hldr)

Assignment operator.
Role: Copies the entity_handle pointer. If this pointer is not NULL, the use count is incremented. If the holder already contains a valid entity_handle pointer, the corresponding use count is decremented.

Parameters:

hdl_hldr: entity_handle_holder.

o release

public void release(

)

Releases the entity_handle pointer.
Role: Decrements the use count of the entity_handle object and sets the entity_handle pointer to NULL.

o set

public void set( entity_handle* hdl)

Sets the entity_handle pointer.
Role: If this pointer is not NULL, the use count is incremented. If the holder already contains a valid entity_handle pointer, the corresponding use count is decremented.

Parameters:

hdl: pointer to entity_handle to hold.

This object is included in the file: ent_handle_holder.hxx