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

DataExchange
TKXDESTEP
STEPCAFControl


STEPCAFControl_Writer Class Reference

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

#include <STEPCAFControl_Writer.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_Writer ()
 Creates a writer with an empty
STEP model and sets ColorMode, LayerMode, NameMode and
PropsMode to Standard_True.
.
Standard_EXPORT STEPCAFControl_Writer (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
Clears the internal data structures
.
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 Write (const Standard_CString filename)
 Writes all the produced models into file
In case of multimodel with extern references,
filename will be a name of root file, all other files
have names of corresponding parts
Provided for use like single-file writer
.
Standard_EXPORT Standard_Boolean Transfer (const Handle(TDocStd_Document)&doc, const STEPControl_StepModelType mode=STEPControl_AsIs, const Standard_CString multi=0)
Standard_EXPORT Standard_Boolean Transfer (const TDF_Label &L, const STEPControl_StepModelType mode=STEPControl_AsIs, const Standard_CString multi=0)
 Transfers a document (or single label) to a STEP model
The mode of translation of shape is AsIs
If multi is not null pointer, it switches to multifile
mode (with external refs), and string pointed by <multi>
gives prefix for names of extern files (can be empty string)
Returns True if translation is OK
.
Standard_EXPORT Standard_Boolean Perform (const Handle(TDocStd_Document)&doc, const TCollection_AsciiString &filename)
Standard_EXPORT Standard_Boolean Perform (const Handle(TDocStd_Document)&doc, const Standard_CString filename)
 Transfers a document and writes it to a STEP file
Returns True if translation is OK
.
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 TDF_Label &L, Handle(STEPCAFControl_ExternFile)&ef) const
 Returns data on external file by its original label
Returns False if no external file with given name is 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_WriterWriter ()
 Returns basic reader for root file
.
Standard_EXPORT const STEPControl_WriterWriter () const
 Returns basic reader as const
.
Standard_EXPORT void SetColorMode (const Standard_Boolean colormode)
 Set ColorMode for indicate write Colors or not.
.
Standard_EXPORT Standard_Boolean GetColorMode () const
Standard_EXPORT void SetNameMode (const Standard_Boolean namemode)
 Set NameMode for indicate write Name or not.
.
Standard_EXPORT Standard_Boolean GetNameMode () const
Standard_EXPORT void SetLayerMode (const Standard_Boolean layermode)
 Set LayerMode for indicate write Layers or not.
.
Standard_EXPORT Standard_Boolean GetLayerMode () const
Standard_EXPORT void SetPropsMode (const Standard_Boolean propsmode)
 PropsMode for indicate write 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 SetDimTolMode (const Standard_Boolean dimtolmode)
 Set dimtolmode for indicate write D&GTs or not.
.
Standard_EXPORT Standard_Boolean GetDimTolMode () const
Standard_EXPORT void SetMaterialMode (const Standard_Boolean matmode)
 Set dimtolmode for indicate write D&GTs or not.
.
Standard_EXPORT Standard_Boolean GetMaterialMode () const

Protected Member Functions

Standard_EXPORT Standard_Boolean Transfer (STEPControl_Writer &wr, const TDF_LabelSequence &labels, const STEPControl_StepModelType mode=STEPControl_AsIs, const Standard_CString multi=0, const Standard_Boolean isExternFile=Standard_False)
 Transfers labels to a STEP model
Returns True if translation is OK
isExternFile setting from TransferExternFiles method
.
Standard_EXPORT TopoDS_Shape TransferExternFiles (const TDF_Label &L, const STEPControl_StepModelType mode, TDF_LabelSequence &Lseq, const Standard_CString prefix="")
 Parses assembly structure of label L, writes all the simple
shapes each to its own file named by name of its label plus
prefix
Returns shape representing that assembly structure
in the form of nested empty compounds (and a sequence of
labels which are newly written nodes of this assembly)
.
Standard_EXPORT Standard_Boolean WriteExternRefs (const Handle(XSControl_WorkSession)&WS, const TDF_LabelSequence &labels) const
 Write external references to STEP
.
Standard_EXPORT Standard_Boolean WriteColors (const Handle(XSControl_WorkSession)&WS, const TDF_LabelSequence &labels)
 Write colors assigned to specified labels, to STEP model
.
Standard_EXPORT Standard_Boolean WriteNames (const Handle(XSControl_WorkSession)&WS, const TDF_LabelSequence &labels) const
 Write names assigned to specified labels, to STEP model
.
Standard_EXPORT Standard_Boolean WriteDGTs (const Handle(XSControl_WorkSession)&WS, const TDF_LabelSequence &labels) const
 Write D&GTs assigned to specified labels, to STEP model
.
Standard_EXPORT Standard_Boolean WriteMaterials (const Handle(XSControl_WorkSession)&WS, const TDF_LabelSequence &labels) const
 Write materials assigned to specified labels, to STEP model
.
Standard_EXPORT Standard_Boolean WriteValProps (const Handle(XSControl_WorkSession)&WS, const TDF_LabelSequence &labels, const Standard_CString multi) const
 Write validation properties assigned to specified labels,
to STEP model
.
Standard_EXPORT Standard_Boolean WriteLayers (const Handle(XSControl_WorkSession)&WS, const TDF_LabelSequence &labels) const
 Write layers assigned to specified labels, to STEP model
.
Standard_EXPORT Standard_Boolean WriteSHUOs (const Handle(XSControl_WorkSession)&WS, const TDF_LabelSequence &labels)
 Write SHUO assigned to specified component, to STEP model
.

Private Attributes

STEPControl_Writer myWriter
Handle_STEPCAFControl_DictionaryOfExternFile myFiles
STEPCAFControl_DataMapOfLabelShape myLabels
STEPCAFControl_DataMapOfLabelExternFile myLabEF
Standard_Boolean myColorMode
Standard_Boolean myNameMode
Standard_Boolean myLayerMode
Standard_Boolean myPropsMode
Standard_Boolean mySHUOMode
STEPCAFControl_DataMapOfShapeTransient myMapCompMDGPR
Standard_Boolean myDGTMode
Standard_Boolean myMatMode


Constructor & Destructor Documentation

Standard_EXPORT STEPCAFControl_Writer::STEPCAFControl_Writer  ) 
 

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


Member Function Documentation

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

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::ExternFile const TDF_Label &  L,
Handle(STEPCAFControl_ExternFile)&  ef
const
 

Standard_EXPORT const Handle_STEPCAFControl_DictionaryOfExternFile& STEPCAFControl_Writer::ExternFiles  )  const
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::GetColorMode  )  const
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::GetDimTolMode  )  const
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::GetLayerMode  )  const
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::GetMaterialMode  )  const
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::GetNameMode  )  const
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::GetPropsMode  )  const
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::GetSHUOMode  )  const
 

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

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

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

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

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

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

Standard_EXPORT void STEPCAFControl_Writer::SetColorMode const Standard_Boolean  colormode  ) 
 

Standard_EXPORT void STEPCAFControl_Writer::SetDimTolMode const Standard_Boolean  dimtolmode  ) 
 

Standard_EXPORT void STEPCAFControl_Writer::SetLayerMode const Standard_Boolean  layermode  ) 
 

Standard_EXPORT void STEPCAFControl_Writer::SetMaterialMode const Standard_Boolean  matmode  ) 
 

Standard_EXPORT void STEPCAFControl_Writer::SetNameMode const Standard_Boolean  namemode  ) 
 

Standard_EXPORT void STEPCAFControl_Writer::SetPropsMode const Standard_Boolean  propsmode  ) 
 

Standard_EXPORT void STEPCAFControl_Writer::SetSHUOMode const Standard_Boolean  shuomode  ) 
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::Transfer STEPControl_Writer wr,
const TDF_LabelSequence &  labels,
const STEPControl_StepModelType  mode = STEPControl_AsIs,
const Standard_CString  multi = 0,
const Standard_Boolean  isExternFile = Standard_False
[protected]
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::Transfer const TDF_Label &  L,
const STEPControl_StepModelType  mode = STEPControl_AsIs,
const Standard_CString  multi = 0
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::Transfer const Handle(TDocStd_Document)&  doc,
const STEPControl_StepModelType  mode = STEPControl_AsIs,
const Standard_CString  multi = 0
 

Standard_EXPORT TopoDS_Shape STEPCAFControl_Writer::TransferExternFiles const TDF_Label &  L,
const STEPControl_StepModelType  mode,
TDF_LabelSequence &  Lseq,
const Standard_CString  prefix = ""
[protected]
 

Standard_EXPORT IFSelect_ReturnStatus STEPCAFControl_Writer::Write const Standard_CString  filename  ) 
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::WriteColors const Handle(XSControl_WorkSession)&  WS,
const TDF_LabelSequence &  labels
[protected]
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::WriteDGTs const Handle(XSControl_WorkSession)&  WS,
const TDF_LabelSequence &  labels
const [protected]
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::WriteExternRefs const Handle(XSControl_WorkSession)&  WS,
const TDF_LabelSequence &  labels
const [protected]
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::WriteLayers const Handle(XSControl_WorkSession)&  WS,
const TDF_LabelSequence &  labels
const [protected]
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::WriteMaterials const Handle(XSControl_WorkSession)&  WS,
const TDF_LabelSequence &  labels
const [protected]
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::WriteNames const Handle(XSControl_WorkSession)&  WS,
const TDF_LabelSequence &  labels
const [protected]
 

Standard_EXPORT const STEPControl_Writer& STEPCAFControl_Writer::Writer  )  const
 

Standard_EXPORT STEPControl_Writer& STEPCAFControl_Writer::Writer  ) 
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::WriteSHUOs const Handle(XSControl_WorkSession)&  WS,
const TDF_LabelSequence &  labels
[protected]
 

Standard_EXPORT Standard_Boolean STEPCAFControl_Writer::WriteValProps const Handle(XSControl_WorkSession)&  WS,
const TDF_LabelSequence &  labels,
const Standard_CString  multi
const [protected]
 


Field Documentation

Standard_Boolean STEPCAFControl_Writer::myColorMode [private]
 

Standard_Boolean STEPCAFControl_Writer::myDGTMode [private]
 

Handle_STEPCAFControl_DictionaryOfExternFile STEPCAFControl_Writer::myFiles [private]
 

STEPCAFControl_DataMapOfLabelExternFile STEPCAFControl_Writer::myLabEF [private]
 

STEPCAFControl_DataMapOfLabelShape STEPCAFControl_Writer::myLabels [private]
 

Standard_Boolean STEPCAFControl_Writer::myLayerMode [private]
 

STEPCAFControl_DataMapOfShapeTransient STEPCAFControl_Writer::myMapCompMDGPR [private]
 

Standard_Boolean STEPCAFControl_Writer::myMatMode [private]
 

Standard_Boolean STEPCAFControl_Writer::myNameMode [private]
 

Standard_Boolean STEPCAFControl_Writer::myPropsMode [private]
 

Standard_Boolean STEPCAFControl_Writer::mySHUOMode [private]
 

STEPControl_Writer STEPCAFControl_Writer::myWriter [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