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

Provides basic functionalities for tools which are intended for encoding/decoding specific STEP constructs. More...

#include <STEPConstruct_Tool.hxx>

Inheritance diagram for STEPConstruct_Tool:
Inheritance graph
[legend]

Public Member Functions

 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 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 basic functionalities for tools which are intended for encoding/decoding specific STEP constructs.

It is initialized by WorkSession and allows easy access to its fields and internal data such as Model, TP and FP

NOTE: Call to method Graph() with True (or for a first time, if you have updated the model since last computation of model) can take a time, so it is recommended to avoid creation of this (and derived) tool multiple times

Constructor & Destructor Documentation

◆ STEPConstruct_Tool() [1/2]

STEPConstruct_Tool::STEPConstruct_Tool ( )

Creates an empty tool.

◆ STEPConstruct_Tool() [2/2]

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

Creates a tool and loads it with worksession.

Member Function Documentation

◆ FinderProcess()

const Handle< Transfer_FinderProcess >& STEPConstruct_Tool::FinderProcess ( ) const

Returns FinderProcess (writing; Null if not loaded)

◆ Graph()

const Interface_Graph& STEPConstruct_Tool::Graph ( const Standard_Boolean  recompute = Standard_False) const

Returns current graph (recomputing if necessary)

◆ Model()

Handle< Interface_InterfaceModel > STEPConstruct_Tool::Model ( ) const

Returns current model (Null if not loaded)

◆ SetWS()

Standard_Boolean STEPConstruct_Tool::SetWS ( const Handle< XSControl_WorkSession > &  WS)
protected

Load worksession; returns True if succeeded Returns False if either FinderProcess of TransientProcess cannot be obtained or are Null.

◆ TransientProcess()

const Handle< Transfer_TransientProcess >& STEPConstruct_Tool::TransientProcess ( ) const

Returns TransientProcess (reading; Null if not loaded)

◆ WS()

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

Returns currently loaded WorkSession.


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