Open CASCADE Technology 7.8.0
Public Member Functions | Static Public Member Functions
IGESSelect_WorkLibrary Class Reference

Performs Read and Write an IGES File with an IGES Model. More...

#include <IGESSelect_WorkLibrary.hxx>

Inheritance diagram for IGESSelect_WorkLibrary:
Inheritance graph
[legend]

Public Member Functions

 IGESSelect_WorkLibrary (const Standard_Boolean modefnes=Standard_False)
 Creates a IGES WorkLibrary If <modefnes> is given as True, it will work for FNES.
 
Standard_Integer ReadFile (const Standard_CString name, Handle< Interface_InterfaceModel > &model, const Handle< Interface_Protocol > &protocol) const override
 Reads a IGES File and returns a IGES Model (into <mod>), or lets <mod> "Null" in case of Error Returns 0 if OK, 1 if Read Error, -1 if File not opened.
 
Standard_Boolean WriteFile (IFSelect_ContextWrite &ctx) const override
 Writes a File from a IGES Model (brought by <ctx>) Returns False (and writes no file) if <ctx> is not for IGES.
 
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 override
 Dumps an IGES Entity with an IGES Dumper. <level> is the one used by IGESDumper.
 
- Public Member Functions inherited from IFSelect_WorkLibrary
virtual Standard_Integer ReadStream (const Standard_CString theName, std::istream &theIStream, Handle< Interface_InterfaceModel > &model, const Handle< Interface_Protocol > &protocol) const
 Interface to read a data from the specified stream.
 
virtual Standard_Boolean CopyModel (const Handle< Interface_InterfaceModel > &original, const Handle< Interface_InterfaceModel > &newmodel, const Interface_EntityIterator &list, Interface_CopyTool &TC) const
 Performs the copy of entities from an original model to a new one. It must also copy headers if any. Returns True when done. The provided default works by copying the individual entities designated in the list, by using the general service class CopyTool. It can be redefined for a norm which, either implements Copy by another way (do not forget to Bind each copied result with its original entity in TC) and returns True, or does not know how to copy and returns False.
 
void DumpEntity (const Handle< Interface_InterfaceModel > &model, const Handle< Interface_Protocol > &protocol, const Handle< Standard_Transient > &entity, Standard_OStream &S) const
 Calls deferred DumpEntity with the recorded default level.
 
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>
 
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.
 
void SetDumpHelp (const Standard_Integer level, const Standard_CString help)
 Records a short line of help for a level (0 - max)
 
Standard_CString DumpHelp (const Standard_Integer level) const
 Returns the help line recorded for <level>, or an empty string.
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor.
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing.
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter.
 
virtual ~Standard_Transient ()
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
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.
 
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.
 
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.
 
Standard_Integer GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object.
 
Standard_Integer DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 

Static Public Member Functions

static Handle< IGESData_ProtocolDefineProtocol ()
 Defines a protocol to be adequate for IGES (encompasses ALL the IGES norm including IGESSolid, IGESAppli)
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const charget_type_name ()
 Returns a type descriptor about this object.
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class.
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Protected Member Functions inherited from IFSelect_WorkLibrary
 IFSelect_WorkLibrary ()
 Required to initialise fields.
 

Detailed Description

Performs Read and Write an IGES File with an IGES Model.

Constructor & Destructor Documentation

◆ IGESSelect_WorkLibrary()

IGESSelect_WorkLibrary::IGESSelect_WorkLibrary ( const Standard_Boolean  modefnes = Standard_False)

Creates a IGES WorkLibrary If <modefnes> is given as True, it will work for FNES.

Member Function Documentation

◆ DefineProtocol()

static Handle< IGESData_Protocol > IGESSelect_WorkLibrary::DefineProtocol ( )
static

Defines a protocol to be adequate for IGES (encompasses ALL the IGES norm including IGESSolid, IGESAppli)

◆ DumpEntity()

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

Dumps an IGES Entity with an IGES Dumper. <level> is the one used by IGESDumper.

Implements IFSelect_WorkLibrary.

◆ ReadFile()

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

Reads a IGES File and returns a IGES 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.

◆ WriteFile()

Standard_Boolean IGESSelect_WorkLibrary::WriteFile ( IFSelect_ContextWrite ctx) const
overridevirtual

Writes a File from a IGES Model (brought by <ctx>) Returns False (and writes no file) if <ctx> is not for IGES.

Implements IFSelect_WorkLibrary.


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