Open CASCADE Technology  7.3.1.dev
Public Member Functions
StepSelect_WorkLibrary Class Reference

Performs Read and Write a STEP File with a STEP Model Following the protocols, Copy may be implemented or not. More...

#include <StepSelect_WorkLibrary.hxx>

Inheritance diagram for StepSelect_WorkLibrary:
Inheritance graph
[legend]

Public Member Functions

 StepSelect_WorkLibrary (const Standard_Boolean copymode=Standard_True)
 Creates a STEP WorkLibrary <copymode> precises whether Copy is implemented or not. More...
 
void SetDumpLabel (const Standard_Integer mode)
 Selects a mode to dump entities 0 (D) : prints numbers, then displays table number/label 1 : prints labels, then displays table label/number 2 : prints labels onky. More...
 
Standard_Integer ReadFile (const Standard_CString name, Handle< Interface_InterfaceModel > &model, const Handle< Interface_Protocol > &protocol) const override
 Reads a STEP File and returns a STEP Model (into <mod>), or lets <mod> "Null" in case of Error Returns 0 if OK, 1 if Read Error, -1 if File not opened. More...
 
Standard_Boolean WriteFile (IFSelect_ContextWrite &ctx) const override
 Writes a File from a STEP Model Returns False (and writes no file) if <ctx> does not bring a STEP Model. More...
 
virtual Standard_Boolean CopyModel (const Handle< Interface_InterfaceModel > &original, const Handle< Interface_InterfaceModel > &newmodel, const Interface_EntityIterator &list, Interface_CopyTool &TC) const override
 Performs the copy of entities from an original model to a new one. Works according <copymode> : if True, standard copy is run else nothing is done and returned value is False. More...
 
void DumpEntity (const Handle< Interface_InterfaceModel > &model, const Handle< Interface_Protocol > &protocol, const Handle< Standard_Transient > &entity, const Handle< Message_Messenger > &S, const Standard_Integer level) const override
 Dumps an entity under STEP form, i.e. as a part of a Step file Works with a StepDumper. Level 0 just displays type; level 1 displays the entity itself and level 2 displays the entity plus its shared ones (one sub-level : immediately shared entities) More...
 
- Public Member Functions inherited from IFSelect_WorkLibrary
void DumpEntity (const Handle< Interface_InterfaceModel > &model, const Handle< Interface_Protocol > &protocol, const Handle< Standard_Transient > &entity, const Handle< Message_Messenger > &S) const
 Calls deferred DumpEntity with the recorded default level. More...
 
void SetDumpLevels (const Standard_Integer def, const Standard_Integer max)
 Records a default level and a maximum value for level level for DumpEntity can go between 0 and <max> default value will be <def> More...
 
void DumpLevels (Standard_Integer &def, Standard_Integer &max) const
 Returns the recorded default and maximum dump levels If none was recorded, max is returned negative, def as zero. More...
 
void SetDumpHelp (const Standard_Integer level, const Standard_CString help)
 Records a short line of help for a level (0 - max) More...
 
Standard_CString DumpHelp (const Standard_Integer level) const
 Returns the help line recorded for <level>, or an empty string. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Protected Member Functions inherited from IFSelect_WorkLibrary
 IFSelect_WorkLibrary ()
 Required to initialise fields. More...
 

Detailed Description

Performs Read and Write a STEP File with a STEP Model Following the protocols, Copy may be implemented or not.

Constructor & Destructor Documentation

◆ StepSelect_WorkLibrary()

StepSelect_WorkLibrary::StepSelect_WorkLibrary ( const Standard_Boolean  copymode = Standard_True)

Creates a STEP WorkLibrary <copymode> precises whether Copy is implemented or not.

Member Function Documentation

◆ CopyModel()

virtual Standard_Boolean StepSelect_WorkLibrary::CopyModel ( const Handle< Interface_InterfaceModel > &  original,
const Handle< Interface_InterfaceModel > &  newmodel,
const Interface_EntityIterator list,
Interface_CopyTool TC 
) const
overridevirtual

Performs the copy of entities from an original model to a new one. Works according <copymode> : if True, standard copy is run else nothing is done and returned value is False.

Reimplemented from IFSelect_WorkLibrary.

◆ DumpEntity()

void StepSelect_WorkLibrary::DumpEntity ( const Handle< Interface_InterfaceModel > &  model,
const Handle< Interface_Protocol > &  protocol,
const Handle< Standard_Transient > &  entity,
const Handle< Message_Messenger > &  S,
const Standard_Integer  level 
) const
overridevirtual

Dumps an entity under STEP form, i.e. as a part of a Step file Works with a StepDumper. Level 0 just displays type; level 1 displays the entity itself and level 2 displays the entity plus its shared ones (one sub-level : immediately shared entities)

Implements IFSelect_WorkLibrary.

◆ ReadFile()

Standard_Integer StepSelect_WorkLibrary::ReadFile ( const Standard_CString  name,
Handle< Interface_InterfaceModel > &  model,
const Handle< Interface_Protocol > &  protocol 
) const
overridevirtual

Reads a STEP File and returns a STEP Model (into <mod>), or lets <mod> "Null" in case of Error Returns 0 if OK, 1 if Read Error, -1 if File not opened.

Implements IFSelect_WorkLibrary.

◆ SetDumpLabel()

void StepSelect_WorkLibrary::SetDumpLabel ( const Standard_Integer  mode)

Selects a mode to dump entities 0 (D) : prints numbers, then displays table number/label 1 : prints labels, then displays table label/number 2 : prints labels onky.

◆ WriteFile()

Standard_Boolean StepSelect_WorkLibrary::WriteFile ( IFSelect_ContextWrite ctx) const
overridevirtual

Writes a File from a STEP Model Returns False (and writes no file) if <ctx> does not bring a STEP Model.

Implements IFSelect_WorkLibrary.


The documentation for this class was generated from the following file: