include/opencascade/StepData_UndefinedEntity.hxx

0001 // Created on: 1992-02-11
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1992-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_UndefinedEntity_HeaderFile
0018 #define _StepData_UndefinedEntity_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Transient.hxx>
0024 #include <Standard_Integer.hxx>
0025 class TCollection_HAsciiString;
0026 class Interface_UndefinedContent;
0027 class StepData_StepReaderData;
0028 class Interface_Check;
0029 class StepData_StepWriter;
0030 class Interface_CopyTool;
0031 class Interface_EntityIterator;
0032
0033
0034 class StepData_UndefinedEntity;
0035 DEFINE_STANDARD_HANDLE(StepData_UndefinedEntity, Standard_Transient)
0036
0037 //! Undefined entity specific to Step Interface, in which StepType
0038 //! is defined at each instance, or is a SubList of another one
0039 //! Uses an UndefinedContent, that from Interface is suitable.
0040 //! Also an Entity defined by STEP can be "Complex Type" (see
0041 //! ANDOR clause in Express).
0042 class StepData_UndefinedEntity : public Standard_Transient
0043 {
0044
0045 public:
0046
0047
0048   //! creates an Unknown entity
0049   Standard_EXPORT StepData_UndefinedEntity();
0050
0051   //! Creates a SubList of an Unknown entity : it is an Unknown
0052   //! Entity with no Type, but flagged as "SUB" if issub is True
0053   Standard_EXPORT StepData_UndefinedEntity(const Standard_Boolean issub);
0054
0055   //! Returns the UndefinedContent which brings the Parameters
0056   Standard_EXPORT Handle(Interface_UndefinedContent) UndefinedContent() const;
0057
0058   //! Returns True if an Unndefined Entity is SubPart of another one
0059   Standard_EXPORT Standard_Boolean IsSub() const;
0060
0061   //! Returns the "super-entity" of a sub-part
0062   Standard_EXPORT Handle(StepData_UndefinedEntity) Super() const;
0063
0064   //! Returns True if <me> defines a Multiple Type Entity (see ANDOR)
0065   Standard_EXPORT Standard_Boolean IsComplex() const;
0066
0067   //! For a Multiple Type Entity, returns the Next "Component"
0068   //! For more than two Types, iterative definition (Next->Next...)
0069   //! Returns a Null Handle for the end of the List
0070   Standard_EXPORT Handle(StepData_UndefinedEntity) Next() const;
0071
0072   //! gives entity type, read from file
0073   //! For a Complex Type Entity, gives the first Type read, each
0074   //! "Next" gives its "partial" type
0075   //! was C++ : return const
0076   Standard_EXPORT Standard_CString StepType() const;
0077
0078   //! reads data from StepReaderData (i.e. from file), by filling
0079   //! StepType and parameters stored in the UndefinedContent
0080   Standard_EXPORT void ReadRecord (const Handle(StepData_StepReaderData)& SR, const Standard_Integer num, Handle(Interface_Check)& ach);
0081
0082   //! write data to StepWriter, taken from UndefinedContent
0083   Standard_EXPORT void WriteParams (StepData_StepWriter& SW) const;
0084
0085   //! reads another UndefinedEntity from StepData
0086   Standard_EXPORT void GetFromAnother (const Handle(StepData_UndefinedEntity)& other, Interface_CopyTool& TC);
0087
0088   //! Fills the list of shared entities
0089   Standard_EXPORT void FillShared (Interface_EntityIterator& list) const;
0090
0091
0092
0093
0094   DEFINE_STANDARD_RTTIEXT(StepData_UndefinedEntity,Standard_Transient)
0095
0096 protected:
0097
0098
0099
0100
0101 private:
0102
0103
0104   Handle(TCollection_HAsciiString) thetype;
0105   Handle(Interface_UndefinedContent) thecont;
0106   Standard_Boolean thesub;
0107   Handle(StepData_UndefinedEntity) thenext;
0108
0109
0110 };
0111
0112
0113
0114
0115
0116
0117
0118 #endif // _StepData_UndefinedEntity_HeaderFile