|
Purpose:
|
Base
HEAL individual entity-level attribute class.
|
|
|
Derivation:
|
ATTRIB_HH_ENT : ATTRIB_HH : ATTRIB : ENTITY : ACIS_OBJECT : -
|
|
|
SAT Identifier:
|
"individual_entity_attribute"
|
|
|
Filename:
|
heal/healhusk/attrib/at_enty.hxx
|
|
|
Description:
|
ATTRIB_HH_ENT is the base individual entity-level attribute class from which other
HEAL individual entity-level attribute classes are derived. Individual entity-level attributes are attached to the individual entities of body being healed to store entity-specific information about each phase or subphase of the healing process. The individual entity-level attributes for each phase or subphase are managed by the aggregate attribute for that phase/subphase.
|
|
|
Data:
|
protected VOID_LIST* m_log_list;
|
|
Logs changes made to each entity during the healing process.
|
|
|
Constructor:
|
public: ATTRIB_HH_ENT::ATTRIB_HH_ENT
(
|
|
|
ENTITY*
|
// owning entity
|
|
|
|
= NULL
|
|
|
);
|
|
|
C++ initialize constructor 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 inherited from the
ENTITY class (for example,
x=new ATTRIB_HH_ENT(...)), because this reserves the memory on the heap, a requirement to support roll back and history management.
|
|
|
|
|
|
Destructor:
|
public: virtual void ATTRIB_HH_ENT::lose
();
|
|
|
Posts a delete bulletin to the bulletin board indicating the instance is no longer used in the active model. The
lose methods for attached attributes are also called.
|
|
|
|
|
|
|
protected: virtual ATTRIB_HH_ENT::~ATTRIB_HH_ENT
();
|
|
|
This
C++ destructor should never be called directly. Instead, applications should use the overloaded
lose method inherited from the
ENTITY class, because this supports history management. (For example,
x=new ATTRIB_HH_ENT(...) then later
x->lose.)
|
|
|
|
|
Methods:
|
public: virtual void ATTRIB_HH_ENT::append_to_log
(
|
|
|
char*
|
// string to add
|
|
|
);
|
|
|
Add strings to the log list.
|
|
|
|
|
|
|
public: virtual void ATTRIB_HH_ENT::debug_ent
(
|
|
|
FILE*
|
// file pointer
|
|
|
) const;
|
|
|
Prints the type and address of this object, roll back pointer, attributes, and any unknown subtype information to the specified file. Refer to the
ENTITY class for more details.
|
|
|
|
|
|
|
public: virtual void ATTRIB_HH_ENT::draw_in_col
(
|
|
|
int col
|
// specified color
|
|
|
);
|
|
|
Sketch the owner entity in the specified color.
|
|
|
|
|
|
|
public: virtual VOID_LIST*
|
|
|
ATTRIB_HH_ENT::get_log_list ();
|
|
|
Returns the log list.
|
|
|
|
|
|
|
public: BODY* ATTRIB_HH_ENT::get_owner_body
();
|
|
|
Returns the pointer to the owning body.
|
|
|
|
|
|
|
public: virtual int ATTRIB_HH_ENT::identity
(
|
|
|
int
|
|
// derivation level
|
|
|
|
= 0
|
|
|
) const;
|
|
|
If
level is unspecified or 0, returns the type identifier
ATTRIB_HH_TYPE. If
level is specified, returns
<class>_TYPE for that level of derivation from
ENTITY. The level of this class is defined as
ATTRIB_HH_ENT_LEVEL.
|
|
|
|
|
|
|
public: virtual logical
|
|
|
ATTRIB_HH_ENT::is_deepcopyable () const;
|
|
|
Returns
TRUE if this can be deep copied.
|
|
|
|
|
|
|
public: virtual logical
|
|
|
ATTRIB_HH_ENT::pattern_compatible () const;
|
|
|
Returns
TRUE if this is pattern compatible.
|
|
|
|
|
|
|
public: void ATTRIB_HH_ENT::restore_common
();
|
|
|
The
RESTORE_DEF macro expands to the
restore_common method, which is used in reading information from a SAT file. This method is never called directly. It is called by a higher hierarchical function if an item in the SAT file is determined to be of this class type. An instance of this class will already have been created through the allocation constructor. This method then populates the class instance with the appropriate data from the SAT file.
|
|
|
None
|
|
|
|
|
no data is saved
|
|
|
|
|
|
|
public: virtual const char*
|
|
|
ATTRIB_HH_ENT::type_name () const;
|
|
|
Returns the string "individual_entity_attribute".
|
|
|
Internal Use:
|
draw
|
|
|
|
|
|
Related Fncs:
|
is_ATTRIB_HH_ENT
|