include/opencascade/IGESBasic_Group.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( Arun MENON )
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IGESBasic_Group_HeaderFile
0018 #define _IGESBasic_Group_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <IGESData_HArray1OfIGESEntity.hxx>
0023 #include <IGESData_IGESEntity.hxx>
0024 #include <Standard_Integer.hxx>
0025 class Standard_Transient;
0026
0027
0028 class IGESBasic_Group;
0029 DEFINE_STANDARD_HANDLE(IGESBasic_Group, IGESData_IGESEntity)
0030
0031 //! defines Group, Type <402> Form <1>
0032 //! in package IGESBasic
0033 //! The Group Associativity allows a collection of a set
0034 //! of entities to be maintained as a single, logical
0035 //! entity
0036 //!
0037 //! Group, OrderedGroup, GroupWithoutBackP, OrderedGroupWithoutBackP
0038 //! share the same definition (class Group), form number changes
0039 //!
0040 //! non Ordered, non WithoutBackP : form  1
0041 //! non Ordered,     WithoutBackP : form  7
0042 //! Ordered, non WithoutBackP : form 14
0043 //! Ordered,     WithoutBackP : form 15
0044 class IGESBasic_Group : public IGESData_IGESEntity
0045 {
0046
0047 public:
0048
0049
0050   Standard_EXPORT IGESBasic_Group();
0051
0052   //! Creates a Group with a predefined count of items
0053   //! (which all start as null)
0054   Standard_EXPORT IGESBasic_Group(const Standard_Integer nb);
0055
0056   //! This method is used to set the fields of the class Group
0057   //! - allEntities : Used to store pointers to members of
0058   //! the Group.
0059   Standard_EXPORT void Init (const Handle(IGESData_HArray1OfIGESEntity)& allEntities);
0060
0061   //! Sets a Group to be, or not to be  Ordered (according mode)
0062   Standard_EXPORT void SetOrdered (const Standard_Boolean mode);
0063
0064   //! Sets a Group to be, or not to be  WithoutBackP
0065   Standard_EXPORT void SetWithoutBackP (const Standard_Boolean mode);
0066
0067   //! Returns True if <me> is Ordered
0068   Standard_EXPORT Standard_Boolean IsOrdered() const;
0069
0070   //! Returns True if <me> is WithoutBackP
0071   Standard_EXPORT Standard_Boolean IsWithoutBackP() const;
0072
0073   //! Enforce a new value for the type and form
0074   Standard_EXPORT void SetUser (const Standard_Integer type, const Standard_Integer form);
0075
0076   //! Changes the count of item
0077   //! If greater, new items are null
0078   //! If lower, old items are lost
0079   Standard_EXPORT void SetNb (const Standard_Integer nb);
0080
0081   //! returns the number of IGESEntities in the Group
0082   Standard_EXPORT Standard_Integer NbEntities() const;
0083
0084   //! returns the specific entity from the Group
0085   Standard_EXPORT Handle(IGESData_IGESEntity) Entity (const Standard_Integer Index) const;
0086
0087   //! returns the specific entity from the Group
0088   Standard_EXPORT Handle(Standard_Transient) Value (const Standard_Integer Index) const;
0089
0090   //! Sets a new value for item <Index>
0091   Standard_EXPORT void SetValue (const Standard_Integer Index, const Handle(IGESData_IGESEntity)& ent);
0092
0093
0094
0095
0096   DEFINE_STANDARD_RTTIEXT(IGESBasic_Group,IGESData_IGESEntity)
0097
0098 protected:
0099
0100
0101
0102
0103 private:
0104
0105
0106   Handle(IGESData_HArray1OfIGESEntity) theEntities;
0107
0108
0109 };
0110
0111
0112
0113
0114
0115
0116
0117 #endif // _IGESBasic_Group_HeaderFile