Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
IFSelect_ContextWrite Class Reference

This class gathers various informations used by File Modifiers
apart from the writer object, which is specific of the norm
and of the physical format

These informations are controlled by an object AppliedModifiers
(if it is not defined, no modification is allowed on writing)

Furthermore, in return, ContextModif can record Checks, either
one for all, or one for each Entity. It supports trace too.

#include <IFSelect_ContextWrite.hxx>

Public Member Functions

DEFINE_STANDARD_ALLOC IFSelect_ContextWrite (const Handle< Interface_InterfaceModel > &model, const Handle< Interface_Protocol > &proto, const Handle< IFSelect_AppliedModifiers > &applieds, const Standard_CString filename)
 Prepares a ContextWrite with these informations :

 IFSelect_ContextWrite (const Handle< Interface_HGraph > &hgraph, const Handle< Interface_Protocol > &proto, const Handle< IFSelect_AppliedModifiers > &applieds, const Standard_CString filename)
 Same as above but with an already computed Graph

Handle_Interface_InterfaceModel Model () const
 Returns the Model

Handle_Interface_Protocol Protocol () const
 Returns the Protocol;

Standard_CString FileName () const
 Returns the File Name

Handle_IFSelect_AppliedModifiers AppliedModifiers () const
 Returns the object AppliedModifiers

const Interface_GraphGraph ()
 Returns the Graph, either given when created, else created
the first time it is queried

Standard_Integer NbModifiers () const
 Returns the count of recorded File Modifiers

Standard_Boolean SetModifier (const Standard_Integer numod)
 Sets active the File Modifier n0 <numod>
Then, it prepares the list of entities to consider, if any
Returns False if <numod> out of range

Handle_IFSelect_GeneralModifier FileModifier () const
 Returns the currently active File Modifier. Cast to be done
Null if not properly set : must be test IsNull after casting

Standard_Boolean IsForNone () const
 Returns True if no modifier is currently set

Standard_Boolean IsForAll () const
 Returns True if the current modifier is to be applied to
the whole model. Else, a restricted list of selected entities
is defined, it can be exploited by the File Modifier

Standard_Integer NbEntities () const
 Returns the total count of selected entities

void Start ()
 Starts an iteration on selected items. It takes into account
IsForAll/IsForNone, by really iterating on all selected items.

Standard_Boolean More () const
 Returns True until the iteration has finished

void Next ()
 Advances the iteration

Handle_Standard_Transient Value () const
 Returns the current selected entity in the model

void AddCheck (const Handle< Interface_Check > &check)
 Adds a Check to the CheckList. If it is empty, nothing is done
If it concerns an Entity from the Model (by SetEntity)
to which another Check is attached, it is merged to it.
Else, it is added or merged as to GlobalCheck.

void AddWarning (const Handle< Standard_Transient > &start, const Standard_CString mess, const Standard_CString orig="")
 Adds a Warning Message for an Entity from the Model
If <start> is not an Entity from the model (e.g. the
model itself) this message is added to Global Check.

void AddFail (const Handle< Standard_Transient > &start, const Standard_CString mess, const Standard_CString orig="")
 Adds a Fail Message for an Entity from the Model
If <start> is not an Entity from the model (e.g. the
model itself) this message is added to Global Check.

Handle_Interface_Check CCheck (const Standard_Integer num=0)
 Returns a Check given an Entity number (in the Model)
by default a Global Check. Creates it the first time.
It can then be acknowledged on the spot, in condition that the
caller works by reference ("Interface_Check& check = ...")

Handle_Interface_Check CCheck (const Handle< Standard_Transient > &start)
 Returns a Check attached to an Entity from the Model
It can then be acknowledged on the spot, in condition that the
caller works by reference ("Interface_Check& check = ...")

Interface_CheckIterator CheckList () const
 Returns the complete CheckList


Constructor & Destructor Documentation

  • the model which is to be written
  • the protocol to be used
  • the filename
  • an object AppliedModifiers to work. It gives a list of
    FileModifiers to be ran, and for each one it can give
    a restricted list of entities (in the model), else all
    the model is considered

Member Function Documentation

Handle_IFSelect_AppliedModifiers IFSelect_ContextWrite::AppliedModifiers ( ) const
Handle_Interface_Check IFSelect_ContextWrite::CCheck ( const Standard_Integer  num = 0)
Handle_Interface_Check IFSelect_ContextWrite::CCheck ( const Handle< Standard_Transient > &  start)
Handle_IFSelect_GeneralModifier IFSelect_ContextWrite::FileModifier ( ) const
Handle_Interface_InterfaceModel IFSelect_ContextWrite::Model ( ) const
Handle_Interface_Protocol IFSelect_ContextWrite::Protocol ( ) const

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