Interface for shape insert operations (like copy, import).

import "GEOM_Gen.idl";

Inheritance diagram for GEOM::GEOM_IInsertOperations:

Classes
struct	TransferDatum
	Non-topological information transfer datum. More...

Public Types
typedef sequence< TransferDatum >	ListOfTransferDatum
	Sequence of non-topological information tranfer data. More...

Public Member Functions
GEOM_Object	MakeCopy (in GEOM_Object theOriginal)
	Create a copy of the given object. More...

void	Export (in GEOM_Object theObject, in string theFileName, in string theFormatName)
	Deprecated method. Use Export<FormatName> (from the corresponding plugin) instead; here <FormatName> is a name of format. More...

ListOfGBO	ImportFile (in string theFileName, in string theFormatName)
	Deprecated method. Use Import<FormatName> (from the corresponding plugin) instead; here <FormatName> is a name of format. More...

string	ReadValue (in string theFileName, in string theFormatName, in string theParameterName)
	Deprecated method. Use ReadValue (from the corresponding plugin) instead. More...

GEOM_Object	RestoreShape (in SALOMEDS::TMPFile theStream)
	Read a shape from the binary stream, containing its bounding representation (BRep). More...

long	LoadTexture (in string theTextureFile)
	Load texture from file. More...

long	AddTexture (in long theWidth, in long theHeight, in SALOMEDS::TMPFile theTexture)
	Add texture to the study. More...

SALOMEDS::TMPFile	GetTexture (in long theID, out long theWidth, out long theHeight)
	Get previously loaded texture data. More...

ListOfLong	GetAllTextures ()
	Get list of all avaiable texture IDs. More...

boolean	TransferData (in GEOM_Object theObjectFrom, in GEOM_Object theObjectTo, in find_shape_method theFindMethod, out ListOfTransferDatum theResult)
	Transfer non-topological data from one object to another. More...

Public Member Functions inherited from GEOM::GEOM_IOperations
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...

Member Typedef Documentation

typedef sequence<TransferDatum> GEOM::GEOM_IInsertOperations::ListOfTransferDatum

Member Function Documentation

long GEOM::GEOM_IInsertOperations::AddTexture	(	in long	theWidth,
		in long	theHeight,
		in SALOMEDS::TMPFile	theTexture
	)

Parameters

theWidth	texture width in pixels
theHeight	texture height in pixels
theTexture	texture byte array

Returns: unique texture identifier

void GEOM::GEOM_IInsertOperations::Export	(	in GEOM_Object	theObject,
		in string	theFileName,
		in string	theFormatName
	)

Export the given shape into a file with given name.

Parameters

theObject	Shape to be stored in the file.
theFileName	Name of the file to store the given shape in.
theFormatName	Specify format for the shape storage.

ListOfLong GEOM::GEOM_IInsertOperations::GetAllTextures ( )

Returns: list of all texture IDs avaiable for the current study

SALOMEDS::TMPFile GEOM::GEOM_IInsertOperations::GetTexture	(	in long	theID,
		out long	theWidth,
		out long	theHeight
	)

Parameters

theID	texture identifier
theWidth	texture width in pixels
theHeight	texture height in pixels

Returns: texture byte array

ListOfGBO GEOM::GEOM_IInsertOperations::ImportFile	(	in string	theFileName,
		in string	theFormatName
	)

Import a shape from the STL, BREP, IGES or STEP file (depends on given format) with given name.

Parameters

theFileName	The file, containing the shape.
theFormatName	Specify format for the file reading. If format 'IGES_SCALE' is used instead of 'IGES' or format 'STEP_SCALE' is used instead of 'STEP', file length unit will be ignored (set to 'meter') and result model will be scaled.

Returns: List of GEOM_Object, containing the created shape and groups of materials.

long GEOM::GEOM_IInsertOperations::LoadTexture ( in string theTextureFile )

Parameters

theTextureFile texture file name

Returns: unique texture identifier

GEOM_Object GEOM::GEOM_IInsertOperations::MakeCopy ( in GEOM_Object theOriginal )

string GEOM::GEOM_IInsertOperations::ReadValue	(	in string	theFileName,
		in string	theFormatName,
		in string	theParameterName
	)

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

Parameters

theFileName	The file, containing the shape.
theFormatName	Specify format for the file reading.
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.

GEOM_Object GEOM::GEOM_IInsertOperations::RestoreShape ( in SALOMEDS::TMPFile theStream )

Note: GEOM_Object::GetShapeStream() method can be used to obtain the shape's BRep stream.

Parameters

theStream The BRep binary stream.

Returns: New GEOM_Object, containing the shape, read from theStream.

boolean GEOM::GEOM_IInsertOperations::TransferData	(	in GEOM_Object	theObjectFrom,
		in GEOM_Object	theObjectTo,
		in find_shape_method	theFindMethod,
		out ListOfTransferDatum	theResult
	)

Parameters

theObjectFrom	the source object of non-topological data
theObjectTo	the destination object of non-topological data
theFindMethod	method to search sub-shapes of theObjectFrom in shape theObjectTo. Possible values are: GEOM::FSM_GetInPlace, GEOM::FSM_GetInPlaceByHistory and GEOM::FSM_GetInPlace_Old. Other values of GEOM::find_shape_method are not supported.
theResult	statistics of the operation. Output parameter. It represents a sequence of Transfer Datum. A datum has the type (string code), the total number of items of this type and the number of transfered items.

Returns: true in case of success; otherwise false.

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

idl/GEOM_Gen.idl

Classes

Public Types

Public Member Functions

Member Typedef Documentation

Member Function Documentation