src/IGESAppli/IGESAppli_ReferenceDesignator.hxx

   1 // Created on: 1993-01-11
   2 // Created by: CKY / Contract Toubro-Larsen ( Arun MENON )
   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_ReferenceDesignator_HeaderFile
  18 #define _IGESAppli_ReferenceDesignator_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Integer.hxx>
  24 #include <IGESData_IGESEntity.hxx>
  25 class TCollection_HAsciiString;
  26
  27
  28 class IGESAppli_ReferenceDesignator;
  29 DEFINE_STANDARD_HANDLE(IGESAppli_ReferenceDesignator, IGESData_IGESEntity)
  30
  31 //! defines ReferenceDesignator, Type <406> Form <7>
  32 //! in package IGESAppli
  33 //! Used to attach a text string containing the value of
  34 //! a component reference designator to an entity being
  35 //! used to represent a component.
  36 class IGESAppli_ReferenceDesignator : public IGESData_IGESEntity
  37 {
  38
  39 public:
  40
  41
  42   Standard_EXPORT IGESAppli_ReferenceDesignator();
  43
  44   //! This method is used to set the fields of the class
  45   //! ReferenceDesignator
  46   //! - nbPropVal : Number of property values = 1
  47   //! - aText     : Reference designator text
  48   Standard_EXPORT void Init (const Standard_Integer nbPropVal, const Handle(TCollection_HAsciiString)& aText);
  49
  50   //! returns the number of property values
  51   //! is always 1
  52   Standard_EXPORT Standard_Integer NbPropertyValues() const;
  53
  54   //! returns the Reference designator text
  55   Standard_EXPORT Handle(TCollection_HAsciiString) RefDesignatorText() const;
  56
  57
  58
  59
  60   DEFINE_STANDARD_RTTIEXT(IGESAppli_ReferenceDesignator,IGESData_IGESEntity)
  61
  62 protected:
  63
  64
  65
  66
  67 private:
  68
  69
  70   Standard_Integer theNbPropertyValues;
  71   Handle(TCollection_HAsciiString) theRefDesigText;
  72
  73
  74 };
  75
  76
  77
  78
  79
  80
  81
  82 #endif // _IGESAppli_ReferenceDesignator_HeaderFile