0026377: Passing Handle objects as arguments to functions as non-const reference...
[occt.git] / src / IGESAppli / IGESAppli_PWBArtworkStackup.hxx
CommitLineData
42cf5bc1 1// Created on: 1993-01-11
2// Created by: CKY / Contract Toubro-Larsen ( Anand NATRAJAN )
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 _IGESAppli_PWBArtworkStackup_HeaderFile
18#define _IGESAppli_PWBArtworkStackup_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_Type.hxx>
22
23#include <Standard_Integer.hxx>
24#include <TColStd_HArray1OfInteger.hxx>
25#include <IGESData_IGESEntity.hxx>
26class TCollection_HAsciiString;
27class Standard_OutOfRange;
28
29
30class IGESAppli_PWBArtworkStackup;
31DEFINE_STANDARD_HANDLE(IGESAppli_PWBArtworkStackup, IGESData_IGESEntity)
32
33//! defines PWBArtworkStackup, Type <406> Form <25>
34//! in package IGESAppli
35//! Used to communicate which exchange file levels are to
36//! be combined in order to create the artwork for a
37//! printed wire board (PWB). This property should be
38//! attached to the entity defining the printed wire
39//! assembly (PWA) or if no such entity exists, then the
40//! property should stand alone in the file.
41class IGESAppli_PWBArtworkStackup : public IGESData_IGESEntity
42{
43
44public:
45
46
47 Standard_EXPORT IGESAppli_PWBArtworkStackup();
48
49 //! This method is used to set the fields of the class
50 //! PWBArtworkStackup
51 //! - nbPropVal : number of property values
52 //! - anArtIdent : Artwork Stackup Identification
53 //! - allLevelNums : Level Numbers
54 Standard_EXPORT void Init (const Standard_Integer nbPropVal, const Handle(TCollection_HAsciiString)& anArtIdent, const Handle(TColStd_HArray1OfInteger)& allLevelNums);
55
56 //! returns number of property values
57 Standard_EXPORT Standard_Integer NbPropertyValues() const;
58
59 //! returns Artwork Stackup Identification
60 Standard_EXPORT Handle(TCollection_HAsciiString) Identification() const;
61
62 //! returns total number of Level Numbers
63 Standard_EXPORT Standard_Integer NbLevelNumbers() const;
64
65 //! returns Level Number
66 //! raises exception if Index <= 0 or Index > NbLevelNumbers
67 Standard_EXPORT Standard_Integer LevelNumber (const Standard_Integer Index) const;
68
69
70
71
92efcf78 72 DEFINE_STANDARD_RTTIEXT(IGESAppli_PWBArtworkStackup,IGESData_IGESEntity)
42cf5bc1 73
74protected:
75
76
77
78
79private:
80
81
82 Standard_Integer theNbPropertyValues;
83 Handle(TCollection_HAsciiString) theArtworkStackupIdent;
84 Handle(TColStd_HArray1OfInteger) theLevelNumbers;
85
86
87};
88
89
90
91
92
93
94
95#endif // _IGESAppli_PWBArtworkStackup_HeaderFile