Home

asm_model Class Reference
[Assembly Modeling]

Class object to represent an assembly or part model within assembly modeling. More...

#include <asm_model.hxx>

Inheritance diagram for asm_model:

Inheritance graph
[legend]
Collaboration diagram for asm_model:

Collaboration graph
[legend]

List of all members.

Public Member Functions

void contents_changed (asm_event_type ev_type) const
 Notifies the model that its contents have been changed externally.
entity_handleget_assembly_handle ()
 Returns an entity handle for this model's assembly, if any.
entity_handleget_entity_handle (ENTITY const *entity, logical check_entity_owner) const
 Returns the entity handle associated with an ENTITY.
void get_entity_handles (entity_handle_list &handles) const
 Returns all entity handles managed by the model.
asm_model_info get_model_info () const
 Returns a structure containing information about the model.
double get_resabs () const
 Returns the positional tolerance associated with a model.
double get_resnor () const
 Returns the angular tolerance associated with a model.
double get_units () const
 Returns the units associated with a model.
asm_model_entity_mgrmgr () const
 Returns the asm_model_entity_mgr associated with this model.


Detailed Description

Class object to represent an assembly or part model within assembly modeling.


Role: Represents a part or assembly model within assembly modeling.

The asm_model class is the fundamental organizational class object within ACIS Assembly Modeling. Each asm_model object represents either a part model or (sub-)assembly model. Each asm_model object is associated with an asm_model_entity_mgr object, which in turn wraps the application code object associated with the model. For more information, refer to the Assembly Modeling technical articles.


Member Function Documentation

void asm_model::contents_changed ( asm_event_type  ev_type  )  const

Notifies the model that its contents have been changed externally.



Role: This method must be called by the customer application if it changes the contents of a model outside of the context of assembly modeling, for example, by performing a Boolean operation on a body in the application document associated with the model. It will result in sub_model_changed_vf being called on the entity managers of all parent models of this model.

Parameters:
ev_type the type of change that was made.

entity_handle* asm_model::get_assembly_handle (  ) 

Returns an entity handle for this model's assembly, if any.



Role: Returns an entity_handle bound to the assembly object owned by this model's entity manager. Returns NULL if the model has no assembly, that is, it is a part model.

entity_handle* asm_model::get_entity_handle ( ENTITY const *  entity,
logical  check_entity_owner 
) const

Returns the entity handle associated with an ENTITY.



Role: Returns the entity handle associated with an ENTITY contained in the model. If no such handle exists, one will be created.

Parameters:
entity The entity for which a handle is being requested
check_entity_owner Optional logical argument that controls if the api checks to see if the input entity is owned by the model.

void asm_model::get_entity_handles ( entity_handle_list handles  )  const

Returns all entity handles managed by the model.



Role: Overwrites the input list of handles with a list of all entity handles managed by the model.

Parameters:
handles the output list of handles.

asm_model_info asm_model::get_model_info (  )  const

Returns a structure containing information about the model.



Role: This routine is used to query the model for information about itself which is to be saved to an ASAT file.

double asm_model::get_resabs (  )  const

Returns the positional tolerance associated with a model.



Role: This routine is used to query the model for the value of SPAresabs used for entities within the model.

double asm_model::get_resnor (  )  const

Returns the angular tolerance associated with a model.



Role: This routine is used to query the model for the value of SPAresnor used for entities within the model.

Note: You should never change SPAresnor away from its initial value of 1.0e-10.

double asm_model::get_units (  )  const

Returns the units associated with a model.



Role: This routine is used to query the model for the number of mm corresponding to a distance of 1.0. For example, for each 1 unit (cm) of length, the routine will return a value of 10.0.

asm_model_entity_mgr* asm_model::mgr (  )  const

Returns the asm_model_entity_mgr associated with this model.



Role: Returns the entity manager object to which this model is bound.