0031687: Draw Harness, ViewerTest - extend command vrenderparams with option updating...
[occt.git] / src / StepSelect / StepSelect_WorkLibrary.hxx
CommitLineData
42cf5bc1 1// Created on: 1994-09-14
2// Created by: Christian CAILLET
3// Copyright (c) 1994-1999 Matra Datavision
4// Copyright (c) 1999-2014 OPEN CASCADE SAS
5//
6// This file is part of Open CASCADE Technology software library.
7//
8// This library is free software; you can redistribute it and/or modify it under
9// the terms of the GNU Lesser General Public License version 2.1 as published
10// by the Free Software Foundation, with special exception defined in the file
11// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12// distribution for complete text of the license and disclaimer of any warranty.
13//
14// Alternatively, this file may be used under the terms of Open CASCADE
15// commercial license or contractual agreement.
16
17#ifndef _StepSelect_WorkLibrary_HeaderFile
18#define _StepSelect_WorkLibrary_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_Type.hxx>
22
23#include <Standard_Boolean.hxx>
24#include <Standard_Integer.hxx>
25#include <IFSelect_WorkLibrary.hxx>
26#include <Standard_CString.hxx>
27class Interface_InterfaceModel;
28class Interface_Protocol;
29class IFSelect_ContextWrite;
30class Interface_EntityIterator;
31class Interface_CopyTool;
42cf5bc1 32
33class StepSelect_WorkLibrary;
34DEFINE_STANDARD_HANDLE(StepSelect_WorkLibrary, IFSelect_WorkLibrary)
35
36//! Performs Read and Write a STEP File with a STEP Model
37//! Following the protocols, Copy may be implemented or not
38class StepSelect_WorkLibrary : public IFSelect_WorkLibrary
39{
40
41public:
42
43
44 //! Creates a STEP WorkLibrary
45 //! <copymode> precises whether Copy is implemented or not
46 Standard_EXPORT StepSelect_WorkLibrary(const Standard_Boolean copymode = Standard_True);
47
48 //! Selects a mode to dump entities
49 //! 0 (D) : prints numbers, then displays table number/label
50 //! 1 : prints labels, then displays table label/number
51 //! 2 : prints labels onky
52 Standard_EXPORT void SetDumpLabel (const Standard_Integer mode);
53
54 //! Reads a STEP File and returns a STEP Model (into <mod>),
55 //! or lets <mod> "Null" in case of Error
56 //! Returns 0 if OK, 1 if Read Error, -1 if File not opened
79104795 57 Standard_EXPORT Standard_Integer ReadFile (const Standard_CString name, Handle(Interface_InterfaceModel)& model, const Handle(Interface_Protocol)& protocol) const Standard_OVERRIDE;
42cf5bc1 58
59 //! Writes a File from a STEP Model
60 //! Returns False (and writes no file) if <ctx> does not bring a
61 //! STEP Model
79104795 62 Standard_EXPORT Standard_Boolean WriteFile (IFSelect_ContextWrite& ctx) const Standard_OVERRIDE;
42cf5bc1 63
64 //! Performs the copy of entities from an original model to a new
65 //! one. Works according <copymode> :
66 //! if True, standard copy is run
67 //! else nothing is done and returned value is False
68 Standard_EXPORT virtual Standard_Boolean CopyModel (const Handle(Interface_InterfaceModel)& original, const Handle(Interface_InterfaceModel)& newmodel, const Interface_EntityIterator& list, Interface_CopyTool& TC) const Standard_OVERRIDE;
69
70 //! Dumps an entity under STEP form, i.e. as a part of a Step file
71 //! Works with a StepDumper.
72 //! Level 0 just displays type; level 1 displays the entity itself
73 //! and level 2 displays the entity plus its shared ones (one
74 //! sub-level : immediately shared entities)
0ebe5b0a 75 Standard_EXPORT virtual void DumpEntity (const Handle(Interface_InterfaceModel)& model, const Handle(Interface_Protocol)& protocol, const Handle(Standard_Transient)& entity, Standard_OStream& S, const Standard_Integer level) const Standard_OVERRIDE;
42cf5bc1 76
77
78
79
92efcf78 80 DEFINE_STANDARD_RTTIEXT(StepSelect_WorkLibrary,IFSelect_WorkLibrary)
42cf5bc1 81
82protected:
83
84
85
86
87private:
88
89
90 Standard_Boolean thecopymode;
91 Standard_Integer thelabmode;
92
93
94};
95
96
97
98
99
100
101
102#endif // _StepSelect_WorkLibrary_HeaderFile