include/opencascade/StepData_FileProtocol.hxx

0001 // Created on: 1993-07-23
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 _StepData_FileProtocol_HeaderFile
0018 #define _StepData_FileProtocol_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <TColStd_SequenceOfTransient.hxx>
0024 #include <StepData_Protocol.hxx>
0025 #include <Standard_Integer.hxx>
0026 class Interface_Protocol;
0027 class Interface_Graph;
0028 class Interface_Check;
0029
0030
0031 class StepData_FileProtocol;
0032 DEFINE_STANDARD_HANDLE(StepData_FileProtocol, StepData_Protocol)
0033
0034 //! A FileProtocol is defined as the addition of several already
0035 //! existing Protocols. It corresponds to the definition of a
0036 //! SchemaName with several Names, each one being attached to a
0037 //! specific Protocol. Thus, a File defined with a compound Schema
0038 //! is processed as any other one, once built the equivalent
0039 //! compound Protocol, a FileProtocol
0040 class StepData_FileProtocol : public StepData_Protocol
0041 {
0042
0043 public:
0044
0045
0046   //! Creates an empty FileProtocol
0047   Standard_EXPORT StepData_FileProtocol();
0048
0049   //! Adds a Protocol to the definition list of the FileProtocol
0050   //! But ensures that each class of Protocol is present only once
0051   //! in this list
0052   Standard_EXPORT void Add (const Handle(StepData_Protocol)& protocol);
0053
0054   //! Gives the count of Protocols used as Resource (can be zero)
0055   //! i.e. the count of Protocol recorded by calling the method Add
0056   Standard_EXPORT virtual Standard_Integer NbResources() const Standard_OVERRIDE;
0057
0058   //! Returns a Resource, given a rank. Here, rank of calling Add
0059   Standard_EXPORT virtual Handle(Interface_Protocol) Resource (const Standard_Integer num) const Standard_OVERRIDE;
0060
0061   //! Returns a Case Number, specific of each recognized Type
0062   //! Here, NO Type at all is recognized properly : all Types are
0063   //! recognized by the resources
0064   Standard_EXPORT virtual Standard_Integer TypeNumber (const Handle(Standard_Type)& atype) const Standard_OVERRIDE;
0065
0066   //! Calls GlobalCheck for each of its recorded resources
0067   Standard_EXPORT virtual Standard_Boolean GlobalCheck (const Interface_Graph& G, Handle(Interface_Check)& ach) const Standard_OVERRIDE;
0068
0069   //! Returns the Schema Name attached to each class of Protocol
0070   //! To be redefined by each sub-class
0071   //! Here, SchemaName returns "" (empty String)
0072   //! was C++ : return const
0073   Standard_EXPORT virtual Standard_CString SchemaName() const Standard_OVERRIDE;
0074
0075
0076
0077
0078   DEFINE_STANDARD_RTTIEXT(StepData_FileProtocol,StepData_Protocol)
0079
0080 protected:
0081
0082
0083
0084
0085 private:
0086
0087
0088   TColStd_SequenceOfTransient thecomps;
0089
0090
0091 };
0092
0093
0094
0095
0096
0097
0098
0099 #endif // _StepData_FileProtocol_HeaderFile