All Frameworks Class Hierarchy This Framework Indexes Previous Next

ElecFlatteningItf Interface CATIEhfElectricalDim

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

interface CATIEhfElectricalDim

This Interface CATIEhfElectricalDim allows to manage the Electrical Dimension object.
Interface CATIEhfElectricalDim is implemented on the Electrical Dimension feature and should be used by user.

Method Index

o GetFirstComponent(CATIPrdObject*,CATPathElement*&): Gives the First End Component of the Electrical Dimension feature.
o GetFirstEnd(CATBaseUnknown*&): Gives the FirstEnd of the Electrical Dimension feature.
o GetLength(CATICkeInst*&): Gives the curvilinear distance between the two ends of the electrical dimension.
o GetSecondComponent(CATIPrdObject*,CATPathElement*&): Gives the Second End Component of the Electrical Dimension feature.
o GetSecondEnd(CATBaseUnknown*&): Gives the SecondEnd of the Electrical Dimension feature.
o GetSegmentList(CATIPrdObject*,CATListValCATBaseUnknown_var*&): Retrieve list of dimensioned segments by Electrical Dim Path.
o SetAndLinkLengthToText(CATIDrwSubString*): Sets the param link between electrical dimension length and the text sub string which is a part of customized dimension.

Methods

o GetFirstComponent

public virtual GetFirstComponent(		`ipIPrdRootContext`,
		`opPathElement`)

Gives the First End Component of the Electrical Dimension feature.

Parameters:

ipIPrdRootContext: (Input): Pointer on the "Root" Product of the document.
opPathElement: (Output): First End Component of the Electrical Dimension feature's Path Element , if First End was valuated.
Method returns NULL value if End is Branch Point or Segment Extreimity or no component is present at that end.

Returns:

An HRESULT value
Legal values:

S_OK: First end Component of Electrical Dimension is successfully retrieved
E_FAIL: An error occurred while retrieving the First End Component from Electrical Dim Path.

o GetFirstEnd

public virtual GetFirstEnd( opIFirstEndObject)

Gives the FirstEnd of the Electrical Dimension feature.

Parameters:

opIFirstEndObject: (Output): First End of the Electrical Dimension feature, if it was valuated.

Returns:

An HRESULT value
Legal values:

S_OK: First end of Electrical Dimension is successfully retrieved
E_FAIL: An error occurred while retrieving the Electrical Dim Path.

o GetLength

public virtual GetLength( opICkeInstLength)

Gives the curvilinear distance between the two ends of the electrical dimension.

Parameters:

opICkeInstLength: (Output): CkeInst containing Length between the two electrical dimension ends.

Returns:

An HRESULT value
Legal values:

S_OK: the length is successfully retrieved
E_FAIL: An error occurred while retrieving the length.

o GetSecondComponent

public virtual GetSecondComponent(		`ipIPrdRootContext`,
		`opPathElement`)

Gives the Second End Component of the Electrical Dimension feature.

Parameters:

ipIPrdRootContext: (Input): Pointer on the "Root" Product of the document.
opPathElement: (Output): Second End Component of the Electrical Dimension feature's Path Element , if Second End was valuated.
Method returns NULL value if End is Branch Point or Segment Extreimity or no component is present at that end.

Returns:

An HRESULT value
Legal values:

S_OK: Second end Component of Electrical Dimension is successfully retrieved
E_FAIL: An error occurred while retrieving the Second End Component from Electrical Dim Path.

o GetSecondEnd

public virtual GetSecondEnd( opISecondEndObject)

Gives the SecondEnd of the Electrical Dimension feature.

Parameters:

opISecondEndObject: (Output): Second End of the Electrical Dimension feature, if it was valuated.

Returns:

An HRESULT value
Legal values:

S_OK: Second end of Electrical Dimension is successfully retrieved
E_FAIL: An error occurred while retrieving the Electrical Dim Path.

o GetSegmentList

public virtual GetSegmentList(		`ipIPrdRootContext`,
		`opListSegments`)

Retrieve list of dimensioned segments by Electrical Dim Path.

Parameters:

ipIPrdRootContext: (Input): Pointer on the "Root" Product of the document.
oListSegments: (Output): List of segments covered by dimension.

Returns:

An HRESULT value.
Legal values:

S_OK: no error.
E_FAIL: Error occured while searching covered segments.

o SetAndLinkLengthToText

public virtual SetAndLinkLengthToText( ipIDrwTextString)

Sets the param link between electrical dimension length and the text sub string which is a part of customized dimension.

Parameters:

ipIDrwTextString: (input): ipIDrwTextString :text string which will be linked to point to length of electrical dimension.

Returns:

An HRESULT value
Legal values:

S_OK: the length is successfully set
E_FAIL: An error occurred while setting the length.

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