ElecFlatteningItf Interface CATIEhfFlatteningParameters
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIEhfFlatteningParameters
This Interface allows you to access attributes of the Flattening Parameters
used in " Electrical Harness Flattening " WorkBench.
Method Index
- o
GetAlgorithmMode(CATString&)
-
- o
GetAngleMode(CATString&)
- Retrieves the angle mode.
- o
GetApplyReductionFactorToWholeBNS(CATBoolean&)
- Retrieves if the reduction factor is applied to the whole bundle segment (used only in case the bundle segments are scaled proportionally).
- o
GetApplyScaling(CATBoolean&)
- Retrieves if the scaling is applied during the flattening step.
- o
GetBNSTypeScaledDuringSync(CATString&)
- Retrieves the type of bundle segments scaled during the synchronization step.
- o
GetDeviceOrientation(CATString&)
- Retrieves the device orientation during the flattening step.
- o
GetExtractOnlySupportsInsideGBN(CATBoolean&)
- Retrieves if only the supports inside the geometrical bundle are extracted.
- o
GetFixedLength(CATICkeInst*&)
- Retrieves the fixed length, if the bundle segment is longer than the fixed length then it will be reduced to equal the fixed length.
- o
GetLimitedLength(CATICkeInst*&)
- Retrieves the limited length under which the scaling is not applied.
- o
GetMinAngleBetweenBranches(CATICkeInst*&)
- Retrieves the minimum angle between two branches.
- o
GetMinNumberOfBNSToApplyScaling(int&)
- Retrieves the minimum number of bundle segments required in the harness to apply the scaling.
- o
GetMoveIntermediatePtDuringSync(CATBoolean&)
- Retrieves if the intermediate points are moved during the synchronization step.
- o
GetName(CATUnicodeString&)
- Retrieves the name of the flattening parameters.
- o
GetPlane(CATMathPlane&)
- Retrieves the active plane stored inside the flattening parameters.
- o
GetReductionFactor(double&)
- Retrieves the reduction factor (used only in case the bundle segments are scaled proportionally).
- o
GetScaleBNSProportionally(CATBoolean&)
- Retrieves if the bundle segments are scaled Proportionally.
- o
GetSupportOrientation(CATString&)
- Retrieves the support orientation during the flattening step.
- o
SetAlgorithmMode(CATString*)
-
- o
SetAngleMode(CATString*)
- Sets the angle mode.
- o
SetApplyReductionFactorToWholeBNS(CATBoolean*)
- The reduction factor is applied to the whole bundle segment (used only in case the bundle segments are scaled proportionally).
- o
SetApplyScaling(CATBoolean*)
- Applies the scaling during the flattening step.
- o
SetBNSTypeScaledDuringSync(CATString*)
- Sets the type of bundle segments scaled during the synchronization step.
- o
SetDeviceOrientation(CATString*)
- Sets the device orientation during the flattening step.
- o
SetExtractOnlySupportsInsideGBN(CATBoolean*)
- Allows to extract only the supports inside the geometrical bundle.
- o
SetFixedLength(CATICkeInst*)
- Sets the fixed length,if the bundle segment is longer than the fixed length then it will be reduced to equal the fixed length.
- o
SetLimitedLength(CATICkeInst*)
- Sets the limited length under which the scaling is not applied.
- o
SetMinAngleBetweenBranches(CATICkeInst*)
- Sets the minimum angle between two branches.
- o
SetMinNumberOfBNSToApplyScaling(int)
- Sets the minimum number of bundle segments required in the harness to apply the scaling.
- o
SetMoveIntermediatePtDuringSync(CATBoolean*)
- Moves the intermediate points during the synchronization step.
- o
SetName(CATUnicodeString*)
- Sets the name of the flattening parameters.
- o
SetPlane(CATBaseUnknown*)
- Sets the active plane stored inside the flattening parameters.
- o
SetReductionFactor(double&)
- Sets the reduction factor (used only in case the bundle segments are scaled proportionally).
- o
SetScaleBNSProportionally(CATBoolean*)
- Scales bundle segments proportionally.
- o
SetSupportOrientation(CATString*)
- Sets the support orientation during the flattening step.
Methods
o GetAlgorithmMode
| public virtual GetAlgorithmMode( | | oAlgoMode) |
-
- Deprecated:
- R2015x The usage of this method is needless because "Coarse" is the only output it returns.
It was earlier used to retrieve the algorithm mode in the Flattening Parameters.
Now that fine mode flattening algorithm is removed, the only output is "Coarse".
- Parameters:
-
- oAlgoMode
- Returns the default algorithm mode i.e. Coarse.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- Default algorithm mode i.e. "Coarse" returned
- E_FAIL
- An error occurred in run-time
o GetAngleMode
| public virtual GetAngleMode( | | oAngleMode) |
-
Retrieves the angle mode.
This mode is used to determine the angle mode i.e Standard or Regular.
- Parameters:
-
- oAngleMode
- Retrieves the type of angle mode
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetApplyReductionFactorToWholeBNS
| public virtual GetApplyReductionFactorToWholeBNS( | | oReductionFactorAppliedToWholeBNS) |
-
Retrieves if the reduction factor is applied to the whole bundle segment (used only in case the bundle segments are scaled proportionally).
- Parameters:
-
- oReductionFactorAppliedToWholeBNS
- Retrieves whether reduction factor is to be applied to the whole bundle segment
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetApplyScaling
| public virtual GetApplyScaling( | | oScalingApplied) |
-
Retrieves if the scaling is applied during the flattening step.
- Parameters:
-
- oScalingApplied
- Retrieves whether to apply scaling
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetBNSTypeScaledDuringSync
| public virtual GetBNSTypeScaledDuringSync( | | oBNSType) |
-
Retrieves the type of bundle segments scaled during the synchronization step.
- Parameters:
-
- oBNSType
- Retrieves the type of BNS scaled during the synchronization step
Legal values:
- None
- No bundle segment to be put in scale
- IntermediateSegments
- Only intermediate bundle segments to be put in scale
- AllSegments
- All bundle segments to be put in scale
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetDeviceOrientation
| public virtual GetDeviceOrientation( | | oDeviceOrientation) |
-
Retrieves the device orientation during the flattening step.
- Parameters:
-
- oDeviceOrientation
- Retrieves the type of device orientation
Legal values:
- Without_Orientation
- With no device orientation
- In_Active_Plane
- Device placed in active plane
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetExtractOnlySupportsInsideGBN
| public virtual GetExtractOnlySupportsInsideGBN( | | oOnlySupportsInsideGBNExtracted) |
-
Retrieves if only the supports inside the geometrical bundle are extracted.
- Parameters:
-
- oOnlySupportsInsideGBNExtracted
- Retrieves whether to extract supports which are only inside GBN
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetFixedLength
| public virtual GetFixedLength( | | opICkeInstFixedLength) |
-
Retrieves the fixed length, if the bundle segment is longer than the fixed length then it will be reduced to equal the fixed length.
- Parameters:
-
- opICkeInstFixedLength
- Retrieves the fixed length of the bundle segment. User has the responsibility to release the output pointer.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetLimitedLength
| public virtual GetLimitedLength( | | opICkeInstLimitedLength) |
-
Retrieves the limited length under which the scaling is not applied.
- Parameters:
-
- opICkeInstLimitedLength
- Retrieves the value that sets the limited length. User has the responsibility to release the output pointer.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetMinAngleBetweenBranches
| public virtual GetMinAngleBetweenBranches( | | opICkeInstMinAngle) |
-
Retrieves the minimum angle between two branches.
- Parameters:
-
- opICkeInstMinAngle
- Retrieves the minimum value of angle between two branches. User has the responsibility to release the output pointer.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetMinNumberOfBNSToApplyScaling
| public virtual GetMinNumberOfBNSToApplyScaling( | | oMinNumberOfBNS) |
-
Retrieves the minimum number of bundle segments required in the harness to apply the scaling.
- Parameters:
-
- oMinNumberOfBNS
- Retrieves the value of minimum number of BNS required to apply the scaling
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetMoveIntermediatePtDuringSync
| public virtual GetMoveIntermediatePtDuringSync( | | oMoveIntermediatePt) |
-
Retrieves if the intermediate points are moved during the synchronization step.
- Parameters:
-
- oMoveIntermediatePt
- Retrieves whether the intermediate points are to be moved
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetName
| public virtual GetName( | | oName) |
-
Retrieves the name of the flattening parameters.
- Parameters:
-
- oName
- Retrieves the name of the flattening parameters
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetPlane
| public virtual GetPlane( | | oActivePlane) |
-
Retrieves the active plane stored inside the flattening parameters.
This active plane is used during the flatten, rotate and roll operations.
- Parameters:
-
- oActivePlane
- Retrieves the active plane
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetReductionFactor
| public virtual GetReductionFactor( | | oReductionFactor) |
-
Retrieves the reduction factor (used only in case the bundle segments are scaled proportionally).
- Parameters:
-
- oReductionFactor
- Retrieves the value that defines the reduction factor
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetScaleBNSProportionally
| public virtual GetScaleBNSProportionally( | | oBNSScaledProportionally) |
-
Retrieves if the bundle segments are scaled Proportionally.
- Parameters:
-
- oBNSScaledProportionally
- Retrieves whether to scale bundle segments proportionally
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetSupportOrientation
| public virtual GetSupportOrientation( | | oSupportOrientation) |
-
Retrieves the support orientation during the flattening step.
- Parameters:
-
- oSupportOrientation
- Retrieves the type of support orientation
Legal values:
- Without_Orientation
- With no support orientation
- In_Active_Plane
- Support placed in active plane
- Regular_angle
- Support placed according to regular angles
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o SetAlgorithmMode
| public virtual SetAlgorithmMode( | | ipAlgoMode) |
-
- Deprecated:
- R2015x Since Coarse mode is the only flattening algorithm available and it is set by default, the usage of this method is unnecessary.
This was earlier used to set the algorithm mode.
Now the only legal input for this method is "Course".
- Parameters:
-
- ipAlgoMode
- Defines the type of algorithm mode
Legal values:
- Coarse
- Coarse mode.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
- E_INVALIDARG
- Invalid input attribute value
o SetAngleMode
| public virtual SetAngleMode( | | ipAngleMode) |
-
Sets the angle mode.
This angle mode is used to determine the mode i.e Standard or Regular.
- Parameters:
-
- ipAngleMode
- Defines the type of angle mode
Legal values:
- Standard
- Standard mode.
- Regular
- Regular mode.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
- E_INVALIDARG
- Invalid input attribute value
o SetApplyReductionFactorToWholeBNS
| public virtual SetApplyReductionFactorToWholeBNS( | | ipReductionFactorAppliedToWholeBNS) |
-
The reduction factor is applied to the whole bundle segment (used only in case the bundle segments are scaled proportionally).
- Parameters:
-
- ipReductionFactorAppliedToWholeBNS
- Defines whether reduction factor is to be applied to the whole bundle segment
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
- E_INVALIDARG
- Invalid input attribute value
o SetApplyScaling
| public virtual SetApplyScaling( | | ipScalingApplied) |
-
Applies the scaling during the flattening step.
- Parameters:
-
- ipScalingApplied
- Defines whether to apply scaling
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
- E_INVALIDARG
- Invalid input attribute value
o SetBNSTypeScaledDuringSync
| public virtual SetBNSTypeScaledDuringSync( | | ipBNSType) |
-
Sets the type of bundle segments scaled during the synchronization step.
- Parameters:
-
- ipBNSType
- Defines the type of BNS scaled during the synchronization step
Legal values:
- None
- No bundle segment to be put in scale
- IntermediateSegments
- Only intermediate bundle segments to be put in scale
- AllSegments
- All bundle segments to be put in scale
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
- E_INVALIDARG
- Invalid input attribute value
o SetDeviceOrientation
| public virtual SetDeviceOrientation( | | ipDeviceOrientation) |
-
Sets the device orientation during the flattening step.
- Parameters:
-
- ipDeviceOrientation
- Defines the type of device orientation
Legal values:
- Without_Orientation
- With no device orientation
- In_Active_Plane
- Device placed in active plane
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
- E_INVALIDARG
- Invalid input attribute value
o SetExtractOnlySupportsInsideGBN
| public virtual SetExtractOnlySupportsInsideGBN( | | ipOnlySupportsInsideGBNExtracted) |
-
Allows to extract only the supports inside the geometrical bundle.
- Parameters:
-
- ipOnlySupportsInsideGBNExtracted
- Defines whether to extract supports which are only inside GBN
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
- E_INVALIDARG
- Invalid input attribute value
o SetFixedLength
| public virtual SetFixedLength( | | ipICkeInstFixedLength) |
-
Sets the fixed length,if the bundle segment is longer than the fixed length then it will be reduced to equal the fixed length.
- Parameters:
-
- ipICkeInstFixedLength
- Defines the fixed length of the bundle segment
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
o SetLimitedLength
| public virtual SetLimitedLength( | | ipICkeInstLimitedLength) |
-
Sets the limited length under which the scaling is not applied.
- Parameters:
-
- ipICkeInstLimitedLength
- Defines value that sets the limited length
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
o SetMinAngleBetweenBranches
| public virtual SetMinAngleBetweenBranches( | | ipICkeInstMinAngle) |
-
Sets the minimum angle between two branches.
- Parameters:
-
- ipICkeInstMinAngle
- Defines the minimum value of angle between two branches
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
o SetMinNumberOfBNSToApplyScaling
| public virtual SetMinNumberOfBNSToApplyScaling( | | iMinNumberOfBNS) |
-
Sets the minimum number of bundle segments required in the harness to apply the scaling.
- Parameters:
-
- iMinNumberOfBNS
- Defines the value of minimum number of BNS required to apply the scaling.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
- E_INVALIDARG
- Invalid input attribute value
o SetMoveIntermediatePtDuringSync
| public virtual SetMoveIntermediatePtDuringSync( | | ipMoveIntermediatePt) |
-
Moves the intermediate points during the synchronization step.
- Parameters:
-
- ipMoveIntermediatePt
- Defines whether the intermediate points are to be moved
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
- E_INVALIDARG
- Invalid input attribute value
o SetName
| public virtual SetName( | | ipName) |
-
Sets the name of the flattening parameters.
- Parameters:
-
- ipName
- Defines the name of the flattening parameters
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
o SetPlane
| public virtual SetPlane( | | ipIUnkActivePlane) |
-
Sets the active plane stored inside the flattening parameters.
This active plane is used during the flatten, rotate and roll operations.
- Parameters:
-
- ipActivePlane
- Defines the active plane
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
o SetReductionFactor
| public virtual SetReductionFactor( | const | iReductionFactor) |
-
Sets the reduction factor (used only in case the bundle segments are scaled proportionally).
- Parameters:
-
- iReductionFactor
- Defines value that sets the reduction factor. It should be between 0.0 and 1.0
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
- E_INVALIDARG
- Invalid input attribute value
o SetScaleBNSProportionally
| public virtual SetScaleBNSProportionally( | | ipBNSScaledProportionally) |
-
Scales bundle segments proportionally.
- Parameters:
-
- ipBNSScaledProportionally
- Defines whether to scale bundle segments proportionally
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
- E_INVALIDARG
- Invalid input attribute value
o SetSupportOrientation
| public virtual SetSupportOrientation( | | ipSupportOrientation) |
-
Sets the support orientation during the flattening step.
- Parameters:
-
- ipSupportOrientation
- Defines the type of support orientation
Legal values:
- Without_Orientation
- With no support orientation
- In_Active_Plane
- Support placed in active plane
- Regular_angle
- Support placed according to regular angles
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute value is successfully set
- E_FAIL
- An error occurred while setting the attribute value
- E_INVALIDARG
- Invalid input attribute value
This object is included in the file: CATIEhfFlatteningParameters.h
If needed, your Imakefile.mk should include the module: CATEhfInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.