include/opencascade/IGESAppli_FlowLineSpec.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_FlowLineSpec_HeaderFile
0018 #define _IGESAppli_FlowLineSpec_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <TCollection_HAsciiString.hxx>
0023 #include <NCollection_Array1.hxx>
0024 #include <NCollection_HArray1.hxx>
0025 #include <IGESData_IGESEntity.hxx>
0026 #include <Standard_Integer.hxx>
0027 class TCollection_HAsciiString;
0028
0029 //! defines FlowLineSpec, Type <406> Form <14>
0030 //! in package IGESAppli
0031 //! Attaches one or more text strings to entities being
0032 //! used to represent a flow line
0033 class IGESAppli_FlowLineSpec : public IGESData_IGESEntity
0034 {
0035
0036 public:
0037   Standard_EXPORT IGESAppli_FlowLineSpec();
0038
0039   //! This method is used to set the fields of the class
0040   //! FlowLineSpec
0041   //! - allProperties : primary flow line specification and modifiers
0042   Standard_EXPORT void Init(
0043     const occ::handle<NCollection_HArray1<occ::handle<TCollection_HAsciiString>>>& allProperties);
0044
0045   //! returns the number of property values
0046   Standard_EXPORT int NbPropertyValues() const;
0047
0048   //! returns primary flow line specification name
0049   Standard_EXPORT occ::handle<TCollection_HAsciiString> FlowLineName() const;
0050
0051   //! returns specified modifier element
0052   //! raises exception if Index <= 1 or Index > NbPropertyValues
0053   Standard_EXPORT occ::handle<TCollection_HAsciiString> Modifier(const int Index) const;
0054
0055   DEFINE_STANDARD_RTTIEXT(IGESAppli_FlowLineSpec, IGESData_IGESEntity)
0056
0057 private:
0058   occ::handle<NCollection_HArray1<occ::handle<TCollection_HAsciiString>>> theNameAndModifiers;
0059 };
0060
0061 #endif // _IGESAppli_FlowLineSpec_HeaderFile