include/opencascade/IFSelect_Functions.hxx

0001 // Created on: 1993-07-28
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 _IFSelect_Functions_HeaderFile
0018 #define _IFSelect_Functions_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_CString.hxx>
0025 #include <Standard_Integer.hxx>
0026 #include <TColStd_HSequenceOfTransient.hxx>
0027 class Standard_Transient;
0028 class IFSelect_WorkSession;
0029 class IFSelect_Dispatch;
0030
0031 //! Functions gives access to all the actions which can be
0032 //! commanded with the resources provided by IFSelect : especially
0033 //! WorkSession and various types of Selections and Dispatches
0034 //!
0035 //! It works by adding functions by method Init
0036 class IFSelect_Functions
0037 {
0038 public:
0039
0040   DEFINE_STANDARD_ALLOC
0041
0042   //! Takes the name of an entity, either as argument,
0043   //! or (if <name> is empty) on keyboard, and returns the entity
0044   //! name can be a label or a number (in alphanumeric),
0045   //! it is searched by NumberFromLabel from WorkSession.
0046   //! If <name> doesn't match en entity, a Null Handle is returned
0047   Standard_EXPORT static Handle(Standard_Transient) GiveEntity (const Handle(IFSelect_WorkSession)& WS, const Standard_CString name = "");
0048
0049   //! Same as GetEntity, but returns the number in the model of the
0050   //! entity. Returns 0 for null handle
0051   Standard_EXPORT static Standard_Integer GiveEntityNumber (const Handle(IFSelect_WorkSession)& WS, const Standard_CString name = "");
0052
0053   //! Computes a List of entities from a WorkSession and two idents,
0054   //! first and second, as follows :
0055   //! if <first> is a Number or Label of an entity : this entity
0056   //! if <first> is the name of a Selection in <WS>, and <second>
0057   //! not defined, the standard result of this Selection
0058   //! if <first> is for a Selection and <second> is defined, the
0059   //! standard result of this selection from the list computed
0060   //! with <second> (an entity or a selection)
0061   //! If <second> is erroneous, it is ignored
0062   Standard_EXPORT static Handle(TColStd_HSequenceOfTransient) GiveList (const Handle(IFSelect_WorkSession)& WS, const Standard_CString first = "", const Standard_CString second = "");
0063
0064   //! Evaluates and returns a Dispatch, from data of a WorkSession
0065   //! if <mode> is False, searches for exact name of Dispatch in WS
0066   //! Else (D), allows a parameter between brackets :
0067   //! ex.: dispatch_name(parameter)
0068   //! The parameter can be: an integer for DispPerCount or DispPerFiles
0069   //! or the name of a Signature for DispPerSignature
0070   //! Returns Null Handle if not found not well evaluated
0071   Standard_EXPORT static Handle(IFSelect_Dispatch) GiveDispatch (const Handle(IFSelect_WorkSession)& WS, const Standard_CString name, const Standard_Boolean mode = Standard_True);
0072
0073   //! Defines and loads all basic functions (as ActFunc)
0074   Standard_EXPORT static void Init();
0075
0076 };
0077
0078 #endif // _IFSelect_Functions_HeaderFile