UNDEFC
List of: Classes
Subjects: Model Geometry, SAT Save and Restore
Contents: Kernel

Purpose: Defines a curve that is undefined except for its end points as an object in the model.

Derivation: UNDEFC : CURVE : ENTITY : ACIS_OBJECT : -

SAT Identifier: "undefc"

Filename: kern/kernel/kerndata/geom/undefc.hxx

Description: This class defines an undefined curve that records the start and end points, directions, and curvatures. The start point has a parameter value of 0 and the end point has a parameter value of 1. No other points are defined.

References: KERN undefc

Constructor: public: UNDEFC::UNDEFC ();


C++ allocation constructor requests memory for this object but does not populate it. The allocation constructor is used primarily by restore. Applications should call this constructor only with the overloaded new operator, because this reserves the memory on the heap, a requirement to support roll back and history management.






public: UNDEFC::UNDEFC (


SPAposition const&, // start position


SPAunit_vector const&, // start direction


SPAvector const&, // start curvature


SPAposition const&, // end position


SPAunit_vector const&, // end direction


SPAvector const& // end curvature


);


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






public: UNDEFC::UNDEFC (


undefc const& // undefc


);


C++ copy constructor requests memory for this object and populates it with the data from the object supplied as an argument. Applications should call this constructor only with the overloaded new operator, because this reserves the memory on the heap, a requirement to support roll back and history management.




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


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






protected: virtual logical


UNDEFC::bulletin_no_change_vf (


ENTITY const* other,
// other entity


logical identical_comparator // comparator


) const;


Virtual function for comparing subclass data - called by bulletin_no_change. For identical_comparator to be TRUE requires an exact match when comparing doubles, and returns the result of memcmp as a default (for non-overridden subclasses). FALSE indicates tolerant compares and returns FALSE as a default.






public: virtual void UNDEFC::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: SPAvector const& UNDEFC::end_curv () const;


Returns the curvature at the end of the curve.






public: SPAunit_vector const& UNDEFC::end_dir () const;


Returns the direction at the end of the curve.






public: SPAposition const& UNDEFC::end_point () const;


Returns the point at the end of the curve.






public: curve const& UNDEFC::equation () const;


Returns the curve equation for reading only.






public: curve& UNDEFC::equation_for_update ();


Returns the curve equation, checking first for backup.






public: virtual int UNDEFC::identity (


int
// level



= 0


) const;


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






public: virtual logical UNDEFC::is_deepcopyable (


) const;


Returns TRUE if this can be deep copied.






public: void UNDEFC::operator*= (


SPAtransf const& // transformation


);


Transforms the stored undefc in place.






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


undefc::restore_data
Low-level geometry.






public: void UNDEFC::set_end_curv (


SPAvector const& // end direction crvtr.


);


Sets the curvature at the end of the curve.






public: void UNDEFC::set_end_dir (


SPAunit_vector const& // end direction


);


Sets the direction at the end of the curve.






public: void UNDEFC::set_end_point (


SPAposition const& // end point


);


Sets the point at the end of the curve.






public: void UNDEFC::set_start_curv (


SPAvector const& // start direction crvtr.


);


Sets the curvature at the start of the curve.






public: void UNDEFC::set_start_dir (


SPAunit_vector const& // start direction


);


Sets the direction at the start of the curve.






public: void UNDEFC::set_start_point (


SPAposition const& // start point


);


Sets the point at the start of the curve.






public: SPAvector const& UNDEFC::start_curv () const;


Returns the curvature at the start of the curve.






public: SPAunit_vector const&


UNDEFC::start_dir () const;


Returns the direction at the start of the curve.






public: SPAposition const& UNDEFC::start_point () const;


Returns the point at the start of the curve.






public: curve* UNDEFC::trans_curve (


SPAtransf const&
// transformation



= * (SPAtransf* ) NULL_REF,


logical
// reverse curve?



= FALSE


) const;


Returns a new curve, which is the undefc of the UNDEFC, transformed if the given transformation is not NULL. This curve is reversed in sense if logical is TRUE.






public: virtual const char*


UNDEFC::type_name () const;


Returns the string "undefc".

Internal Use: full_size, save, save_common




Related Fncs: is_UNDEFC
PDF/KERN/39CLU.PDF
HTM/DATA/KERN/KERN/39CLU/0001.HTM