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
0027 class IGESAppli_ReferenceDesignator;
0028 DEFINE_STANDARD_HANDLE(IGESAppli_ReferenceDesignator, IGESData_IGESEntity)
0029
0030 //! defines ReferenceDesignator, Type <406> Form <7>
0031 //! in package IGESAppli
0032 //! Used to attach a text string containing the value of
0033 //! a component reference designator to an entity being
0034 //! used to represent a component.
0035 class IGESAppli_ReferenceDesignator : public IGESData_IGESEntity
0036 {
0037
0038 public:
0039
0040
0041   Standard_EXPORT IGESAppli_ReferenceDesignator();
0042
0043   //! This method is used to set the fields of the class
0044   //! ReferenceDesignator
0045   //! - nbPropVal : Number of property values = 1
0046   //! - aText     : Reference designator text
0047   Standard_EXPORT void Init (const Standard_Integer nbPropVal, const Handle(TCollection_HAsciiString)& aText);
0048
0049   //! returns the number of property values
0050   //! is always 1
0051   Standard_EXPORT Standard_Integer NbPropertyValues() const;
0052
0053   //! returns the Reference designator text
0054   Standard_EXPORT Handle(TCollection_HAsciiString) RefDesignatorText() const;
0055
0056
0057
0058
0059   DEFINE_STANDARD_RTTIEXT(IGESAppli_ReferenceDesignator,IGESData_IGESEntity)
0060
0061 protected:
0062
0063
0064
0065
0066 private:
0067
0068
0069   Standard_Integer theNbPropertyValues;
0070   Handle(TCollection_HAsciiString) theRefDesigText;
0071
0072
0073 };
0074
0075
0076
0077
0078
0079
0080
0081 #endif // _IGESAppli_ReferenceDesignator_HeaderFile