Open CASCADE Technology 6.6.0
Public Member Functions | Protected Member Functions
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

Also supports multifile writing

#include <STEPCAFControl_Writer.hxx>

Public Member Functions

 STEPCAFControl_Writer ()
 Creates a writer with an empty
STEP model and sets ColorMode, LayerMode, NameMode and
PropsMode to Standard_True.

 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

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

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_Boolean Transfer (const Handle< TDocStd_Document > &doc, const STEPControl_StepModelType mode=STEPControl_AsIs, const Standard_CString multi=0)
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_Boolean Perform (const Handle< TDocStd_Document > &doc, const TCollection_AsciiString &filename)
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

const
Handle_STEPCAFControl_DictionaryOfExternFile & 
ExternFiles () const
 Returns data on external files
Returns Null handle if no external files are read

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_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

STEPControl_WriterChangeWriter ()
 Returns basic reader for root file

const STEPControl_WriterWriter () const
 Returns basic reader as const

void SetColorMode (const Standard_Boolean colormode)
 Set ColorMode for indicate write Colors or not.

Standard_Boolean GetColorMode () const
void SetNameMode (const Standard_Boolean namemode)
 Set NameMode for indicate write Name or not.

Standard_Boolean GetNameMode () const
void SetLayerMode (const Standard_Boolean layermode)
 Set LayerMode for indicate write Layers or not.

Standard_Boolean GetLayerMode () const
void SetPropsMode (const Standard_Boolean propsmode)
 PropsMode for indicate write Validation properties or not.

Standard_Boolean GetPropsMode () const
void SetSHUOMode (const Standard_Boolean shuomode)
 Set SHUO mode for indicate write SHUO or not.

Standard_Boolean GetSHUOMode () const
void SetDimTolMode (const Standard_Boolean dimtolmode)
 Set dimtolmode for indicate write D&GTs or not.

Standard_Boolean GetDimTolMode () const
void SetMaterialMode (const Standard_Boolean matmode)
 Set dimtolmode for indicate write D&GTs or not.

Standard_Boolean GetMaterialMode () const

Protected Member Functions

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

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_Boolean WriteExternRefs (const Handle< XSControl_WorkSession > &WS, const TDF_LabelSequence &labels) const
 Write external references to STEP

Standard_Boolean WriteColors (const Handle< XSControl_WorkSession > &WS, const TDF_LabelSequence &labels)
 Write colors assigned to specified labels, to STEP model

Standard_Boolean WriteNames (const Handle< XSControl_WorkSession > &WS, const TDF_LabelSequence &labels) const
 Write names assigned to specified labels, to STEP model

Standard_Boolean WriteDGTs (const Handle< XSControl_WorkSession > &WS, const TDF_LabelSequence &labels) const
 Write D&GTs assigned to specified labels, to STEP model

Standard_Boolean WriteMaterials (const Handle< XSControl_WorkSession > &WS, const TDF_LabelSequence &labels) const
 Write materials assigned to specified labels, to STEP model

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_Boolean WriteLayers (const Handle< XSControl_WorkSession > &WS, const TDF_LabelSequence &labels) const
 Write layers assigned to specified labels, to STEP model

Standard_Boolean WriteSHUOs (const Handle< XSControl_WorkSession > &WS, const TDF_LabelSequence &labels)
 Write SHUO assigned to specified component, to STEP model


Constructor & Destructor Documentation

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

Member Function Documentation

STEPControl_Writer& STEPCAFControl_Writer::ChangeWriter ( )
Standard_Boolean STEPCAFControl_Writer::ExternFile ( const TDF_Label L,
Handle< STEPCAFControl_ExternFile > &  ef 
) const
Standard_Boolean STEPCAFControl_Writer::ExternFile ( const Standard_CString  name,
Handle< STEPCAFControl_ExternFile > &  ef 
) const
const Handle_STEPCAFControl_DictionaryOfExternFile& STEPCAFControl_Writer::ExternFiles ( ) const
Standard_Boolean STEPCAFControl_Writer::GetColorMode ( ) const
Standard_Boolean STEPCAFControl_Writer::GetDimTolMode ( ) const
Standard_Boolean STEPCAFControl_Writer::GetLayerMode ( ) const
Standard_Boolean STEPCAFControl_Writer::GetMaterialMode ( ) const
Standard_Boolean STEPCAFControl_Writer::GetNameMode ( ) const
Standard_Boolean STEPCAFControl_Writer::GetPropsMode ( ) const
Standard_Boolean STEPCAFControl_Writer::GetSHUOMode ( ) const
void STEPCAFControl_Writer::Init ( const Handle< XSControl_WorkSession > &  WS,
const Standard_Boolean  scratch = Standard_True 
)
Standard_Boolean STEPCAFControl_Writer::Perform ( const Handle< TDocStd_Document > &  doc,
const TCollection_AsciiString filename 
)
Standard_Boolean STEPCAFControl_Writer::Perform ( const Handle< TDocStd_Document > &  doc,
const Standard_CString  filename 
)
void STEPCAFControl_Writer::SetColorMode ( const Standard_Boolean  colormode)
void STEPCAFControl_Writer::SetDimTolMode ( const Standard_Boolean  dimtolmode)
void STEPCAFControl_Writer::SetLayerMode ( const Standard_Boolean  layermode)
void STEPCAFControl_Writer::SetMaterialMode ( const Standard_Boolean  matmode)
void STEPCAFControl_Writer::SetNameMode ( const Standard_Boolean  namemode)
void STEPCAFControl_Writer::SetPropsMode ( const Standard_Boolean  propsmode)
void STEPCAFControl_Writer::SetSHUOMode ( const Standard_Boolean  shuomode)
Standard_Boolean STEPCAFControl_Writer::Transfer ( const TDF_Label L,
const STEPControl_StepModelType  mode = STEPControl_AsIs,
const Standard_CString  multi = 0 
)
Standard_Boolean STEPCAFControl_Writer::Transfer ( const Handle< TDocStd_Document > &  doc,
const STEPControl_StepModelType  mode = STEPControl_AsIs,
const Standard_CString  multi = 0 
)
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]
TopoDS_Shape STEPCAFControl_Writer::TransferExternFiles ( const TDF_Label L,
const STEPControl_StepModelType  mode,
TDF_LabelSequence Lseq,
const Standard_CString  prefix = "" 
) [protected]
IFSelect_ReturnStatus STEPCAFControl_Writer::Write ( const Standard_CString  filename)
Standard_Boolean STEPCAFControl_Writer::WriteColors ( const Handle< XSControl_WorkSession > &  WS,
const TDF_LabelSequence labels 
) [protected]
Standard_Boolean STEPCAFControl_Writer::WriteDGTs ( const Handle< XSControl_WorkSession > &  WS,
const TDF_LabelSequence labels 
) const [protected]
Standard_Boolean STEPCAFControl_Writer::WriteExternRefs ( const Handle< XSControl_WorkSession > &  WS,
const TDF_LabelSequence labels 
) const [protected]
Standard_Boolean STEPCAFControl_Writer::WriteLayers ( const Handle< XSControl_WorkSession > &  WS,
const TDF_LabelSequence labels 
) const [protected]
Standard_Boolean STEPCAFControl_Writer::WriteMaterials ( const Handle< XSControl_WorkSession > &  WS,
const TDF_LabelSequence labels 
) const [protected]
Standard_Boolean STEPCAFControl_Writer::WriteNames ( const Handle< XSControl_WorkSession > &  WS,
const TDF_LabelSequence labels 
) const [protected]
const STEPControl_Writer& STEPCAFControl_Writer::Writer ( ) const
Standard_Boolean STEPCAFControl_Writer::WriteSHUOs ( const Handle< XSControl_WorkSession > &  WS,
const TDF_LabelSequence labels 
) [protected]
Standard_Boolean STEPCAFControl_Writer::WriteValProps ( const Handle< XSControl_WorkSession > &  WS,
const TDF_LabelSequence labels,
const Standard_CString  multi 
) const [protected]

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines