Open CASCADE Technology 6.6.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

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

#include <STEPConstruct_ExternRefs.hxx>

Inheritance diagram for STEPConstruct_ExternRefs:
Inheritance graph
[legend]

Public Member Functions

 STEPConstruct_ExternRefs ()
 Creates an empty tool

 STEPConstruct_ExternRefs (const Handle< XSControl_WorkSession > &WS)
 Creates a tool and initializes it

Standard_Boolean Init (const Handle< XSControl_WorkSession > &WS)
 Initializes tool; returns True if succeeded

void Clear ()
 Clears internal fields (list of defined extern refs)

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

Standard_Integer NbExternRefs () const
 Returns number of defined extern references

const Standard_CString FileName (const Standard_Integer num) const
 Returns filename for numth extern reference
Returns Null if FileName is not defined or bad

Handle_StepBasic_ProductDefinition 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.

Handle_TCollection_HAsciiString Format (const Standard_Integer num) const
 Returns format identification string for the extern document
Returns Null handle if format is not defined

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

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

Standard_Integer WriteExternRefs (const Standard_Integer num) const
 Adds all the currently defined external refs to the model
Returns number of written extern refs

void SetAP214APD (const Handle< StepBasic_ApplicationProtocolDefinition > &APD)
 Set the ApplicationProtocolDefinition of the PDM schema

Handle_StepBasic_ApplicationProtocolDefinition GetAP214APD ()
 Returns the ApplicationProtocolDefinition of the PDM schema
NOTE: if not defined then create new APD with new Application Context

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).


Constructor & Destructor Documentation

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

Member Function Documentation

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]
Standard_Integer STEPConstruct_ExternRefs::AddExternRef ( const Standard_CString  filename,
const Handle< StepBasic_ProductDefinition > &  PD,
const Standard_CString  format 
)
void STEPConstruct_ExternRefs::checkAP214Shared ( )
void STEPConstruct_ExternRefs::Clear ( )
const Standard_CString STEPConstruct_ExternRefs::FileName ( const Standard_Integer  num) const
Handle_TCollection_HAsciiString STEPConstruct_ExternRefs::Format ( const Standard_Integer  num) const
Handle_StepBasic_ApplicationProtocolDefinition STEPConstruct_ExternRefs::GetAP214APD ( )
Standard_Boolean STEPConstruct_ExternRefs::Init ( const Handle< XSControl_WorkSession > &  WS)
Standard_Boolean STEPConstruct_ExternRefs::LoadExternRefs ( )
Standard_Integer STEPConstruct_ExternRefs::NbExternRefs ( ) const
Handle_StepBasic_ProductDefinition STEPConstruct_ExternRefs::ProdDef ( const Standard_Integer  num) const
void STEPConstruct_ExternRefs::SetAP214APD ( const Handle< StepBasic_ApplicationProtocolDefinition > &  APD)
Standard_Integer STEPConstruct_ExternRefs::WriteExternRefs ( const Standard_Integer  num) const

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