include/opencascade/IGESDefs_GenericData.hxx

0001 // Created on: 1993-01-09
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 _IGESDefs_GenericData_HeaderFile
0018 #define _IGESDefs_GenericData_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <NCollection_Array1.hxx>
0024 #include <NCollection_HArray1.hxx>
0025 #include <Standard_Transient.hxx>
0026 #include <IGESData_IGESEntity.hxx>
0027 #include <Standard_Real.hxx>
0028 class TCollection_HAsciiString;
0029 class Standard_Transient;
0030
0031 //! defines IGES Generic Data, Type <406> Form <27>
0032 //! in package IGESDefs
0033 //! Used to communicate information defined by the system
0034 //! operator while creating the model. The information is
0035 //! system specific and does not map into one of the
0036 //! predefined properties or associativities. Properties
0037 //! and property values can be defined by multiple
0038 //! instances of this property.
0039 class IGESDefs_GenericData : public IGESData_IGESEntity
0040 {
0041
0042 public:
0043   Standard_EXPORT IGESDefs_GenericData();
0044
0045   //! This method is used to set the fields of the class
0046   //! GenericData
0047   //! - nbPropVal : Number of property values
0048   //! - aName     : Property Name
0049   //! - allTypes  : Property Types
0050   //! - allValues : Property Values
0051   Standard_EXPORT void Init(
0052     const int                                                                nbPropVal,
0053     const occ::handle<TCollection_HAsciiString>&                             aName,
0054     const occ::handle<NCollection_HArray1<int>>&                             allTypes,
0055     const occ::handle<NCollection_HArray1<occ::handle<Standard_Transient>>>& allValues);
0056
0057   //! returns the number of property values
0058   Standard_EXPORT int NbPropertyValues() const;
0059
0060   //! returns property name
0061   Standard_EXPORT occ::handle<TCollection_HAsciiString> Name() const;
0062
0063   //! returns the number of TYPE/VALUE pairs
0064   Standard_EXPORT int NbTypeValuePairs() const;
0065
0066   //! returns the Index'th property value data type
0067   //! raises exception if Index <= 0 or Index > NbTypeValuePairs()
0068   Standard_EXPORT int Type(const int Index) const;
0069
0070   //! HArray1OfInteger (length 1), HArray1OfReal (length 1) for
0071   //! Integer, Real, Boolean (= Integer 0/1),
0072   //! HAsciiString for String (the value itself),
0073   //! IGESEntity for Entity (the value itself)
0074   Standard_EXPORT occ::handle<Standard_Transient> Value(const int Index) const;
0075
0076   //! Returns Attribute Value <AttrNum, rank ValueNum> as an Integer
0077   //! Error if Index out of Range, or not an Integer
0078   Standard_EXPORT int ValueAsInteger(const int ValueNum) const;
0079
0080   //! Returns Attribute Value <AttrNum, rank ValueNum> as a Real
0081   //! Error if Index out of Range, or not a Real
0082   Standard_EXPORT double ValueAsReal(const int ValueNum) const;
0083
0084   //! Returns Attribute Value <AttrNum, rank ValueNum> as an Integer
0085   Standard_EXPORT occ::handle<TCollection_HAsciiString> ValueAsString(const int ValueNum) const;
0086
0087   //! Returns Attribute Value <AttrNum, rank ValueNum> as an Entity
0088   //! Error if Index out of Range, or not a Entity
0089   Standard_EXPORT occ::handle<IGESData_IGESEntity> ValueAsEntity(const int ValueNum) const;
0090
0091   //! Returns Attribute Value <AttrNum, rank ValueNum> as a Boolean
0092   //! Error if Index out of Range, or not a Logical
0093   Standard_EXPORT bool ValueAsLogical(const int ValueNum) const;
0094
0095   DEFINE_STANDARD_RTTIEXT(IGESDefs_GenericData, IGESData_IGESEntity)
0096
0097 private:
0098   int                                                               theNbPropertyValues;
0099   occ::handle<TCollection_HAsciiString>                             theName;
0100   occ::handle<NCollection_HArray1<int>>                             theTypes;
0101   occ::handle<NCollection_HArray1<occ::handle<Standard_Transient>>> theValues;
0102 };
0103
0104 #endif // _IGESDefs_GenericData_HeaderFile