ISTEPOperations Interface Reference

Interface for STEPPlugin modeling functions. More...

import "STEPPlugin.idl";

Public Member Functions
void	ExportSTEP (in GEOM::GEOM_Object theObject, in string theFileName, in GEOM::length_unit theUnit)
	Export the given shape into a file with given name in STEP format. More...
GEOM::ListOfGO	ImportSTEP (in string theFileName, in boolean theIsIgnoreUnits, in boolean IsCreateAssemblies)
	Import a shape from the STEP file. More...
string	ReadValue (in string theFileName, in string theParameterName)
	Read a value of parameter from a file, containing a shape. More...
boolean	IsDone ()
	To know, if the operation was successfully performed. More...
void	SetErrorCode (in string theErrorID)
	Set the operation error code. More...
string	GetErrorCode ()
	Get the operation error code. More...
long	GetStudyID ()
	Get ID of study, where the operation is defined. More...
void	StartOperation ()
	Opens a new transaction. More...
void	FinishOperation ()
	Closes the previously opened trasaction. More...
void	AbortOperation ()
	Aborts the previously opened transaction. More...

Detailed Description

Interface for STEPPlugin modeling functions.

Member Function Documentation

void ExportSTEP	(	in GEOM::GEOM_Object	theObject,
		in string	theFileName,
		in GEOM::length_unit	theUnit
	)

Export the given shape into a file with given name in STEP format.

Parameters

theObject	Shape to be stored in the file.
theFileName	Name of the file to store the given shape in.
theUnit	the length unit.

GEOM::ListOfGO ImportSTEP	(	in string	theFileName,
		in boolean	theIsIgnoreUnits,
		in boolean	IsCreateAssemblies
	)

Import a shape from the STEP file.

Parameters

theFileName	The file, containing the shape.
theIsIgnoreUnits	If True, file length units will be ignored (set to 'meter') and result model will be scaled, if its units are not meters. If False (default), file length units will be taken into account.
IsCreateAssemblies	If True, for each assembly compound is created in the result. If False Compounds that contain a single shape are eliminated from the result.

Returns

List of GEOM_Objects, containing the created shape and propagation groups.

string ReadValue	(	in string	theFileName,
		in string	theParameterName
	)

Read a value of parameter from a file, containing a shape.

Parameters

theFileName	The file, containing the shape.
theParameterName	Specify the parameter. For example, pass "LEN_UNITS" to obtain length units, in which the file is written.

Returns

Value of requested parameter in form of text string.

boolean IsDone ( )

inherited

To know, if the operation was successfully performed.

void SetErrorCode ( in string  theErrorID )

inherited

Set the operation error code.

Parameters

theErrorID

is a string describing the error occured

Note

This method is supposed to be used only by interfaces inheriting from IOperations.

string GetErrorCode ( )

inherited

Get the operation error code.

long GetStudyID ( )

inherited

Get ID of study, where the operation is defined.

void StartOperation ( )

inherited

Opens a new transaction.

void FinishOperation ( )

inherited

Closes the previously opened trasaction.

void AbortOperation ( )

inherited

Aborts the previously opened transaction.