IXAOOperations Interface Reference

Interface for XAOPlugin modeling functions. More...

import"XAOPlugin.idl";

Public Member Functions
boolean	ExportXAO (in GEOM::GEOM_Object shape, in GEOM::ListOfGO groups, in GEOM::ListOfFields fields, in string author, in string fileName, in string shapeFileName)
SALOMEDS::TMPFile	ExportXAOMem (in GEOM::GEOM_Object shape, in GEOM::ListOfGO groups, in GEOM::ListOfFields fields, in string author)
boolean	ImportXAO (in string fileName, out GEOM::GEOM_Object shape, out GEOM::ListOfGO subShapes, out GEOM::ListOfGO groups, out GEOM::ListOfFields fields)
boolean	ImportXAOMem (in SALOMEDS::TMPFile theBuff, out GEOM::GEOM_Object shape, out GEOM::ListOfGO subShapes, out GEOM::ListOfGO groups, out GEOM::ListOfFields fields)
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...
void	StartOperation ()
	Opens a new transaction. More...
void	FinishOperation ()
	Closes the previously opened transaction. More...
void	AbortOperation ()
	Aborts the previously opened transaction. More...

Detailed Description

Interface for XAOPlugin modeling functions.

Member Function Documentation

ExportXAO()

boolean ExportXAO	(	in GEOM::GEOM_Object	shape,
		in GEOM::ListOfGO	groups,
		in GEOM::ListOfFields	fields,
		in string	author,
		in string	fileName,
		in string	shapeFileName
	)

Export a shape to XAO format

Parameters

shape	The shape to export
groups	The list of groups to export
fields	The list of fields to export
author	The author of the export
fileName	The name of the file to export
shapeFileName	The name of the file to export the shape in an external file

Returns

boolean indicating if export was successful.

ExportXAOMem()

SALOMEDS::TMPFile ExportXAOMem	(	in GEOM::GEOM_Object	shape,
		in GEOM::ListOfGO	groups,
		in GEOM::ListOfFields	fields,
		in string	author
	)

Export a shape to XAO format in a byte array

Parameters

shape	The shape to export
groups	The list of groups to export
fields	The list of fields to export
author	The author of the export

Returns

Byte array with exported data.

ImportXAO()

boolean ImportXAO	(	in string	fileName,
		out GEOM::GEOM_Object	shape,
		out GEOM::ListOfGO	subShapes,
		out GEOM::ListOfGO	groups,
		out GEOM::ListOfFields	fields
	)

Import a shape from XAO format

Parameters

fileName	The name of the file to import
shape	The imported shape
subShapes	The list of imported subShapes
groups	The list of imported groups
fields	The list of imported fields

Returns

boolean indicating if import was successful.

ImportXAOMem()

boolean ImportXAOMem	(	in SALOMEDS::TMPFile	theBuff,
		out GEOM::GEOM_Object	shape,
		out GEOM::ListOfGO	subShapes,
		out GEOM::ListOfGO	groups,
		out GEOM::ListOfFields	fields
	)

Import a shape from XAO format byte array

Parameters

theBuff	The byte array with data in XAO format
shape	The imported shape
subShapes	The list of imported subShapes
groups	The list of imported groups
fields	The list of imported fields

Returns

boolean indicating if import was successful.

IsDone()

boolean IsDone ( )

inherited

To know, if the operation was successfully performed.

SetErrorCode()

void SetErrorCode ( in string  theErrorID )

inherited

Set the operation error code.

Parameters

theErrorID

is a string describing the error occurred

Note

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

GetErrorCode()

string GetErrorCode ( )

inherited

Get the operation error code.

StartOperation()

void StartOperation ( )

inherited

Opens a new transaction.

FinishOperation()

void FinishOperation ( )

inherited

Closes the previously opened transaction.

AbortOperation()

void AbortOperation ( )

inherited

Aborts the previously opened transaction.