include/opencascade/StepData_FreeFormEntity.hxx

0001 // Created on: 1997-01-03
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1997-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 _StepData_FreeFormEntity_HeaderFile
0018 #define _StepData_FreeFormEntity_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <StepData_HArray1OfField.hxx>
0024 #include <Standard_Transient.hxx>
0025 #include <Standard_CString.hxx>
0026 #include <TColStd_HSequenceOfAsciiString.hxx>
0027 #include <Standard_Integer.hxx>
0028 class StepData_Field;
0029
0030
0031 class StepData_FreeFormEntity;
0032 DEFINE_STANDARD_HANDLE(StepData_FreeFormEntity, Standard_Transient)
0033
0034 //! A Free Form Entity allows to record any kind of STEP
0035 //! parameters, in any way of typing
0036 //! It is implemented with an array of fields
0037 //! A Complex entity can be defined, as a chain of FreeFormEntity
0038 //! (see Next and As)
0039 class StepData_FreeFormEntity : public Standard_Transient
0040 {
0041
0042 public:
0043
0044
0045   //! Creates a FreeFormEntity, with no field, no type
0046   Standard_EXPORT StepData_FreeFormEntity();
0047
0048   //! Sets the type of an entity
0049   //! For a complex one, the type of this member
0050   Standard_EXPORT void SetStepType (const Standard_CString typenam);
0051
0052   //! Returns the recorded StepType
0053   //! For a complex one, the type of this member
0054   Standard_EXPORT Standard_CString StepType() const;
0055
0056   //! Sets a next member, in order to define or complete a Complex
0057   //! entity
0058   //! If <last> is True (D), this next will be set as last of list
0059   //! Else, it is inserted just as next of <me>
0060   //! If <next> is Null, Next is cleared
0061   Standard_EXPORT void SetNext (const Handle(StepData_FreeFormEntity)& next, const Standard_Boolean last = Standard_True);
0062
0063   //! Returns the next member of a Complex entity
0064   //! (remark : the last member has none)
0065   Standard_EXPORT Handle(StepData_FreeFormEntity) Next() const;
0066
0067   //! Returns True if a FreeFormEntity is Complex (i.e. has Next)
0068   Standard_EXPORT Standard_Boolean IsComplex() const;
0069
0070   //! Returns the member of a FreeFormEntity of which the type name
0071   //! is given (exact match, no sub-type)
0072   Standard_EXPORT Handle(StepData_FreeFormEntity) Typed (const Standard_CString typenam) const;
0073
0074   //! Returns the list of types (one type for a simple entity),
0075   //! as is (non reordered)
0076   Standard_EXPORT Handle(TColStd_HSequenceOfAsciiString) TypeList() const;
0077
0078   //! Reorders a Complex entity if required, i.e. if member types
0079   //! are not in alphabetic order
0080   //! Returns False if nothing done (order was OK or simple entity),
0081   //! True plus modified <ent> if <ent> has been reordered
0082   Standard_EXPORT static Standard_Boolean Reorder (Handle(StepData_FreeFormEntity)& ent);
0083
0084   //! Sets a count of Fields, from scratch
0085   Standard_EXPORT void SetNbFields (const Standard_Integer nb);
0086
0087   //! Returns the count of fields
0088   Standard_EXPORT Standard_Integer NbFields() const;
0089
0090   //! Returns a field from its rank, for read-only use
0091   Standard_EXPORT const StepData_Field& Field (const Standard_Integer num) const;
0092
0093   //! Returns a field from its rank, in order to modify it
0094   Standard_EXPORT StepData_Field& CField (const Standard_Integer num);
0095
0096
0097
0098
0099   DEFINE_STANDARD_RTTIEXT(StepData_FreeFormEntity,Standard_Transient)
0100
0101 protected:
0102
0103
0104
0105
0106 private:
0107
0108
0109   TCollection_AsciiString thetype;
0110   Handle(StepData_HArray1OfField) thefields;
0111   Handle(StepData_FreeFormEntity) thenext;
0112
0113
0114 };
0115
0116
0117
0118
0119
0120
0121
0122 #endif // _StepData_FreeFormEntity_HeaderFile