All Frameworks Class Hierarchy This Framework Indexes Previous Next

InteractiveInterfaces Interface CATISelectionSetsFactory

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATISelectionSetsFactory

Interface to manage the Selection Sets in a PLM Representation Reference.

Role: This interface, implemented by the PLM Representation Reference, enables you to create, find and delete Selection Set ( ) in a PLM Representation Reference.
Several Selection Sets can be created, and one can be defined as the current one.
Several Selection Sets can have the same name.
A Selection Set contains elements ( )

Method Index

o BeginFindOwningSets(): Starts a transaction with several FindOwningSets calls.
o CreateSelectionSet(CATUnicodeString&,CATISelectionSet*&): Creates a new Selection Set.
o DeleteSelectionSet(CATISelectionSet*&,CATUnicodeString&): Removes a Selection Set.
o EndFindOwningSets(): Ends a transaction with several FindOwningSets calls.
o FindOwningSets(CATPathElement*,CATSelectionSetMode,CATListOfCATISelectionSet_var*&): Finds all the Selection Sets that contain the searched element.
o FindSelectionSets(CATUnicodeString&,CATSelectionSetMode,CATListOfCATISelectionSet_var*&): Retrieves the list of Selection Sets from his name.
o GetCurrent(CATISelectionSet*&): Current Selection Set management.
o ListSelectionSets(CATSelectionSetMode,CATListOfCATISelectionSet_var*&): Retrieves all Selection Sets.
o SetCurrent(CATISelectionSet*): Current Selection Set management.

Methods

o BeginFindOwningSets

public virtual BeginFindOwningSets(

)

Starts a transaction with several FindOwningSets calls.
Role: If several calls are needed, call first this method and the after so that the treatment will be optimized (data structure loaded in memory). Do not forget to call to clean memory.

Returns:

The error code of function :

S_OK if the method succeeded
E_FAIL if a problem occurred

o CreateSelectionSet

public virtual CreateSelectionSet(	const	`iName`,
		`oNewSet`)

Creates a new Selection Set.
Role: This method creates a new Selection Set.

Parameters:

iName: The name of Selection Set to create.
oNewSet: The created Selection Set.

Returns:

The error code of function.

S_OK if the Selection Set is created
E_FAIL if a problem occurred

o DeleteSelectionSet

public virtual DeleteSelectionSet(		`ioSelectionSetToDelete`,
		`oNLSErrorMessage`)

Removes a Selection Set.
Role: This method removes a Selection Set and all it contents.

Parameters:

ioSelectionSetToDelete: The Selection Set to delete. The inout argument is set to NULL.
oNLSErrorMessage: The error message if E_FAIL

Returns:

The error code of function :

S_OK if the method succeeded
E_FAIL if a problem occurred

o EndFindOwningSets

public virtual EndFindOwningSets(

)

Ends a transaction with several FindOwningSets calls.
Role: If several calls are needed, call first method and this method after so that the treatment will be optimized (data structure loaded in memory).

Returns:

The error code of function :

S_OK if the method succeeded
E_FAIL if a problem occurred

o FindOwningSets

public virtual FindOwningSets(		`iPath`,
	const	`iMode`,
		`oOwningSetsList`)

Finds all the Selection Sets that contain the searched element.
Role: If several calls to this method are needed, call first the method and the after so that the treatment will be optimized (data structure loaded in memory).

Parameters:

iPath: The path of the selected element
iMode: The find mode.
oOwningSetsList: The list of Sets to which the input element belongs

Returns:

The error code of function :

S_OK if the input element belongs to at least one Set
S_FALSE if no Sets were found (in this case, the output list is reset to NULL)
E_FAIL if a problem occurred

o FindSelectionSets

public virtual FindSelectionSets(	const	`iName`,
	const	`iMode`,
		`oSetList`)

Retrieves the list of Selection Sets from his name.
Role: Retrieves the list of Selection Sets from his name.

Parameters:

iName: The name of Selection Set to retrieve.
iMode: The find mode.
oSetList: The list of retrieved Selection Sets.

Returns:

The error code of function.

S_OK if found
S_FALSE if no Set is found
E_FAIL if a problem occurred

o GetCurrent

public virtual GetCurrent( oCurrentSelectionSet)

Current Selection Set management.
Role: Retrieves the current Set. The result can be NULL if the Set has been deleted.

Parameters:

oCurrentSelectionSetToDelete: The current Selection Set.

Returns:

The error code of function :

S_OK if the method succeeded
E_FAIL if a problem occurred

o ListSelectionSets

public virtual ListSelectionSets(	const	`iMode`,
		`oSetList`)

Retrieves all Selection Sets.
Role: This method lists all Selection Sets.

Parameters:

iMode: The list mode.
oSetList: The list of retrieved Selection Sets

Returns:

The error code of function.

S_OK if found
S_FALSE if no Set is found
E_FAIL if a problem occurred

o SetCurrent

public virtual SetCurrent( iCurrentSelectionSet)

Current Selection Set management.
Role: To set the current Selection Set.

Parameters:

iSelectionSet: The current SelectionSet

Returns:

The error code of function :

S_OK if the method succeeded
E_FAIL if a problem occurred

This object is included in the file: CATISelectionSetsFactory.h
If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces