|
Open CASCADE Technology
6.7.1
|
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
|
Open CASCADE Technology
6.7.1
|
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.
More...
#include <IFSelect_ContextWrite.hxx>
Public Member Functions | |
| 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 : More... | |
| 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 More... | |
| Handle_Interface_InterfaceModel | Model () const |
| Returns the Model More... | |
| Handle_Interface_Protocol | Protocol () const |
| Returns the Protocol; More... | |
| Standard_CString | FileName () const |
| Returns the File Name More... | |
| Handle_IFSelect_AppliedModifiers | AppliedModifiers () const |
| Returns the object AppliedModifiers More... | |
| const Interface_Graph & | Graph () |
| Returns the Graph, either given when created, else created the first time it is queried More... | |
| Standard_Integer | NbModifiers () const |
| Returns the count of recorded File Modifiers More... | |
| 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 More... | |
| 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 More... | |
| Standard_Boolean | IsForNone () const |
| Returns True if no modifier is currently set More... | |
| 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 More... | |
| Standard_Integer | NbEntities () const |
| Returns the total count of selected entities More... | |
| void | Start () |
| Starts an iteration on selected items. It takes into account IsForAll/IsForNone, by really iterating on all selected items. More... | |
| Standard_Boolean | More () const |
| Returns True until the iteration has finished More... | |
| void | Next () |
| Advances the iteration More... | |
| Handle_Standard_Transient | Value () const |
| Returns the current selected entity in the model More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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 = ...") More... | |
| 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 = ...") More... | |
| Interface_CheckIterator | CheckList () const |
| Returns the complete CheckList More... | |
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.
| IFSelect_ContextWrite::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::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
| void IFSelect_ContextWrite::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 IFSelect_ContextWrite::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.
| void IFSelect_ContextWrite::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.
| Handle_IFSelect_AppliedModifiers IFSelect_ContextWrite::AppliedModifiers | ( | ) | const |
Returns the object AppliedModifiers
| Handle_Interface_Check IFSelect_ContextWrite::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 IFSelect_ContextWrite::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 IFSelect_ContextWrite::CheckList | ( | ) | const |
Returns the complete CheckList
| Handle_IFSelect_GeneralModifier IFSelect_ContextWrite::FileModifier | ( | ) | const |
Returns the currently active File Modifier. Cast to be done
Null if not properly set : must be test IsNull after casting
| Standard_CString IFSelect_ContextWrite::FileName | ( | ) | const |
Returns the File Name
| const Interface_Graph& IFSelect_ContextWrite::Graph | ( | ) |
Returns the Graph, either given when created, else created
the first time it is queried
| Standard_Boolean IFSelect_ContextWrite::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_Boolean IFSelect_ContextWrite::IsForNone | ( | ) | const |
Returns True if no modifier is currently set
| Handle_Interface_InterfaceModel IFSelect_ContextWrite::Model | ( | ) | const |
Returns the Model
| Standard_Boolean IFSelect_ContextWrite::More | ( | ) | const |
Returns True until the iteration has finished
| Standard_Integer IFSelect_ContextWrite::NbEntities | ( | ) | const |
Returns the total count of selected entities
| Standard_Integer IFSelect_ContextWrite::NbModifiers | ( | ) | const |
Returns the count of recorded File Modifiers
| void IFSelect_ContextWrite::Next | ( | ) |
Advances the iteration
| Handle_Interface_Protocol IFSelect_ContextWrite::Protocol | ( | ) | const |
Returns the Protocol;
| Standard_Boolean IFSelect_ContextWrite::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
| void IFSelect_ContextWrite::Start | ( | ) |
Starts an iteration on selected items. It takes into account
IsForAll/IsForNone, by really iterating on all selected items.
| Handle_Standard_Transient IFSelect_ContextWrite::Value | ( | ) | const |
Returns the current selected entity in the model
1.8.5