include/opencascade/StepSelect_StepType.hxx

0001 // Created on: 1994-12-22
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1994-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 _StepSelect_StepType_HeaderFile
0018 #define _StepSelect_StepType_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <StepData_WriterLib.hxx>
0024 #include <IFSelect_Signature.hxx>
0025 #include <Standard_CString.hxx>
0026 class StepData_Protocol;
0027 class Interface_Protocol;
0028 class Standard_Transient;
0029 class Interface_InterfaceModel;
0030
0031 class StepSelect_StepType;
0032 DEFINE_STANDARD_HANDLE(StepSelect_StepType, IFSelect_Signature)
0033
0034 //! StepType is a Signature specific to Step definitions : it
0035 //! considers the type as defined in STEP Schemas, the same which
0036 //! is used in files.
0037 //! For a Complex Type, if its definition is known, StepType
0038 //! produces the list of basic types, separated by commas, the
0039 //! whole between brackets : "(TYPE1,TYPE2..)".
0040 //! If its precise definition is not known (simply it is known as
0041 //! Complex, it can be recognised, but the list is produced at
0042 //! Write time only), StepType produces : "(..COMPLEX TYPE..)"
0043 class StepSelect_StepType : public IFSelect_Signature
0044 {
0045
0046 public:
0047   //! Creates a Signature for Step Type. Protocol is undefined here,
0048   //! hence no Signature may yet be produced. The StepType signature
0049   //! requires a Protocol before working
0050   Standard_EXPORT StepSelect_StepType();
0051
0052   //! Sets the StepType signature to work with a Protocol : this
0053   //! initialises the library
0054   Standard_EXPORT void SetProtocol(const Handle(Interface_Protocol)& proto);
0055
0056   //! Returns the Step Type defined from the Protocol (see above).
0057   //! If <ent> is not recognised, produces "..NOT FROM SCHEMA <name>.."
0058   Standard_EXPORT Standard_CString
0059     Value(const Handle(Standard_Transient)&       ent,
0060           const Handle(Interface_InterfaceModel)& model) const Standard_OVERRIDE;
0061
0062   DEFINE_STANDARD_RTTIEXT(StepSelect_StepType, IFSelect_Signature)
0063
0064 protected:
0065   StepData_WriterLib thelib;
0066
0067 private:
0068   Handle(StepData_Protocol) theproto;
0069 };
0070
0071 #endif // _StepSelect_StepType_HeaderFile