ATTRIB_GENERIC
List of: Classes
Subjects: Attributes, SAT Save and Restore
Contents: Generic Attributes

Purpose: Organization base attribute class for the Generic Attributes Component.

Derivation: ATTRIB_GENERIC : ATTRIB : ENTITY : ACIS_OBJECT : -

SAT Identifier: "gen"

Filename: ga/ga_husk/attrib/at_gen.hxx

Description: Defines the organization attribute class for the Generic Attributes Component.

Constructor: public: ATTRIB_GENERIC::ATTRIB_GENERIC (


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_GENERIC(...)), because this reserves the memory on the heap, a requirement to support roll back and history management.




Destructor: public: virtual void ATTRIB_GENERIC::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_GENERIC::~ATTRIB_GENERIC ();


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_GENERIC(...) then later x->lose.)



Methods: public: virtual void ATTRIB_GENERIC::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 int ATTRIB_GENERIC::identity (


int
// level



= 0


) const;


If level is unspecified or 0, returns the type identifier ATTRIB_GENERIC_TYPE. If level is specified, returns ATTRIB_GENERIC_TYPE for that level of derivation from ENTITY. The level of this class is defined as ATTRIB_GENERIC_LEVEL.






public: virtual logical


ATTRIB_GENERIC::is_deepcopyable (


) const;


Returns TRUE if this can be deep copied.






public: void ATTRIB_GENERIC::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.


No data

This class does not save any data






public: virtual const char*


ATTRIB_GENERIC::type_name () const;


Returns the string "gen".




Related Fncs: is_ATTRIB_GENERIC
PDF/GA/04CL.PDF
HTM/DATA/GA/GA/04CL/0001.HTM