include/opencascade/IGESAppli_ReferenceDesignator.hxx

0001 // Created on: 1993-01-11
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 _IGESAppli_ReferenceDesignator_HeaderFile
0018 #define _IGESAppli_ReferenceDesignator_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <IGESData_IGESEntity.hxx>
0024 class TCollection_HAsciiString;
0025
0026 //! defines ReferenceDesignator, Type <406> Form <7>
0027 //! in package IGESAppli
0028 //! Used to attach a text string containing the value of
0029 //! a component reference designator to an entity being
0030 //! used to represent a component.
0031 class IGESAppli_ReferenceDesignator : public IGESData_IGESEntity
0032 {
0033
0034 public:
0035   Standard_EXPORT IGESAppli_ReferenceDesignator();
0036
0037   //! This method is used to set the fields of the class
0038   //! ReferenceDesignator
0039   //! - nbPropVal : Number of property values = 1
0040   //! - aText     : Reference designator text
0041   Standard_EXPORT void Init(const int                                    nbPropVal,
0042                             const occ::handle<TCollection_HAsciiString>& aText);
0043
0044   //! returns the number of property values
0045   //! is always 1
0046   Standard_EXPORT int NbPropertyValues() const;
0047
0048   //! returns the Reference designator text
0049   Standard_EXPORT occ::handle<TCollection_HAsciiString> RefDesignatorText() const;
0050
0051   DEFINE_STANDARD_RTTIEXT(IGESAppli_ReferenceDesignator, IGESData_IGESEntity)
0052
0053 private:
0054   int                                   theNbPropertyValues;
0055   occ::handle<TCollection_HAsciiString> theRefDesigText;
0056 };
0057
0058 #endif // _IGESAppli_ReferenceDesignator_HeaderFile