include/opencascade/IGESAppli_PWBArtworkStackup.hxx

0001 // Created on: 1993-01-11
0002 // Created by: CKY / Contract Toubro-Larsen ( Anand NATRAJAN )
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 _IGESAppli_PWBArtworkStackup_HeaderFile
0018 #define _IGESAppli_PWBArtworkStackup_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <NCollection_Array1.hxx>
0024 #include <NCollection_HArray1.hxx>
0025 #include <IGESData_IGESEntity.hxx>
0026 class TCollection_HAsciiString;
0027
0028 //! defines PWBArtworkStackup, Type <406> Form <25>
0029 //! in package IGESAppli
0030 //! Used to communicate which exchange file levels are to
0031 //! be combined in order to create the artwork for a
0032 //! printed wire board (PWB). This property should be
0033 //! attached to the entity defining the printed wire
0034 //! assembly (PWA) or if no such entity exists, then the
0035 //! property should stand alone in the file.
0036 class IGESAppli_PWBArtworkStackup : public IGESData_IGESEntity
0037 {
0038
0039 public:
0040   Standard_EXPORT IGESAppli_PWBArtworkStackup();
0041
0042   //! This method is used to set the fields of the class
0043   //! PWBArtworkStackup
0044   //! - nbPropVal    : number of property values
0045   //! - anArtIdent   : Artwork Stackup Identification
0046   //! - allLevelNums : Level Numbers
0047   Standard_EXPORT void Init(const int                                    nbPropVal,
0048                             const occ::handle<TCollection_HAsciiString>& anArtIdent,
0049                             const occ::handle<NCollection_HArray1<int>>& allLevelNums);
0050
0051   //! returns number of property values
0052   Standard_EXPORT int NbPropertyValues() const;
0053
0054   //! returns Artwork Stackup Identification
0055   Standard_EXPORT occ::handle<TCollection_HAsciiString> Identification() const;
0056
0057   //! returns total number of Level Numbers
0058   Standard_EXPORT int NbLevelNumbers() const;
0059
0060   //! returns Level Number
0061   //! raises exception if Index <= 0 or Index > NbLevelNumbers
0062   Standard_EXPORT int LevelNumber(const int Index) const;
0063
0064   DEFINE_STANDARD_RTTIEXT(IGESAppli_PWBArtworkStackup, IGESData_IGESEntity)
0065
0066 private:
0067   int                                   theNbPropertyValues;
0068   occ::handle<TCollection_HAsciiString> theArtworkStackupIdent;
0069   occ::handle<NCollection_HArray1<int>> theLevelNumbers;
0070 };
0071
0072 #endif // _IGESAppli_PWBArtworkStackup_HeaderFile