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