Branch data     Line data    Source code

       1                 :            : //-------------------------------------------------------------------------
       2                 :            : // Filename      : CollectionEntity.hpp
       3                 :            : //
       4                 :            : // Purpose       : This class is the base class for all the other solid 
       5                 :            : //                 model entities in the Geometry subsystem. 
       6                 :            : //
       7                 :            : // Special Notes :
       8                 :            : //
       9                 :            : // Creator       : Xuechen Liu
      10                 :            : //
      11                 :            : // Creation Date : 08/06/96
      12                 :            : //
      13                 :            : // Owner         : Raikanta Sahu
      14                 :            : //-------------------------------------------------------------------------
      15                 :            : 
      16                 :            : #ifndef COLLECTION_ENTITY_HPP
      17                 :            : #define COLLECTION_ENTITY_HPP
      18                 :            : 
      19                 :            : // ********** BEGIN STANDARD INCLUDES      **********
      20                 :            : #include <assert.h>
      21                 :            : // ********** END STANDARD INCLUDES        **********
      22                 :            : 
      23                 :            : // ********** BEGIN CUBIT INCLUDES         **********
      24                 :            : #include "CubitDefines.h"
      25                 :            : #include "CubitMessage.hpp"
      26                 :            : #include "CubitString.hpp"
      27                 :            : #include "CGMGeomConfigure.h"
      28                 :            : // ********** END CUBIT INCLUDES           **********
      29                 :            : 
      30                 :            : // ********** BEGIN FORWARD DECLARATIONS   **********
      31                 :            : class GeometryQueryEngine;
      32                 :            : class RefCollection;
      33                 :            : // ********** END FORWARD DECLARATIONS     **********
      34                 :            : 
      35                 :            : class CUBIT_GEOM_EXPORT CollectionEntity
      36                 :            : {
      37                 :            : public:
      38                 :            :   
      39                 :            :   CollectionEntity();
      40                 :            :     // Default constructor.
      41                 :            :   
      42                 :            :   virtual ~CollectionEntity() ; 
      43                 :            :     // Destructor.
      44                 :            :   
      45                 :            :   virtual GeometryQueryEngine* get_geometry_query_engine() const = 0;
      46                 :            :     //R GeometryQueryEngine*
      47                 :            :     //R- A pointer to the geometric modeling engine associated with
      48                 :            :     //R- the object.
      49                 :            :     //- This function returns a pointer to the geometric modeling engine
      50                 :            :     //- associated with the object.
      51                 :            :   
      52                 :            :   virtual CubitString name() const = 0;
      53                 :            :   virtual void name(CubitString) = 0;
      54                 :            :     // Collection Entities aren't RefEntities, but they may have names.
      55                 :            :     // Note: This is just here to keep the initial Pro/E
      56                 :            :     //       implementation happy.
      57                 :            : 
      58                 :          0 :   CubitStatus set_owner_attribute(RefCollection* owner)
      59                 :            :     {
      60         [ #  # ]:          0 :       if (myOwner)
      61                 :          0 :         return CUBIT_FAILURE;
      62                 :          0 :       myOwner = owner;
      63                 :          0 :       return CUBIT_SUCCESS;
      64                 :            :     }
      65                 :            :   RefCollection* get_owner_attribute() const
      66                 :            :     { return myOwner; }
      67                 :            :   
      68                 :            : protected:
      69                 :            :   RefCollection* myOwner;
      70                 :            : private:
      71                 :            : } ;
      72                 :            : 
      73                 :            : 
      74                 :            : // ********** BEGIN INLINE FUNCTIONS       **********
      75                 :            : // ********** END INLINE FUNCTIONS         **********
      76                 :            : 
      77                 :            : // ********** BEGIN FRIEND FUNCTIONS       **********
      78                 :            : // ********** END FRIEND FUNCTIONS         **********
      79                 :            : 
      80                 :            : // ********** BEGIN EXTERN FUNCTIONS       **********
      81                 :            : // ********** END EXTERN FUNCTIONS         **********
      82                 :            : 
      83                 :            : #endif
      84                 :            :