src/IGESBasic/IGESBasic_SingleParent.hxx

   1 // Created on: 1993-01-09
   2 // Created by: CKY / Contract Toubro-Larsen ( Arun MENON )
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _IGESBasic_SingleParent_HeaderFile
  18 #define _IGESBasic_SingleParent_HeaderFile
  19
  20 #include <Standard.hxx>
  21
  22 #include <Standard_Integer.hxx>
  23 #include <IGESData_HArray1OfIGESEntity.hxx>
  24 #include <IGESData_SingleParentEntity.hxx>
  25 class IGESData_IGESEntity;
  26
  27
  28 class IGESBasic_SingleParent;
  29 DEFINE_STANDARD_HANDLE(IGESBasic_SingleParent, IGESData_SingleParentEntity)
  30
  31 //! defines SingleParent, Type <402> Form <9>
  32 //! in package IGESBasic
  33 //! It defines a logical structure of one independent
  34 //! (parent) entity and one or more subordinate (children)
  35 //! entities
  36 class IGESBasic_SingleParent : public IGESData_SingleParentEntity
  37 {
  38
  39 public:
  40
  41
  42   Standard_EXPORT IGESBasic_SingleParent();
  43
  44   //! This method is used to set the fields of the class
  45   //! SingleParent
  46   //! - nbParentEntities : Indicates number of Parents, always = 1
  47   //! - aParentEntity    : Used to hold the Parent Entity
  48   //! - allChildren      : Used to hold the children
  49   Standard_EXPORT void Init (const Standard_Integer nbParentEntities, const Handle(IGESData_IGESEntity)& aParentEntity, const Handle(IGESData_HArray1OfIGESEntity)& allChildren);
  50
  51   //! returns the number of Parent Entities, which should be 1
  52   Standard_EXPORT Standard_Integer NbParentEntities() const;
  53
  54   //! Returns the Parent Entity (inherited method)
  55   Standard_EXPORT Handle(IGESData_IGESEntity) SingleParent() const Standard_OVERRIDE;
  56
  57   //! returns the number of children of the Parent
  58   Standard_EXPORT Standard_Integer NbChildren() const Standard_OVERRIDE;
  59
  60   //! returns the specific child as indicated by Index
  61   //! raises exception if Index <= 0 or Index > NbChildren()
  62   Standard_EXPORT Handle(IGESData_IGESEntity) Child (const Standard_Integer Index) const Standard_OVERRIDE;
  63
  64
  65
  66
  67   DEFINE_STANDARD_RTTIEXT(IGESBasic_SingleParent,IGESData_SingleParentEntity)
  68
  69 protected:
  70
  71
  72
  73
  74 private:
  75
  76
  77   Standard_Integer theNbParentEntities;
  78   Handle(IGESData_IGESEntity) theParentEntity;
  79   Handle(IGESData_HArray1OfIGESEntity) theChildren;
  80
  81
  82 };
  83
  84
  85
  86
  87
  88
  89
  90 #endif // _IGESBasic_SingleParent_HeaderFile