0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / StepData / StepData_FileProtocol.hxx
diff --git a/src/StepData/StepData_FileProtocol.hxx b/src/StepData/StepData_FileProtocol.hxx
new file mode 100644 (file)
index 0000000..fe4b557
--- /dev/null
@@ -0,0 +1,103 @@
+// Created on: 1993-07-23
+// Created by: Christian CAILLET
+// Copyright (c) 1993-1999 Matra Datavision
+// Copyright (c) 1999-2014 OPEN CASCADE SAS
+//
+// This file is part of Open CASCADE Technology software library.
+//
+// This library is free software; you can redistribute it and/or modify it under
+// the terms of the GNU Lesser General Public License version 2.1 as published
+// by the Free Software Foundation, with special exception defined in the file
+// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
+// distribution for complete text of the license and disclaimer of any warranty.
+//
+// Alternatively, this file may be used under the terms of Open CASCADE
+// commercial license or contractual agreement.
+
+#ifndef _StepData_FileProtocol_HeaderFile
+#define _StepData_FileProtocol_HeaderFile
+
+#include <Standard.hxx>
+#include <Standard_Type.hxx>
+
+#include <TColStd_SequenceOfTransient.hxx>
+#include <StepData_Protocol.hxx>
+#include <Standard_Integer.hxx>
+#include <Standard_Type.hxx>
+#include <Standard_Boolean.hxx>
+#include <Standard_CString.hxx>
+class StepData_Protocol;
+class Interface_Protocol;
+class Interface_Graph;
+class Interface_Check;
+
+
+class StepData_FileProtocol;
+DEFINE_STANDARD_HANDLE(StepData_FileProtocol, StepData_Protocol)
+
+//! A FileProtocol is defined as the addition of several already
+//! existing Protocols. It corresponds to the definition of a
+//! SchemaName with several Names, each one being attached to a
+//! specific Protocol. Thus, a File defined with a compound Schema
+//! is processed as any other one, once built the equivalent
+//! compound Protocol, a FileProtocol
+class StepData_FileProtocol : public StepData_Protocol
+{
+
+public:
+
+  
+  //! Creates an empty FileProtocol
+  Standard_EXPORT StepData_FileProtocol();
+  
+  //! Adds a Protocol to the definition list of the FileProtocol
+  //! But ensures that each class of Protocol is present only once
+  //! in this list
+  Standard_EXPORT void Add (const Handle(StepData_Protocol)& protocol);
+  
+  //! Gives the count of Protocols used as Resource (can be zero)
+  //! i.e. the count of Protocol recorded by calling the method Add
+  Standard_EXPORT virtual Standard_Integer NbResources() const Standard_OVERRIDE;
+  
+  //! Returns a Resource, given a rank. Here, rank of calling Add
+  Standard_EXPORT virtual Handle(Interface_Protocol) Resource (const Standard_Integer num) const Standard_OVERRIDE;
+  
+  //! Returns a Case Number, specific of each recognized Type
+  //! Here, NO Type at all is recognized properly : all Types are
+  //! recognized by the resources
+  Standard_EXPORT virtual Standard_Integer TypeNumber (const Handle(Standard_Type)& atype) const Standard_OVERRIDE;
+  
+  //! Calls GlobalCheck for each of its recorded ressources
+  Standard_EXPORT virtual Standard_Boolean GlobalCheck (const Interface_Graph& G, Handle(Interface_Check)& ach) const Standard_OVERRIDE;
+  
+  //! Returns the Schema Name attached to each class of Protocol
+  //! To be redefined by each sub-class
+  //! Here, SchemaName returns "" (empty String)
+  //! was C++ : return const
+  Standard_EXPORT virtual Standard_CString SchemaName() const Standard_OVERRIDE;
+
+
+
+
+  DEFINE_STANDARD_RTTI(StepData_FileProtocol,StepData_Protocol)
+
+protected:
+
+
+
+
+private:
+
+
+  TColStd_SequenceOfTransient thecomps;
+
+
+};
+
+
+
+
+
+
+
+#endif // _StepData_FileProtocol_HeaderFile