All Frameworks Class Hierarchy This Framework Previous Next Indexes
ElecFlatteningItf Interface CATIEhfFlatteningParameters
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---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&)
- Retrieves the algorithm mode.
- 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
GetKeepTangents(CATBoolean&)
- Retrieves if the existing tangents between bundle segments and connectors are kept during flattening step.
- 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*)
- Sets the algorithm mode.
- 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
SetKeepTangents(CATBoolean*)
- Allows to keep existing tangents between bundle segments and connectors are kept during flattening step.
- 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(CATILinkableObject*)
- 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
-
Retrieves the algorithm mode.
This algorithm mode is used to determine the type of algorithm i.e. Coarse or Fine, to be used during flattening.
- Parameters:
-
- oAlgoMode
- Retrieves the type of agorithm mode
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetAngleMode
-
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 HRESULT GetApplyReductionFactorToWholeBNS( | CATBoolean& | oReductionFactorAppliedToWholeBNS)= 0 |
-
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
-
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
-
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
-
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 HRESULT GetExtractOnlySupportsInsideGBN( | CATBoolean& | oOnlySupportsInsideGBNExtracted)= 0 |
-
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
-
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 GetKeepTangents
-
Retrieves if the existing tangents between bundle segments and connectors are kept during flattening step.
- Parameters:
-
- oTangentKept
- Retrieves whether to keep existing tangents between bundle segments and connectors
- Returns:
- An HRESULT value
Legal values:
- S_OK
- The attribute is successfully retrieved
- E_FAIL
- An error occurred while retrieving the attribute
o GetLimitedLength
-
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
-
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 HRESULT GetMinNumberOfBNSToApplyScaling( | int& | oMinNumberOfBNS)= 0 |
-
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 HRESULT GetMoveIntermediatePtDuringSync( | CATBoolean& | oMoveIntermediatePt)= 0 |
-
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
-
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
-
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 HRESULT GetReductionFactor( | double& | oReductionFactor)= 0 |
-
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
-
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
-
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
-
Sets the algorithm mode.
Algorithm mode used is Coarse or Fine.
- Parameters:
-
- ipAlgoMode
- Defines the type of agorithm mode
Legal values:
- Coarse
- Coarse mode.
- Fine
- Fine 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
-
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 HRESULT SetApplyReductionFactorToWholeBNS( | CATBoolean* | ipReductionFactorAppliedToWholeBNS)= 0 |
-
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
-
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
-
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
-
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 HRESULT SetExtractOnlySupportsInsideGBN( | CATBoolean* | ipOnlySupportsInsideGBNExtracted)= 0 |
-
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
-
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 SetKeepTangents
-
Allows to keep existing tangents between bundle segments and connectors are kept during flattening step.
- Parameters:
-
- ipTangentKept
- Defines whether to keep existing tangents between bundle segments and connectors
- 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 SetLimitedLength
-
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
-
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 HRESULT SetMinNumberOfBNSToApplyScaling( | int | iMinNumberOfBNS)= 0 |
-
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 HRESULT SetMoveIntermediatePtDuringSync( | CATBoolean* | ipMoveIntermediatePt)= 0 |
-
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
-
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
-
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 HRESULT SetReductionFactor( | const double& | iReductionFactor)= 0 |
-
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 HRESULT SetScaleBNSProportionally( | CATBoolean* | ipBNSScaledProportionally)= 0 |
-
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
-
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