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