include/opencascade/StepData_Protocol.hxx

0001 // Created on: 1993-02-03
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_Protocol_HeaderFile
0018 #define _StepData_Protocol_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Interface_DataMapOfTransientInteger.hxx>
0024 #include <Interface_Protocol.hxx>
0025 #include <Standard_Integer.hxx>
0026 #include <TColStd_SequenceOfAsciiString.hxx>
0027 class Interface_InterfaceModel;
0028 class StepData_EDescr;
0029 class StepData_ESDescr;
0030 class StepData_ECDescr;
0031 class StepData_PDescr;
0032
0033
0034 class StepData_Protocol;
0035 DEFINE_STANDARD_HANDLE(StepData_Protocol, Interface_Protocol)
0036
0037 //! Description of Basic Protocol for Step
0038 //! The class Protocol from StepData itself describes a default
0039 //! Protocol, which recognizes only UnknownEntities.
0040 //! Sub-classes will redefine CaseNumber and, if necessary,
0041 //! NbResources and Resources.
0042 class StepData_Protocol : public Interface_Protocol
0043 {
0044
0045 public:
0046
0047
0048   Standard_EXPORT StepData_Protocol();
0049
0050   //! Gives the count of Protocols used as Resource (can be zero)
0051   //! Here, No resource
0052   Standard_EXPORT Standard_Integer NbResources() const Standard_OVERRIDE;
0053
0054   //! Returns a Resource, given a rank. Here, none
0055   Standard_EXPORT Handle(Interface_Protocol) Resource (const Standard_Integer num) const Standard_OVERRIDE;
0056
0057   //! Returns a unique positive number for any recognized entity
0058   //! Redefined to work by calling both TypeNumber and, for a
0059   //! Described Entity (late binding) DescrNumber
0060   Standard_EXPORT virtual Standard_Integer CaseNumber (const Handle(Standard_Transient)& obj) const Standard_OVERRIDE;
0061
0062   //! Returns a Case Number, specific of each recognized Type
0063   //! Here, only Unknown Entity is recognized
0064   Standard_EXPORT Standard_Integer TypeNumber (const Handle(Standard_Type)& atype) const Standard_OVERRIDE;
0065
0066   //! Returns the Schema Name attached to each class of Protocol
0067   //! To be redefined by each sub-class
0068   //! Here, SchemaName returns "(DEFAULT)"
0069   //! was C++ : return const
0070   Standard_EXPORT virtual Standard_CString SchemaName() const;
0071
0072   //! Creates an empty Model for Step Norm
0073   Standard_EXPORT Handle(Interface_InterfaceModel) NewModel() const Standard_OVERRIDE;
0074
0075   //! Returns True if <model> is a Model of Step Norm
0076   Standard_EXPORT Standard_Boolean IsSuitableModel (const Handle(Interface_InterfaceModel)& model) const Standard_OVERRIDE;
0077
0078   //! Creates a new Unknown Entity for Step (UndefinedEntity)
0079   Standard_EXPORT Handle(Standard_Transient) UnknownEntity() const Standard_OVERRIDE;
0080
0081   //! Returns True if <ent> is an Unknown Entity for the Norm, i.e.
0082   //! Type UndefinedEntity, status Unknown
0083   Standard_EXPORT Standard_Boolean IsUnknownEntity (const Handle(Standard_Transient)& ent) const Standard_OVERRIDE;
0084
0085   //! Returns a unique positive CaseNumber for types described by
0086   //! an EDescr (late binding)
0087   //! Warning : TypeNumber and DescrNumber must give together a unique
0088   //! positive case number for each distinct case, type or descr
0089   Standard_EXPORT virtual Standard_Integer DescrNumber (const Handle(StepData_EDescr)& adescr) const;
0090
0091   //! Records an EDescr with its case number
0092   //! Also records its name for an ESDescr (simple type): an ESDescr
0093   //! is then used, for case number, or for type name
0094   Standard_EXPORT void AddDescr (const Handle(StepData_EDescr)& adescr, const Standard_Integer CN);
0095
0096   //! Tells if a Protocol brings at least one ESDescr, i.e. if it
0097   //! defines at least one entity description by ESDescr mechanism
0098   Standard_EXPORT Standard_Boolean HasDescr() const;
0099
0100   //! Returns the description attached to a case number, or null
0101   Standard_EXPORT Handle(StepData_EDescr) Descr (const Standard_Integer num) const;
0102
0103   //! Returns a description according to its name
0104   //! <anylevel> True (D) : for <me> and its resources
0105   //! <anylevel> False : for <me> only
0106   Standard_EXPORT Handle(StepData_EDescr) Descr (const Standard_CString name, const Standard_Boolean anylevel = Standard_True) const;
0107
0108   //! Idem as Descr but cast to simple description
0109   Standard_EXPORT Handle(StepData_ESDescr) ESDescr (const Standard_CString name, const Standard_Boolean anylevel = Standard_True) const;
0110
0111   //! Returns a complex description according to list of names
0112   //! <anylevel> True (D) : for <me> and its resources
0113   //! <anylevel> False : for <me> only
0114   Standard_EXPORT Handle(StepData_ECDescr) ECDescr (const TColStd_SequenceOfAsciiString& names, const Standard_Boolean anylevel = Standard_True) const;
0115
0116   //! Records an PDescr
0117   Standard_EXPORT void AddPDescr (const Handle(StepData_PDescr)& pdescr);
0118
0119   //! Returns a parameter description according to its name
0120   //! <anylevel> True (D) : for <me> and its resources
0121   //! <anylevel> False : for <me> only
0122   Standard_EXPORT Handle(StepData_PDescr) PDescr (const Standard_CString name, const Standard_Boolean anylevel = Standard_True) const;
0123
0124   //! Records an ESDescr, intended to build complex descriptions
0125   Standard_EXPORT void AddBasicDescr (const Handle(StepData_ESDescr)& esdescr);
0126
0127   //! Returns a basic description according to its name
0128   //! <anylevel> True (D) : for <me> and its resources
0129   //! <anylevel> False : for <me> only
0130   Standard_EXPORT Handle(StepData_EDescr) BasicDescr (const Standard_CString name, const Standard_Boolean anylevel = Standard_True) const;
0131
0132
0133
0134
0135   DEFINE_STANDARD_RTTIEXT(StepData_Protocol,Interface_Protocol)
0136
0137 protected:
0138
0139
0140
0141
0142 private:
0143
0144
0145   Interface_DataMapOfTransientInteger thedscnum;
0146   NCollection_DataMap<TCollection_AsciiString, Handle(Standard_Transient)> thedscnam;
0147   NCollection_DataMap<TCollection_AsciiString, Handle(Standard_Transient)> thepdescr;
0148   NCollection_DataMap<TCollection_AsciiString, Handle(Standard_Transient)> thedscbas;
0149
0150
0151 };
0152
0153
0154
0155
0156
0157
0158
0159 #endif // _StepData_Protocol_HeaderFile