Open CASCADE Technology  7.5.0
Public Member Functions | Protected Member Functions
STEPConstruct_ExternRefs Class Reference

Provides a tool for analyzing (reading) and creating (writing) references to external files in STEP. More...

#include <STEPConstruct_ExternRefs.hxx>

Inheritance diagram for STEPConstruct_ExternRefs:
Inheritance graph
[legend]

Public Member Functions

 STEPConstruct_ExternRefs ()
 Creates an empty tool. More...
 
 STEPConstruct_ExternRefs (const Handle< XSControl_WorkSession > &WS)
 Creates a tool and initializes it. More...
 
Standard_Boolean Init (const Handle< XSControl_WorkSession > &WS)
 Initializes tool; returns True if succeeded. More...
 
void Clear ()
 Clears internal fields (list of defined extern refs) More...
 
Standard_Boolean LoadExternRefs ()
 Searches current STEP model for external references and loads them to the internal data structures NOTE: does not clear data structures before loading. More...
 
Standard_Integer NbExternRefs () const
 Returns number of defined extern references. More...
 
Standard_CString FileName (const Standard_Integer num) const
 Returns filename for numth extern reference Returns Null if FileName is not defined or bad. More...
 
Handle< StepBasic_ProductDefinitionProdDef (const Standard_Integer num) const
 Returns ProductDefinition to which numth extern reference is associated. Returns Null if cannot be detected or if extern reference is not associated to SDR in a proper way. More...
 
Handle< StepBasic_DocumentFileDocFile (const Standard_Integer num) const
 Returns DocumentFile to which numth extern reference is associated. Returns Null if cannot be detected. More...
 
Handle< TCollection_HAsciiStringFormat (const Standard_Integer num) const
 Returns format identification string for the extern document Returns Null handle if format is not defined. More...
 
Standard_Integer AddExternRef (const Standard_CString filename, const Handle< StepBasic_ProductDefinition > &PD, const Standard_CString format)
 Create a new external reference with specified attributes attached to a given SDR <format> can be Null string, in that case this information is not written. Else, it can be "STEP AP214" or "STEP AP203" Returns index of a new extern ref. More...
 
void checkAP214Shared ()
 Check (create if it is null) all shared entities for the model. More...
 
Standard_Integer WriteExternRefs (const Standard_Integer num) const
 Adds all the currently defined external refs to the model Returns number of written extern refs. More...
 
void SetAP214APD (const Handle< StepBasic_ApplicationProtocolDefinition > &APD)
 Set the ApplicationProtocolDefinition of the PDM schema. More...
 
Handle< StepBasic_ApplicationProtocolDefinitionGetAP214APD ()
 Returns the ApplicationProtocolDefinition of the PDM schema NOTE: if not defined then create new APD with new Application Context. More...
 
- Public Member Functions inherited from STEPConstruct_Tool
 STEPConstruct_Tool ()
 Creates an empty tool. More...
 
 STEPConstruct_Tool (const Handle< XSControl_WorkSession > &WS)
 Creates a tool and loads it with worksession. More...
 
const Handle< XSControl_WorkSession > & WS () const
 Returns currently loaded WorkSession. More...
 
Handle< Interface_InterfaceModelModel () const
 Returns current model (Null if not loaded) More...
 
const Interface_GraphGraph (const Standard_Boolean recompute=Standard_False) const
 Returns current graph (recomputing if necessary) More...
 
const Handle< Transfer_TransientProcess > & TransientProcess () const
 Returns TransientProcess (reading; Null if not loaded) More...
 
const Handle< Transfer_FinderProcess > & FinderProcess () const
 Returns FinderProcess (writing; Null if not loaded) More...
 

Protected Member Functions

Standard_Boolean addAP214ExterRef (const Handle< StepAP214_AppliedDocumentReference > &ADR, const Handle< StepBasic_ProductDefinition > &PD, const Handle< StepBasic_DocumentFile > &DF, const Standard_CString filename)
 Create a new additional structure entities and add ncessary references Note: do not refer from ADR to DF directly in AP214 (TRJ11). More...
 
- Protected Member Functions inherited from STEPConstruct_Tool
Standard_Boolean SetWS (const Handle< XSControl_WorkSession > &WS)
 Load worksession; returns True if succeeded Returns False if either FinderProcess of TransientProcess cannot be obtained or are Null. More...
 

Detailed Description

Provides a tool for analyzing (reading) and creating (writing) references to external files in STEP.

It maintains a data structure in the form of sequences of relevant STEP entities (roots), allowing either to create them by convenient API, or load from existing model and investigate

Constructor & Destructor Documentation

◆ STEPConstruct_ExternRefs() [1/2]

STEPConstruct_ExternRefs::STEPConstruct_ExternRefs ( )

Creates an empty tool.

◆ STEPConstruct_ExternRefs() [2/2]

STEPConstruct_ExternRefs::STEPConstruct_ExternRefs ( const Handle< XSControl_WorkSession > &  WS)

Creates a tool and initializes it.

Member Function Documentation

◆ addAP214ExterRef()

Standard_Boolean STEPConstruct_ExternRefs::addAP214ExterRef ( const Handle< StepAP214_AppliedDocumentReference > &  ADR,
const Handle< StepBasic_ProductDefinition > &  PD,
const Handle< StepBasic_DocumentFile > &  DF,
const Standard_CString  filename 
)
protected

Create a new additional structure entities and add ncessary references Note: do not refer from ADR to DF directly in AP214 (TRJ11).

◆ AddExternRef()

Standard_Integer STEPConstruct_ExternRefs::AddExternRef ( const Standard_CString  filename,
const Handle< StepBasic_ProductDefinition > &  PD,
const Standard_CString  format 
)

Create a new external reference with specified attributes attached to a given SDR <format> can be Null string, in that case this information is not written. Else, it can be "STEP AP214" or "STEP AP203" Returns index of a new extern ref.

◆ checkAP214Shared()

void STEPConstruct_ExternRefs::checkAP214Shared ( )

Check (create if it is null) all shared entities for the model.

◆ Clear()

void STEPConstruct_ExternRefs::Clear ( )

Clears internal fields (list of defined extern refs)

◆ DocFile()

Handle< StepBasic_DocumentFile > STEPConstruct_ExternRefs::DocFile ( const Standard_Integer  num) const

Returns DocumentFile to which numth extern reference is associated. Returns Null if cannot be detected.

◆ FileName()

Standard_CString STEPConstruct_ExternRefs::FileName ( const Standard_Integer  num) const

Returns filename for numth extern reference Returns Null if FileName is not defined or bad.

◆ Format()

Handle< TCollection_HAsciiString > STEPConstruct_ExternRefs::Format ( const Standard_Integer  num) const

Returns format identification string for the extern document Returns Null handle if format is not defined.

◆ GetAP214APD()

Handle< StepBasic_ApplicationProtocolDefinition > STEPConstruct_ExternRefs::GetAP214APD ( )

Returns the ApplicationProtocolDefinition of the PDM schema NOTE: if not defined then create new APD with new Application Context.

◆ Init()

Standard_Boolean STEPConstruct_ExternRefs::Init ( const Handle< XSControl_WorkSession > &  WS)

Initializes tool; returns True if succeeded.

◆ LoadExternRefs()

Standard_Boolean STEPConstruct_ExternRefs::LoadExternRefs ( )

Searches current STEP model for external references and loads them to the internal data structures NOTE: does not clear data structures before loading.

◆ NbExternRefs()

Standard_Integer STEPConstruct_ExternRefs::NbExternRefs ( ) const

Returns number of defined extern references.

◆ ProdDef()

Handle< StepBasic_ProductDefinition > STEPConstruct_ExternRefs::ProdDef ( const Standard_Integer  num) const

Returns ProductDefinition to which numth extern reference is associated. Returns Null if cannot be detected or if extern reference is not associated to SDR in a proper way.

◆ SetAP214APD()

void STEPConstruct_ExternRefs::SetAP214APD ( const Handle< StepBasic_ApplicationProtocolDefinition > &  APD)

Set the ApplicationProtocolDefinition of the PDM schema.

◆ WriteExternRefs()

Standard_Integer STEPConstruct_ExternRefs::WriteExternRefs ( const Standard_Integer  num) const

Adds all the currently defined external refs to the model Returns number of written extern refs.


The documentation for this class was generated from the following file: