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

DataExchange
TKXDESTEP
STEPCAFControl


STEPCAFControl_Reader Class Reference

Provides a tool to read STEP file and put it into
DECAF document. Besides transfer of shapes (including
assemblies) provided by STEPControl, supports also
colors and part names
.

#include <STEPCAFControl_Reader.hxx>


Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT STEPCAFControl_Reader ()
 Creates a reader with an empty
STEP model and sets ColorMode, LayerMode, NameMode and
PropsMode to Standard_True.
.
Standard_EXPORT STEPCAFControl_Reader (const Handle(XSControl_WorkSession)&WS, const Standard_Boolean scratch=Standard_True)
 Creates a reader tool and attaches it to an already existing Session
Clears the session if it was not yet set for STEP
.
Standard_EXPORT void Init (const Handle(XSControl_WorkSession)&WS, const Standard_Boolean scratch=Standard_True)
 Clears the internal data structures and attaches to a new session
Clears the session if it was not yet set for STEP
.
Standard_EXPORT IFSelect_ReturnStatus ReadFile (const Standard_CString filename)
 Loads a file and returns the read status
Provided for use like single-file reader
.
Standard_EXPORT Standard_Integer NbRootsForTransfer ()
 Returns number of roots recognized for transfer
Shortcut for Reader().NbRootsForTransfer()
.
Standard_EXPORT Standard_Boolean TransferOneRoot (const Standard_Integer num, Handle(TDocStd_Document)&doc)
 Translates currently loaded STEP file into the document
Returns True if succeeded, and False in case of fail
Provided for use like single-file reader
.
Standard_EXPORT Standard_Boolean Transfer (Handle(TDocStd_Document)&doc)
 Translates currently loaded STEP file into the document
Returns True if succeeded, and False in case of fail
Provided for use like single-file reader
.
Standard_EXPORT Standard_Boolean Perform (const TCollection_AsciiString &filename, Handle(TDocStd_Document)&doc)
Standard_EXPORT Standard_Boolean Perform (const Standard_CString filename, Handle(TDocStd_Document)&doc)
 Translate STEP file given by filename into the document
Return True if succeeded, and False in case of fail
.
Standard_EXPORT const Handle_STEPCAFControl_DictionaryOfExternFile & ExternFiles () const
 Returns data on external files
Returns Null handle if no external files are read
.
Standard_EXPORT Standard_Boolean ExternFile (const Standard_CString name, Handle(STEPCAFControl_ExternFile)&ef) const
 Returns data on external file by its name
Returns False if no external file with given name is read
.
Standard_EXPORT STEPControl_ReaderReader ()
 Returns basic reader
.
Standard_EXPORT const STEPControl_ReaderReader () const
 Returns basic reader as const
.
Standard_EXPORT void SetColorMode (const Standard_Boolean colormode)
 Set ColorMode for indicate read Colors or not.
.
Standard_EXPORT Standard_Boolean GetColorMode () const
Standard_EXPORT void SetNameMode (const Standard_Boolean namemode)
 Set NameMode for indicate read Name or not.
.
Standard_EXPORT Standard_Boolean GetNameMode () const
Standard_EXPORT void SetLayerMode (const Standard_Boolean layermode)
 Set LayerMode for indicate read Layers or not.
.
Standard_EXPORT Standard_Boolean GetLayerMode () const
Standard_EXPORT void SetPropsMode (const Standard_Boolean propsmode)
 PropsMode for indicate read Validation properties or not.
.
Standard_EXPORT Standard_Boolean GetPropsMode () const
Standard_EXPORT void SetSHUOMode (const Standard_Boolean shuomode)
 Set SHUO mode for indicate write SHUO or not.
.
Standard_EXPORT Standard_Boolean GetSHUOMode () const
Standard_EXPORT void SetGDTMode (const Standard_Boolean gdtmode)
 Set GDT mode for indicate write GDT or not.
.
Standard_EXPORT Standard_Boolean GetGDTMode () const
Standard_EXPORT void SetMatMode (const Standard_Boolean matmode)
 Set Material mode
.
Standard_EXPORT Standard_Boolean GetMatMode () const

Static Public Member Functions

static Standard_EXPORT TDF_Label FindInstance (const Handle(StepRepr_NextAssemblyUsageOccurrence)&NAUO, const Handle(XCAFDoc_ShapeTool)&STool, const STEPConstruct_Tool &Tool, const STEPCAFControl_DataMapOfPDExternFile &PDRFileMap, const STEPCAFControl_DataMapOfShapeLabel &ShapeLabelMap)
 Returns label of instance of an assembly component
corresponding to a given NAUO
.

Protected Member Functions

Standard_EXPORT Standard_Boolean Transfer (STEPControl_Reader &rd, const Standard_Integer num, Handle(TDocStd_Document)&doc, TDF_LabelSequence &Lseq, const Standard_Boolean asOne=Standard_False)
 Translates STEP file already loaded into the reader
into the document
If num==0, translates all roots, else only root number num
Returns True if succeeded, and False in case of fail
If asOne is True, in case of multiple results composes
them into assembly. Fills sequence of produced labels
.
Standard_EXPORT TDF_Label AddShape (const TopoDS_Shape &S, const Handle(XCAFDoc_ShapeTool)&STool, const TopTools_MapOfShape &NewShapesMap, const STEPCAFControl_DataMapOfShapePD &ShapePDMap, const STEPCAFControl_DataMapOfPDExternFile &PDFileMap, STEPCAFControl_DataMapOfShapeLabel &ShapeLabelMap) const
 Add a shape to a document
Depending on a case, this shape can be added as one, or
as assembly, or (in case if it is associated with external
reference) taken as that referred shape
.
Standard_EXPORT Handle_STEPCAFControl_ExternFile ReadExternFile (const Standard_CString file, const Standard_CString fullpath, Handle(TDocStd_Document)&doc)
 Reads (or if returns already read) extern file with
given name
.
Standard_EXPORT Standard_Boolean ReadColors (const Handle(XSControl_WorkSession)&WS, Handle(TDocStd_Document)&doc, const STEPCAFControl_DataMapOfPDExternFile &PDFileMap, const STEPCAFControl_DataMapOfShapeLabel &ShapeLabelMap) const
 Reads style assignments from STEP model and sets
corresponding color assignments in the DECAF document
.
Standard_EXPORT Standard_Boolean ReadNames (const Handle(XSControl_WorkSession)&WS, Handle(TDocStd_Document)&doc, const STEPCAFControl_DataMapOfPDExternFile &PDFileMap, const STEPCAFControl_DataMapOfShapeLabel &ShapeLabelMap) const
 Reads names of parts defined in the STEP model and
assigns them to corresponding labels in the DECAF document
.
Standard_EXPORT Standard_Boolean ReadValProps (const Handle(XSControl_WorkSession)&WS, Handle(TDocStd_Document)&doc, const STEPCAFControl_DataMapOfPDExternFile &PDFileMap, const STEPCAFControl_DataMapOfShapeLabel &ShapeLabelMap) const
 Reads validation properties assigned to shapes in the STEP
model and assigns them to corresponding labels in the DECAF
document
.
Standard_EXPORT Standard_Boolean ReadLayers (const Handle(XSControl_WorkSession)&WS, Handle(TDocStd_Document)&doc) const
 Reads layers of parts defined in the STEP model and
set reference between shape and layers in the DECAF document
.
Standard_EXPORT Standard_Boolean ReadSHUOs (const Handle(XSControl_WorkSession)&WS, Handle(TDocStd_Document)&doc, const STEPCAFControl_DataMapOfPDExternFile &PDFileMap, const STEPCAFControl_DataMapOfShapeLabel &ShapeLabelMap) const
 Reads SHUO for instances defined in the STEP model and
set reference between shape instances from different assemblyes
.
Standard_EXPORT Standard_Boolean ReadGDTs (const Handle(XSControl_WorkSession)&WS, Handle(TDocStd_Document)&doc) const
 Reads D&GT for instances defined in the STEP model and
set reference between shape instances from different assemblyes
.
Standard_EXPORT Standard_Boolean ReadMaterials (const Handle(XSControl_WorkSession)&WS, Handle(TDocStd_Document)&doc, const Handle(TColStd_HSequenceOfTransient)&SeqPDS) const
 Reads materials for instances defined in the STEP model and
set reference between shape instances from different assemblyes
.

Private Attributes

STEPControl_Reader myReader
Handle_STEPCAFControl_DictionaryOfExternFile myFiles
Standard_Boolean myColorMode
Standard_Boolean myNameMode
Standard_Boolean myLayerMode
Standard_Boolean myPropsMode
Standard_Boolean mySHUOMode
Standard_Boolean myGDTMode
Standard_Boolean myMatMode


Constructor & Destructor Documentation

Standard_EXPORT STEPCAFControl_Reader::STEPCAFControl_Reader  ) 
 

Standard_EXPORT STEPCAFControl_Reader::STEPCAFControl_Reader const Handle(XSControl_WorkSession)&  WS,
const Standard_Boolean  scratch = Standard_True
 


Member Function Documentation

Standard_EXPORT TDF_Label STEPCAFControl_Reader::AddShape const TopoDS_Shape &  S,
const Handle(XCAFDoc_ShapeTool)&  STool,
const TopTools_MapOfShape &  NewShapesMap,
const STEPCAFControl_DataMapOfShapePD ShapePDMap,
const STEPCAFControl_DataMapOfPDExternFile PDFileMap,
STEPCAFControl_DataMapOfShapeLabel ShapeLabelMap
const [protected]
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::ExternFile const Standard_CString  name,
Handle(STEPCAFControl_ExternFile)&  ef
const
 

Standard_EXPORT const Handle_STEPCAFControl_DictionaryOfExternFile& STEPCAFControl_Reader::ExternFiles  )  const
 

static Standard_EXPORT TDF_Label STEPCAFControl_Reader::FindInstance const Handle(StepRepr_NextAssemblyUsageOccurrence)&  NAUO,
const Handle(XCAFDoc_ShapeTool)&  STool,
const STEPConstruct_Tool Tool,
const STEPCAFControl_DataMapOfPDExternFile PDRFileMap,
const STEPCAFControl_DataMapOfShapeLabel ShapeLabelMap
[static]
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::GetColorMode  )  const
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::GetGDTMode  )  const
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::GetLayerMode  )  const
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::GetMatMode  )  const
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::GetNameMode  )  const
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::GetPropsMode  )  const
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::GetSHUOMode  )  const
 

Standard_EXPORT void STEPCAFControl_Reader::Init const Handle(XSControl_WorkSession)&  WS,
const Standard_Boolean  scratch = Standard_True
 

Standard_EXPORT Standard_Integer STEPCAFControl_Reader::NbRootsForTransfer  ) 
 

void STEPCAFControl_Reader::operator delete void *  anAddress  )  [inline]
 

void* STEPCAFControl_Reader::operator new size_t  size  )  [inline]
 

void* STEPCAFControl_Reader::operator new size_t  ,
void *  anAddress
[inline]
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::Perform const Standard_CString  filename,
Handle(TDocStd_Document)&  doc
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::Perform const TCollection_AsciiString &  filename,
Handle(TDocStd_Document)&  doc
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::ReadColors const Handle(XSControl_WorkSession)&  WS,
Handle(TDocStd_Document)&  doc,
const STEPCAFControl_DataMapOfPDExternFile PDFileMap,
const STEPCAFControl_DataMapOfShapeLabel ShapeLabelMap
const [protected]
 

Standard_EXPORT const STEPControl_Reader& STEPCAFControl_Reader::Reader  )  const
 

Standard_EXPORT STEPControl_Reader& STEPCAFControl_Reader::Reader  ) 
 

Standard_EXPORT Handle_STEPCAFControl_ExternFile STEPCAFControl_Reader::ReadExternFile const Standard_CString  file,
const Standard_CString  fullpath,
Handle(TDocStd_Document)&  doc
[protected]
 

Standard_EXPORT IFSelect_ReturnStatus STEPCAFControl_Reader::ReadFile const Standard_CString  filename  ) 
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::ReadGDTs const Handle(XSControl_WorkSession)&  WS,
Handle(TDocStd_Document)&  doc
const [protected]
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::ReadLayers const Handle(XSControl_WorkSession)&  WS,
Handle(TDocStd_Document)&  doc
const [protected]
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::ReadMaterials const Handle(XSControl_WorkSession)&  WS,
Handle(TDocStd_Document)&  doc,
const Handle(TColStd_HSequenceOfTransient)&  SeqPDS
const [protected]
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::ReadNames const Handle(XSControl_WorkSession)&  WS,
Handle(TDocStd_Document)&  doc,
const STEPCAFControl_DataMapOfPDExternFile PDFileMap,
const STEPCAFControl_DataMapOfShapeLabel ShapeLabelMap
const [protected]
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::ReadSHUOs const Handle(XSControl_WorkSession)&  WS,
Handle(TDocStd_Document)&  doc,
const STEPCAFControl_DataMapOfPDExternFile PDFileMap,
const STEPCAFControl_DataMapOfShapeLabel ShapeLabelMap
const [protected]
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::ReadValProps const Handle(XSControl_WorkSession)&  WS,
Handle(TDocStd_Document)&  doc,
const STEPCAFControl_DataMapOfPDExternFile PDFileMap,
const STEPCAFControl_DataMapOfShapeLabel ShapeLabelMap
const [protected]
 

Standard_EXPORT void STEPCAFControl_Reader::SetColorMode const Standard_Boolean  colormode  ) 
 

Standard_EXPORT void STEPCAFControl_Reader::SetGDTMode const Standard_Boolean  gdtmode  ) 
 

Standard_EXPORT void STEPCAFControl_Reader::SetLayerMode const Standard_Boolean  layermode  ) 
 

Standard_EXPORT void STEPCAFControl_Reader::SetMatMode const Standard_Boolean  matmode  ) 
 

Standard_EXPORT void STEPCAFControl_Reader::SetNameMode const Standard_Boolean  namemode  ) 
 

Standard_EXPORT void STEPCAFControl_Reader::SetPropsMode const Standard_Boolean  propsmode  ) 
 

Standard_EXPORT void STEPCAFControl_Reader::SetSHUOMode const Standard_Boolean  shuomode  ) 
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::Transfer STEPControl_Reader rd,
const Standard_Integer  num,
Handle(TDocStd_Document)&  doc,
TDF_LabelSequence &  Lseq,
const Standard_Boolean  asOne = Standard_False
[protected]
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::Transfer Handle(TDocStd_Document)&  doc  ) 
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Reader::TransferOneRoot const Standard_Integer  num,
Handle(TDocStd_Document)&  doc
 


Field Documentation

Standard_Boolean STEPCAFControl_Reader::myColorMode [private]
 

Handle_STEPCAFControl_DictionaryOfExternFile STEPCAFControl_Reader::myFiles [private]
 

Standard_Boolean STEPCAFControl_Reader::myGDTMode [private]
 

Standard_Boolean STEPCAFControl_Reader::myLayerMode [private]
 

Standard_Boolean STEPCAFControl_Reader::myMatMode [private]
 

Standard_Boolean STEPCAFControl_Reader::myNameMode [private]
 

Standard_Boolean STEPCAFControl_Reader::myPropsMode [private]
 

STEPControl_Reader STEPCAFControl_Reader::myReader [private]
 

Standard_Boolean STEPCAFControl_Reader::mySHUOMode [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 14:43:02 2008 for OpenCASCADE by  doxygen 1.4.1