|
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
|
Reads STEP files, checks them and translates their contents
into Open CASCADE models. The STEP data can be that of
a whole model or that of a specific list of entities in the model.
As in XSControl_Reader, you specify the list using a selection.
For the translation of iges files it is possible to use next sequence:
To change translation parameters
class Interface_Static should be used before beginning of
translation (see STEP Parameters and General Parameters)
Creation of reader - STEPControl_Reader reader;
To load s file in a model use method reader.ReadFile("filename.stp")
To print load results reader.PrintCheckLoad(failsonly,mode)
where mode is equal to the value of enumeration IFSelect_PrintCount
For definition number of candidates :
Standard_Integer nbroots = reader. NbRootsForTransfer();
To transfer entities from a model the following methods can be used:
for the whole model - reader.TransferRoots();
to transfer a list of entities: reader.TransferList(list);
to transfer one entity Handle(Standard_Transient)
ent = reader.RootForTransfer(num);
reader.TransferEntity(ent), or
reader.TransferOneRoot(num), or
reader.TransferOne(num), or
reader.TransferRoot(num)
To obtain the result the following method can be used:
reader.NbShapes() and reader.Shape(num); or reader.OneShape();
To print the results of transfer use method:
reader.PrintCheckTransfer(failwarn,mode);
where printfail is equal to the value of enumeration
IFSelect_PrintFail, mode see above; or reader.PrintStatsTransfer();
Gets correspondence between a STEP entity and a result
shape obtained from it.
Handle(XSControl_WorkSession)
WS = reader.WS();
if ( WS->TransferReader()->HasResult(ent) )
TopoDS_Shape shape = WS->TransferReader()->ShapeResult(ent);
More...
#include <STEPControl_Reader.hxx>
Public Member Functions | |
| STEPControl_Reader () | |
| Creates a reader object with an empty STEP model. More... | |
| STEPControl_Reader (const Handle< XSControl_WorkSession > &WS, const Standard_Boolean scratch=Standard_True) | |
| Creates a Reader for STEP from an already existing Session Clears the session if it was not yet set for STEP More... | |
| Handle_StepData_StepModel | StepModel () const |
| Returns the model as a StepModel. It can then be consulted (header, product) More... | |
| Standard_Boolean | TransferRoot (const Standard_Integer num=1) |
| Transfers a root given its rank in the list of candidate roots Default is the first one Returns True if a shape has resulted, false else Same as inherited TransferOneRoot, kept for compatibility More... | |
| virtual Standard_Integer | NbRootsForTransfer () |
| Determines the list of root entities from Model which are candidate for a transfer to a Shape (type of entities is PRODUCT) More... | |
| void | FileUnits (TColStd_SequenceOfAsciiString &theUnitLengthNames, TColStd_SequenceOfAsciiString &theUnitAngleNames, TColStd_SequenceOfAsciiString &theUnitSolidAngleNames) |
| Returns sequence of all unit names for shape representations found in file More... | |
 Public Member Functions inherited from XSControl_Reader | |
| XSControl_Reader () | |
| Creates a Reader from scratch (creates an empty WorkSession) A WorkSession or a Controller must be provided before running More... | |
| XSControl_Reader (const Standard_CString norm) | |
| Creates a Reader from scratch, with a norm name which identifies a Controller More... | |
| XSControl_Reader (const Handle< XSControl_WorkSession > &WS, const Standard_Boolean scratch=Standard_True) | |
| Creates a Reader from an already existing Session, with a Controller already set //! Virtual destructor More... | |
| virtual | ~XSControl_Reader () |
| Standard_Boolean | SetNorm (const Standard_CString norm) |
| Sets a specific norm to <me> Returns True if done, False if <norm> is not available More... | |
| void | SetWS (const Handle< XSControl_WorkSession > &WS, const Standard_Boolean scratch=Standard_True) |
| Sets a specific session to <me> More... | |
| Handle_XSControl_WorkSession | WS () const |
| Returns the session used in <me> More... | |
| IFSelect_ReturnStatus | ReadFile (const Standard_CString filename) |
| Loads a file and returns the read status Zero for a Model which compies with the Controller More... | |
| Handle_Interface_InterfaceModel | Model () const |
| Returns the model. It can then be consulted (header, product) More... | |
| Handle_TColStd_HSequenceOfTransient | GiveList (const Standard_CString first="", const Standard_CString second="") |
Returns a list of entities from the IGES or STEP file <br> according to the following rules: | |
| Handle_TColStd_HSequenceOfTransient | GiveList (const Standard_CString first, const Handle< Standard_Transient > &ent) |
| Computes a List of entities from the model as follows <first> beeing a Selection, <ent> beeing an entity or a list of entities (as a HSequenceOfTransient) : the standard result of this selection applied to this list if <first> is erroneous, a null handle is returned More... | |
| Handle_Standard_Transient | RootForTransfer (const Standard_Integer num=1) |
| Returns an IGES or STEP root entity for translation. The entity is identified by its rank in a list. More... | |
| Standard_Boolean | TransferOneRoot (const Standard_Integer num=1) |
| Translates a root identified by the rank num in the model. false is returned if no shape is produced. More... | |
| Standard_Boolean | TransferOne (const Standard_Integer num) |
| Translates an IGES or STEP entity identified by the rank num in the model. false is returned if no shape is produced. More... | |
| Standard_Boolean | TransferEntity (const Handle< Standard_Transient > &start) |
| Translates an IGES or STEP entity in the model. true is returned if a shape is produced; otherwise, false is returned. More... | |
| Standard_Integer | TransferList (const Handle< TColStd_HSequenceOfTransient > &list) |
| Translates a list of entities. Returns the number of IGES or STEP entities that were successfully translated. The list can be produced with GiveList. Warning - This function does not clear the existing output shapes. More... | |
| Standard_Integer | TransferRoots () |
| Translates all translatable roots and returns the number of successful translations. Warning - This function clears existing output shapes first. More... | |
| void | ClearShapes () |
| Clears the list of shapes that may have accumulated in calls to TransferOne or TransferRoot.C More... | |
| Standard_Integer | NbShapes () const |
| Returns the number of shapes produced by translation. More... | |
| TopoDS_Shape | Shape (const Standard_Integer num=1) const |
Returns the shape resulting <br> from a translation and identified by the rank num. | |
| TopoDS_Shape | OneShape () const |
Returns all of the results in <br> a single shape which is: | |
| void | PrintCheckLoad (const Standard_Boolean failsonly, const IFSelect_PrintCount mode) const |
| Prints the check list attached to loaded data, on the Standard Trace File (starts at cout) All messages or fails only, according to <failsonly> mode = 0 : per entity, prints messages mode = 1 : per message, just gives count of entities per check mode = 2 : also gives entity numbers More... | |
| void | PrintCheckTransfer (const Standard_Boolean failsonly, const IFSelect_PrintCount mode) const |
Displays check results for the <br> last translation of IGES or STEP entities to Open CASCADE | |
| void | PrintStatsTransfer (const Standard_Integer what, const Standard_Integer mode=0) const |
Displays the statistics for <br> the last translation. what defines the kind of | |
| void | GetStatsTransfer (const Handle< TColStd_HSequenceOfTransient > &list, Standard_Integer &nbMapped, Standard_Integer &nbWithResult, Standard_Integer &nbWithFail) const |
| Gives statistics about Transfer More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from XSControl_Reader | |
| TopTools_SequenceOfShape & | Shapes () |
| Returns a sequence of produced shapes More... | |
| Protected Attributes inherited from XSControl_Reader | |
| Standard_Boolean | therootsta |
| TColStd_SequenceOfTransient | theroots |
Reads STEP files, checks them and translates their contents
into Open CASCADE models. The STEP data can be that of
a whole model or that of a specific list of entities in the model.
As in XSControl_Reader, you specify the list using a selection.
For the translation of iges files it is possible to use next sequence:
To change translation parameters
class Interface_Static should be used before beginning of
translation (see STEP Parameters and General Parameters)
Creation of reader - STEPControl_Reader reader;
To load s file in a model use method reader.ReadFile("filename.stp")
To print load results reader.PrintCheckLoad(failsonly,mode)
where mode is equal to the value of enumeration IFSelect_PrintCount
For definition number of candidates :
Standard_Integer nbroots = reader. NbRootsForTransfer();
To transfer entities from a model the following methods can be used:
for the whole model - reader.TransferRoots();
to transfer a list of entities: reader.TransferList(list);
to transfer one entity Handle(Standard_Transient)
ent = reader.RootForTransfer(num);
reader.TransferEntity(ent), or
reader.TransferOneRoot(num), or
reader.TransferOne(num), or
reader.TransferRoot(num)
To obtain the result the following method can be used:
reader.NbShapes() and reader.Shape(num); or reader.OneShape();
To print the results of transfer use method:
reader.PrintCheckTransfer(failwarn,mode);
where printfail is equal to the value of enumeration
IFSelect_PrintFail, mode see above; or reader.PrintStatsTransfer();
Gets correspondence between a STEP entity and a result
shape obtained from it.
Handle(XSControl_WorkSession)
WS = reader.WS();
if ( WS->TransferReader()->HasResult(ent) )
TopoDS_Shape shape = WS->TransferReader()->ShapeResult(ent);
| STEPControl_Reader::STEPControl_Reader | ( | ) |
Creates a reader object with an empty STEP model.
| STEPControl_Reader::STEPControl_Reader | ( | const Handle< XSControl_WorkSession > & | WS, |
| const Standard_Boolean | scratch = Standard_True |
||
| ) |
Creates a Reader for STEP from an already existing Session
Clears the session if it was not yet set for STEP
| void STEPControl_Reader::FileUnits | ( | TColStd_SequenceOfAsciiString & | theUnitLengthNames, |
| TColStd_SequenceOfAsciiString & | theUnitAngleNames, | ||
| TColStd_SequenceOfAsciiString & | theUnitSolidAngleNames | ||
| ) |
Returns sequence of all unit names for shape representations
found in file
|
virtual |
Determines the list of root entities from Model which are candidate for
a transfer to a Shape (type of entities is PRODUCT)
Reimplemented from XSControl_Reader.
| Handle_StepData_StepModel STEPControl_Reader::StepModel | ( | ) | const |
Returns the model as a StepModel.
It can then be consulted (header, product)
| Standard_Boolean STEPControl_Reader::TransferRoot | ( | const Standard_Integer | num = 1 | ) |
Transfers a root given its rank in the list of candidate roots
Default is the first one
Returns True if a shape has resulted, false else
Same as inherited TransferOneRoot, kept for compatibility
1.8.5