include/opencascade/IGESData_SpecificModule.hxx

0001 // Created on: 1993-09-07
0002 // Created by: Christian CAILLET
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 _IGESData_SpecificModule_HeaderFile
0018 #define _IGESData_SpecificModule_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Transient.hxx>
0024 #include <Standard_Integer.hxx>
0025 class IGESData_IGESEntity;
0026 class IGESData_IGESDumper;
0027
0028
0029 class IGESData_SpecificModule;
0030 DEFINE_STANDARD_HANDLE(IGESData_SpecificModule, Standard_Transient)
0031
0032 //! This class defines some Services which are specifically
0033 //! attached to IGES Entities : Dump
0034 class IGESData_SpecificModule : public Standard_Transient
0035 {
0036
0037 public:
0038
0039
0040   //! Specific Dump for each type of IGES Entity : it concerns only
0041   //! own parameters, the general data (Directory Part, Lists) are
0042   //! taken into account by the IGESDumper
0043   //! See class IGESDumper for the rules to follow for <own> and
0044   //! <attached> level
0045   Standard_EXPORT virtual void OwnDump (const Standard_Integer CN, const Handle(IGESData_IGESEntity)& ent, const IGESData_IGESDumper& dumper, Standard_OStream& S, const Standard_Integer own) const = 0;
0046
0047   //! Specific Automatic Correction on own Parameters of an Entity.
0048   //! It works by setting in accordance redundant data, if there are
0049   //! when there is no ambiguity (else, it does nothing).
0050   //! Remark that classic Corrections on Directory Entry (to set
0051   //! void data) are taken into account alsewhere.
0052   //!
0053   //! For instance, many "Associativity Entities" have a Number of
0054   //! Properties which must have a fixed value.
0055   //! Or, a ConicalArc has its Form Number which records the kind of
0056   //! Conic, also determined from its coefficients
0057   //! But, a CircularArc of which Distances (Center-Start) and
0058   //! (Center-End) are not equal cannot be corrected ...
0059   //!
0060   //! Returns True if something has been corrected in <ent>
0061   //! By default, does nothing. If at least one of the Types
0062   //! processed by a sub-class of SpecificModule has a Correct
0063   //! procedure attached, this method can be redefined
0064   Standard_EXPORT virtual Standard_Boolean OwnCorrect (const Standard_Integer CN, const Handle(IGESData_IGESEntity)& ent) const;
0065
0066
0067
0068
0069   DEFINE_STANDARD_RTTIEXT(IGESData_SpecificModule,Standard_Transient)
0070
0071 protected:
0072
0073
0074
0075
0076 private:
0077
0078
0079
0080
0081 };
0082
0083
0084
0085
0086
0087
0088
0089 #endif // _IGESData_SpecificModule_HeaderFile