Back to home page

EIC code displayed by LXR

 
 

    


File indexing completed on 2025-01-18 10:05:36

0001 // Created on: 1995-03-16
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1995-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 _XSControl_FuncShape_HeaderFile
0018 #define _XSControl_FuncShape_HeaderFile
0019 
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023 
0024 #include <Standard_Integer.hxx>
0025 #include <TopTools_HSequenceOfShape.hxx>
0026 #include <Standard_CString.hxx>
0027 class XSControl_WorkSession;
0028 class TCollection_AsciiString;
0029 
0030 
0031 //! Defines additional commands for XSControl to :
0032 //! - control of initialisation (xinit, xnorm, newmodel)
0033 //! - analyse of the result of a transfer (recorded in a
0034 //! TransientProcess for Read, FinderProcess for Write) :
0035 //! statistics, various lists (roots,complete,abnormal), what
0036 //! about one specific entity, producing a model with the
0037 //! abnormal result
0038 //!
0039 //! This appendix of XSControl is compiled separately to distinguish
0040 //! basic features from user callable forms
0041 class XSControl_FuncShape 
0042 {
0043 public:
0044 
0045   DEFINE_STANDARD_ALLOC
0046 
0047   
0048   //! Defines and loads all functions which work on shapes for XSControl (as ActFunc)
0049   Standard_EXPORT static void Init();
0050   
0051   //! Analyses a name as designating Shapes from a Vars or from
0052   //! XSTEP transfer (last Transfer on Reading). <name> can be :
0053   //! "*" : all the root shapes produced by last Transfer (Read)
0054   //! i.e. considers roots of the TransientProcess
0055   //! a name : a name of a variable DRAW
0056   //!
0057   //! Returns the count of designated Shapes. Their list is put in
0058   //! <list>. If <list> is null, it is firstly created. Then it is
0059   //! completed (Append without Clear) by the Shapes found
0060   //! Returns 0 if no Shape could be found
0061   Standard_EXPORT static Standard_Integer MoreShapes (const Handle(XSControl_WorkSession)& session, Handle(TopTools_HSequenceOfShape)& list, const Standard_CString name);
0062   
0063   //! Analyses given file name and variable name, with a default
0064   //! name for variables. Returns resulting file name and variable
0065   //! name plus status "file to read"(True) or "already read"(False)
0066   //! In the latter case, empty resfile means no file available
0067   //!
0068   //! If <file> is null or empty or equates ".", considers Session
0069   //! and returned status is False
0070   //! Else, returns resfile = file and status is True
0071   //! If <var> is neither null nor empty, resvar = var
0072   //! Else, the root part of <resfile> is considered, if defined
0073   //! Else, <def> is taken
0074   Standard_EXPORT static Standard_Boolean FileAndVar (const Handle(XSControl_WorkSession)& session, const Standard_CString file, const Standard_CString var, const Standard_CString def, TCollection_AsciiString& resfile, TCollection_AsciiString& resvar);
0075 
0076 
0077 
0078 
0079 protected:
0080 
0081 
0082 
0083 
0084 
0085 private:
0086 
0087 
0088 
0089 
0090 
0091 };
0092 
0093 
0094 
0095 
0096 
0097 
0098 
0099 #endif // _XSControl_FuncShape_HeaderFile