# DataExchange
TKXSBase
IFSelect

# IFSelect_WorkLibrary Class Reference

This class defines the (empty) frame which can be used to
enrich a XSTEP set with new capabilities
In particular, a specific WorkLibrary must give the way for
Reading a File into a Model, and Writing a Model to a File
Thus, it is possible to define several Work Libraries for each
norm, but recommanded to define one general class for each one :
this general class will define the Read and Write methods.
Also a Dump service is provided, it can produce, according the
norm, either a parcel of a file for an entity, or any other
kind of informations relevant for the norm,
.

`#include <IFSelect_WorkLibrary.hxx>`

Inheritance diagram for IFSelect_WorkLibrary:

[legend]

## Public Member Functions

virtual Standard_EXPORT Standard_Integer | ReadFile (const Standard_CString name, Handle(Interface_InterfaceModel)&model, const Handle(Interface_Protocol)&protocol) const =0
| Gives the way to Read a File and transfer it to a Model <mod> is the resulting Model, which has to be created by this method. In case of error, <mod> must be returned Null Return value is a status with free values. Simply, 0 is for "Execution OK" The Protocol can be used to work (e.g. create the Model, read and recognize the Entities) .
virtual Standard_EXPORT Standard_Boolean | WriteFile (IFSelect_ContextWrite &ctx) const =0

Gives the way to Write a File from a Model.
<ctx> contains all necessary informations : the model, the
protocol, the file name, and the list of File Modifiers to be
applied, also with restricted list of selected entities for
each one, if required.
In return, it brings the produced check-list
The WorkLibrary has to query <applied> to get then run the
ContextWrite by looping like this (example) :
for (numap = 1; numap <= ctx.NbModifiers(); numap ++) {
ctx.SetModifier (numap);
cast ctx.FileModifier() to specific type -> variable filemod
if (!filemod.IsNull()) filemod->Perform (ctx,writer);
filemod then works with ctx. It can, either act on the
model itself (for instance on its header), or iterate
on selected entities (Start/Next/More/Value)
it can call AddFail or AddWarning, as necessary
}
.

virtual Standard_EXPORT 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
.

virtual Standard_EXPORT 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 =0
| Gives the way of dumping an entity under a form comprehensive for each norm. <model> helps to identify, number ... entities. <level> is to be interpreted for each norm (because of the formats which can be very different) .
Standard_EXPORT 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 .
Standard_EXPORT 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> .
Standard_EXPORT 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 .
Standard_EXPORT void | SetDumpHelp (const Standard_Integer level, const Standard_CString help)
| Records a short line of help for a level (0 - max) .
Standard_EXPORT Standard_CString | DumpHelp (const Standard_Integer level) const
| Returns the help line recorded for <level>, or an empty string .
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Protected Member Functions

Standard_EXPORT | IFSelect_WorkLibrary ()
| Required to initialise fields .

## Private Attributes

Standard_Integer | thelevdef
Handle_Interface_HArray1OfHAsciiString | thelevhlp

## Constructor & Destructor Documentation

Standard_EXPORT IFSelect_WorkLibrary::IFSelect_WorkLibrary | ( |  | ) | `[protected]`

## Member Function Documentation

virtual Standard_EXPORT Standard_Boolean IFSelect_WorkLibrary::CopyModel | ( | const Handle(Interface_InterfaceModel)& | original,
|  | const Handle(Interface_InterfaceModel)& | newmodel,
|  | const Interface_EntityIterator & | list,
|  | Interface_CopyTool & | TC
| ) | const`[virtual]`

| Reimplemented in StepSelect_WorkLibrary.

Standard_EXPORT void IFSelect_WorkLibrary::DumpEntity | ( | const Handle(Interface_InterfaceModel)& | model,
|  | const Handle(Interface_Protocol)& | protocol,
|  | const Handle(Standard_Transient)& | entity,
|  | const Handle(Message_Messenger)& | S
| ) | const

virtual Standard_EXPORT void IFSelect_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`[pure virtual]`

| Implemented in IGESSelect_WorkLibrary, and StepSelect_WorkLibrary.

Standard_EXPORT Standard_CString IFSelect_WorkLibrary::DumpHelp | ( | const Standard_Integer | level | ) | const

Standard_EXPORT void IFSelect_WorkLibrary::DumpLevels | ( | Standard_Integer & | def,
|  | Standard_Integer & | max
| ) | const

Standard_EXPORT const IFSelect_WorkLibrary::Handle | ( | Standard_Type |  | ) | const

| Reimplemented in IGESSelect_WorkLibrary, and StepSelect_WorkLibrary.

virtual Standard_EXPORT Standard_Integer IFSelect_WorkLibrary::ReadFile | ( | const Standard_CString | name,
|  | Handle(Interface_InterfaceModel)& | model,
|  | const Handle(Interface_Protocol)& | protocol
| ) | const`[pure virtual]`

| Implemented in IGESSelect_WorkLibrary, and StepSelect_WorkLibrary.

Standard_EXPORT void IFSelect_WorkLibrary::SetDumpHelp | ( | const Standard_Integer | level,
|  | const Standard_CString | help
| ) |

Standard_EXPORT void IFSelect_WorkLibrary::SetDumpLevels | ( | const Standard_Integer | def,
|  | const Standard_Integer | max
| ) |

virtual Standard_EXPORT Standard_Boolean IFSelect_WorkLibrary::WriteFile | ( | IFSelect_ContextWrite & | ctx | ) | const`[pure virtual]`

| Implemented in IGESSelect_WorkLibrary, and StepSelect_WorkLibrary.

## Field Documentation

Standard_Integer IFSelect_WorkLibrary::thelevdef`[private]`

Handle_Interface_HArray1OfHAsciiString IFSelect_WorkLibrary::thelevhlp`[private]`

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

- IFSelect_WorkLibrary.hxx