OCC Main Page | DataExchange | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

# DataExchange
TKXSBase
IFSelect

# 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
void * | operator new (size_t, void *anAddress)
void * | operator new (size_t size)
void | operator delete (void *anAddress)
Standard_EXPORT | 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 : - 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 .
Standard_EXPORT | 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 .
Standard_EXPORT Handle_Interface_InterfaceModel | Model () const
| Returns the Model .
Standard_EXPORT Handle_Interface_Protocol | Protocol () const
| Returns the Protocol; .
Standard_EXPORT Standard_CString | FileName () const
| Returns the File Name .
Standard_EXPORT Handle_IFSelect_AppliedModifiers | AppliedModifiers () const
| Returns the object AppliedModifiers .
Standard_EXPORT const Interface_Graph & | Graph ()
| Returns the Graph, either given when created, else created the first time it is queried .
Standard_EXPORT Standard_Integer | NbModifiers () const
| Returns the count of recorded File Modifiers .
Standard_EXPORT 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 .
Standard_EXPORT 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_EXPORT Standard_Boolean | IsForNone () const
| Returns True if no modifier is currently set .
Standard_EXPORT 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_EXPORT Standard_Integer | NbEntities () const
| Returns the total count of selected entities .
Standard_EXPORT void | Start ()
| Starts an iteration on selected items. It takes into account IsForAll/IsForNone, by really iterating on all selected items. .
Standard_EXPORT Standard_Boolean | More () const
| Returns True until the iteration has finished .
Standard_EXPORT void | Next ()
| Advances the iteration .
Standard_EXPORT Handle_Standard_Transient | Value () const
| Returns the current selected entity in the model .
Standard_EXPORT 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. .
Standard_EXPORT 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. .
Standard_EXPORT 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. .
Standard_EXPORT 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 = ...") .
Standard_EXPORT 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 = ...") .
Standard_EXPORT Interface_CheckIterator | CheckList () const
| Returns the complete CheckList .
## Private Attributes
Handle_Interface_InterfaceModel | themodel
Handle_Interface_Protocol | theproto
TCollection_AsciiString | thefile
Handle_IFSelect_AppliedModifiers | theapply
Handle_Interface_HGraph | thehgraf
Interface_CheckIterator | thecheck
Standard_Integer | thenumod
Standard_Integer | thenbent
Standard_Integer | thecurr
Handle_IFSelect_GeneralModifier | themodif

## Constructor & Destructor Documentation

Standard_EXPORT IFSelect_ContextWrite::IFSelect_ContextWrite | ( | const Handle(Interface_InterfaceModel)& | model,
|  | const Handle(Interface_Protocol)& | proto,
|  | const Handle(IFSelect_AppliedModifiers)& | applieds,
|  | const Standard_CString | filename
| ) |

Standard_EXPORT IFSelect_ContextWrite::IFSelect_ContextWrite | ( | const Handle(Interface_HGraph)& | hgraph,
|  | const Handle(Interface_Protocol)& | proto,
|  | const Handle(IFSelect_AppliedModifiers)& | applieds,
|  | const Standard_CString | filename
| ) |

## Member Function Documentation

Standard_EXPORT void IFSelect_ContextWrite::AddCheck | ( | const Handle(Interface_Check)& | check | ) |

Standard_EXPORT void IFSelect_ContextWrite::AddFail | ( | const Handle(Standard_Transient)& | start,
|  | const Standard_CString | mess,
|  | const Standard_CString | orig = `""`
| ) |

Standard_EXPORT void IFSelect_ContextWrite::AddWarning | ( | const Handle(Standard_Transient)& | start,
|  | const Standard_CString | mess,
|  | const Standard_CString | orig = `""`
| ) |

Standard_EXPORT Handle_IFSelect_AppliedModifiers IFSelect_ContextWrite::AppliedModifiers | ( |  | ) | const

Standard_EXPORT Handle_Interface_Check IFSelect_ContextWrite::CCheck | ( | const Handle(Standard_Transient)& | start | ) |

Standard_EXPORT Handle_Interface_Check IFSelect_ContextWrite::CCheck | ( | const Standard_Integer | num = `0` | ) |

Standard_EXPORT Interface_CheckIterator IFSelect_ContextWrite::CheckList | ( |  | ) | const

Standard_EXPORT Handle_IFSelect_GeneralModifier IFSelect_ContextWrite::FileModifier | ( |  | ) | const

Standard_EXPORT Standard_CString IFSelect_ContextWrite::FileName | ( |  | ) | const

Standard_EXPORT const Interface_Graph& IFSelect_ContextWrite::Graph | ( |  | ) |

Standard_EXPORT Standard_Boolean IFSelect_ContextWrite::IsForAll | ( |  | ) | const

Standard_EXPORT Standard_Boolean IFSelect_ContextWrite::IsForNone | ( |  | ) | const

Standard_EXPORT Handle_Interface_InterfaceModel IFSelect_ContextWrite::Model | ( |  | ) | const

Standard_EXPORT Standard_Boolean IFSelect_ContextWrite::More | ( |  | ) | const

Standard_EXPORT Standard_Integer IFSelect_ContextWrite::NbEntities | ( |  | ) | const

Standard_EXPORT Standard_Integer IFSelect_ContextWrite::NbModifiers | ( |  | ) | const

Standard_EXPORT void IFSelect_ContextWrite::Next | ( |  | ) |

void IFSelect_ContextWrite::operator delete | ( | void * | anAddress | ) | `[inline]`

void* IFSelect_ContextWrite::operator new | ( | size_t | size | ) | `[inline]`

void* IFSelect_ContextWrite::operator new | ( | size_t | ,
|  | void * | anAddress
| ) | `[inline]`

Standard_EXPORT Handle_Interface_Protocol IFSelect_ContextWrite::Protocol | ( |  | ) | const

Standard_EXPORT Standard_Boolean IFSelect_ContextWrite::SetModifier | ( | const Standard_Integer | numod | ) |

Standard_EXPORT void IFSelect_ContextWrite::Start | ( |  | ) |

Standard_EXPORT Handle_Standard_Transient IFSelect_ContextWrite::Value | ( |  | ) | const

## Field Documentation

Handle_IFSelect_AppliedModifiers IFSelect_ContextWrite::theapply`[private]`

Interface_CheckIterator IFSelect_ContextWrite::thecheck`[private]`

Standard_Integer IFSelect_ContextWrite::thecurr`[private]`

TCollection_AsciiString IFSelect_ContextWrite::thefile`[private]`

Handle_Interface_HGraph IFSelect_ContextWrite::thehgraf`[private]`

Handle_Interface_InterfaceModel IFSelect_ContextWrite::themodel`[private]`

Handle_IFSelect_GeneralModifier IFSelect_ContextWrite::themodif`[private]`

Standard_Integer IFSelect_ContextWrite::thenbent`[private]`

Standard_Integer IFSelect_ContextWrite::thenumod`[private]`

Handle_Interface_Protocol IFSelect_ContextWrite::theproto`[private]`

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

- IFSelect_ContextWrite.hxx