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:

Public Member Functions
	STEPConstruct_Tool ()
	Creates an empty tool.
	STEPConstruct_Tool (const occ::handle< XSControl_WorkSession > &WS)
	Creates a tool and loads it with worksession.
const occ::handle< XSControl_WorkSession > &	WS () const
	Returns currently loaded WorkSession.
occ::handle< Interface_InterfaceModel >	Model () const
	Returns current model (Null if not loaded).
const Interface_Graph &	Graph (const bool recompute=false) const
	Returns current graph (recomputing if necessary).
const occ::handle< Transfer_TransientProcess > &	TransientProcess () const
	Returns TransientProcess (reading; Null if not loaded).
const occ::handle< Transfer_FinderProcess > &	FinderProcess () const
	Returns FinderProcess (writing; Null if not loaded).

Protected Member Functions
bool	SetWS (const occ::handle< XSControl_WorkSession > &WS)
	Load worksession; returns True if succeeded Returns False if either FinderProcess of TransientProcess cannot be obtained or are Null.

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 occ::handle< XSControl_WorkSession > &

WS

)

Creates a tool and loads it with worksession.

Member Function Documentation

FinderProcess()

const occ::handle< Transfer_FinderProcess > & STEPConstruct_Tool::FinderProcess

(

)

const

Returns FinderProcess (writing; Null if not loaded).

Graph()

const Interface_Graph & STEPConstruct_Tool::Graph

(

const bool

recompute = false

)

const

Returns current graph (recomputing if necessary).

Model()

occ::handle< Interface_InterfaceModel > STEPConstruct_Tool::Model

(

)

const

Returns current model (Null if not loaded).

SetWS()

bool STEPConstruct_Tool::SetWS ( const occ::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 occ::handle< Transfer_TransientProcess > & STEPConstruct_Tool::TransientProcess

(

)

const

Returns TransientProcess (reading; Null if not loaded).

WS()

const occ::handle< XSControl_WorkSession > & STEPConstruct_Tool::WS

(

)

const

Returns currently loaded WorkSession.

---

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

• STEPConstruct_Tool.hxx