All Frameworks Class Hierarchy This Framework Indexes Previous Next

MachiningOperationExtendItf Interface DELISmgNcGeometryParameter

SystemTS.IUnknown

System.IDispatch

System.CATBaseUnknown

DELISmgNcGeometryParameter

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

interface DELISmgNcGeometryParameter

Interface to manage nc geometry parameters.

Role: This interface offers services for nc geometry parameters.

See also:: DELISmgNcGeometryManager
See also:: DELIMfgGeometryAccess

Method Index

o Add(CATBaseUnknown_var&,int,int): Adds a manufacturing geometry or a nc geometry feature to the parameter.
o Export(CATUnicodeString&): Creates a new nc geometry feature, fill it with the manufacturing geometries of the parameter and add it in the parameter.
o GetGeometricElements(CATLISTP(CATGeometry)&,int,int): Retrieves the geometric elements of the members of the parameter.
o GetNcGeometryFeatures(CATListValCATBaseUnknown_var&): Retrieves nc geometry features of the parameter.
o IsValid(int&,int): Gets the status of the geometric element.
o RemoveAll(int): Removes all the members of the parameter.

Methods

o Add

public virtual HRESULT Add(	const CATBaseUnknown_var&	`iMember`,
	const int	`iNotification`	`= 1`,
	const int	`iVerify`	`= 0`) = 0

Adds a manufacturing geometry or a nc geometry feature to the parameter. If you add a nc geometry feature, all the previously added manufacturing geometries will be removed. To keep them, use CATISmgNcGeometryParameter#Export.

Parameters:

iMember

Manufacturing geometry or nc geometry feature to add

iNotification

Flag to indicate whether a notification is sent.
Legal values:

1 : notification is sent
other value : no notification

iVerify

Flag to indicate whether it is necessary to check if iMember has already been added.
Legal values:

0 : Default value : iMember is added without any verification
other value : Check if iMember has already been added: If not, iMember is added. If yes, iMember is removed

o Export

public virtual HRESULT Export( const CATUnicodeString& iName = "") = 0

Creates a new nc geometry feature, fill it with the manufacturing geometries of the parameter and add it in the parameter.

Parameters:

iName: New nc geometry feature's value

Returns:

HRESULT value fails if the manager already contains nc geometry features

o GetGeometricElements

public virtual HRESULT GetGeometricElements(	CATLISTP(CATGeometry)&	`oGeometricElements`,
	const int	`iAllGeometricElements`	`=0`,
	const int	`iDuplicate`	`=0`) = 0

Retrieves the geometric elements of the members of the parameter.

Parameters:

iAllGeometricElements

Specifies if all geometric elements must be retrieved.
Legal values: The parameter can be

0: Only geometric elements on the visible space are retrieved
1: All geometric elements are retrieved

iDuplicate

Specifies if the geometric elements must be duplicated
Legal values: The parameter can be

0: Geometric elements are duplicated only if necessary (in a product context)
1: Geometric elements are duplicated

oGeometricElements

The geometric elements.

o GetNcGeometryFeatures

public virtual HRESULT GetNcGeometryFeatures( CATListValCATBaseUnknown_var& oNcGeometryFeatures) = 0

Retrieves nc geometry features of the parameter.

Parameters:

oNcGeometryFeatures: List of nc geometry features

o IsValid

public virtual HRESULT IsValid(	int&	`oIsValid`,
	const int	`iIsRequired`	`= 0`) = 0

Gets the status of the geometric element.

Parameters:

oIsValid

Status of the geometry 0 : Required 1 : Valuated 2 : Optional 3 : Not found 4 : Not up to date

iIsRequired

Specifies if the geometric element is mandatory
Legal values: The parameter can be

0: Geometric element is optional
1: Geometric element is mandatory

Returns:

HRESULT value fails if the internal structure is invalid

o RemoveAll

public virtual HRESULT RemoveAll( const int iNotification = 1) = 0

Removes all the members of the parameter.

Parameters:

iNotification

Flag to indicate whether a notification is sent.
Legal values:

1 : notification is sent
other value : no notification

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