All Frameworks Class Hierarchy This Framework Indexes
SpaceAnalysisInterfaces Interface CATISPAMeasureSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISPAMeasureSettingAtt
Definition of all parameters in Measure Tools.
Method Index
- o
GetBoxDisplayInfo(CATSettingInfo*)
- Retrieves the state of the BoxDisplay parameter.
- o
GetBoxDisplay(int*)
- Retrieves the BoxDisplay attribute.
- o
GetLabelColorInfo(CATSettingInfo*)
- Retrieves the state of the LabelColor parameter.
- o
GetLabelColor(unsigned int*)
- Retrieves the LabelColor attribute.
- o
GetLineWidthInfo(CATSettingInfo*)
- Retrieves the state of the LineWidth parameter.
- o
GetLineWidth(int*)
- Retrieves the LineWidth attribute.
- o
GetPartUpdateStatusInfo(CATSettingInfo*)
- Retrieves the state of the PartUpdateStatus parameter.
- o
GetPartUpdateStatus(int*)
- Retrieves the PartUpdateStatus attribute.
- o
GetProductUpdateStatusInfo(CATSettingInfo*)
- Retrieves the state of the ProductUpdateStatus parameter.
- o
GetProductUpdateStatus(int*)
- Retrieves the ProductUpdateStatus attribute.
- o
GetTextColorInfo(CATSettingInfo*)
- Retrieves the state of the TextColor parameter.
- o
GetTextColor(unsigned int*)
- Retrieves the TextColor attribute.
- o
GetTildeDisplayInfo(CATSettingInfo*)
- Retrieves the state of the TildeDisplay parameter.
- o
GetTildeDisplay(int*)
- Retrieves the TildeDisplay attribute.
- o
SetBoxDisplayLock(unsigned char)
- Locks or unlocks the BoxDisplay parameter.
- o
SetBoxDisplay(int*)
- Sets the BoxDisplay attribute.
- o
SetLabelColorLock(unsigned char)
- Locks or unlocks the LabelColor parameter.
- o
SetLabelColor(unsigned int*)
- Sets the LabelColor attribute.
- o
SetLineWidthLock(unsigned char)
- Locks or unlocks the LineWidth parameter.
- o
SetLineWidth(int*)
- Sets the LineWidth attribute.
- o
SetPartUpdateStatusLock(unsigned char)
- Locks or unlocks the PartUpdateStatus parameter.
- o
SetPartUpdateStatus(int*)
- Sets the PartUpdateStatus attribute.
- o
SetProductUpdateStatusLock(unsigned char)
- Locks or unlocks the ProductUpdateStatus parameter.
- o
SetProductUpdateStatus(int*)
- Sets the ProductUpdateStatus attribute.
- o
SetTextColorLock(unsigned char)
- Locks or unlocks the TextColor parameter.
- o
SetTextColor(unsigned int*)
- Sets the TextColor attribute.
- o
SetTildeDisplayLock(unsigned char)
- Locks or unlocks the TildeDisplay parameter.
- o
SetTildeDisplay(int*)
- Sets the TildeDisplay attribute.
Methods
o GetBoxDisplayInfo
| public virtual GetBoxDisplayInfo( | | oInfo) |
-
Retrieves the state of the BoxDisplay parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBoxDisplay
| public virtual GetBoxDisplay( | | oBoxDisplay) |
-
Retrieves the BoxDisplay attribute.
- Parameters:
-
- ioBoxDisplay
- Legal values:
0 : Measure label background is filled.
1 : Measure label has no background, only borders.
o GetLabelColorInfo
| public virtual GetLabelColorInfo( | | oInfo) |
-
Retrieves the state of the LabelColor parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetLabelColor
| public virtual GetLabelColor( | | oLabelColor) |
-
Retrieves the LabelColor attribute.
- Parameters:
-
- ioLabelColor:
- Legal values:
Array of 3 unsigned int (R,G,B).
o GetLineWidthInfo
| public virtual GetLineWidthInfo( | | oInfo) |
-
Retrieves the state of the LineWidth parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetLineWidth
| public virtual GetLineWidth( | | oLineWidth) |
-
Retrieves the LineWidth attribute.
- Parameters:
-
- ioLineWidth:
- Legal values:
The line weight returned ranges from 1 to 63.
o GetPartUpdateStatusInfo
| public virtual GetPartUpdateStatusInfo( | | oInfo) |
-
Retrieves the state of the PartUpdateStatus parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPartUpdateStatus
| public virtual GetPartUpdateStatus( | | oPartUpdateStatus) |
-
Retrieves the PartUpdateStatus attribute.
- Parameters:
-
- ioPartUpdateStatus
- Legal values:
0 : No automatic update in part.
1 : Automatic update in part.
o GetProductUpdateStatusInfo
| public virtual GetProductUpdateStatusInfo( | | oInfo) |
-
Retrieves the state of the ProductUpdateStatus parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetProductUpdateStatus
| public virtual GetProductUpdateStatus( | | oProductUpdateStatus) |
-
Retrieves the ProductUpdateStatus attribute.
- Parameters:
-
- ioProductUpdateStatus
- Legal values:
0 : No automatic update in product.
1 : Automatic update in product.
o GetTextColorInfo
| public virtual GetTextColorInfo( | | oInfo) |
-
Retrieves the state of the TextColor parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTextColor
| public virtual GetTextColor( | | oTextColor) |
-
Retrieves the TextColor attribute.
- Parameters:
-
- ioTextColor:
- Legal values:
Array of 3 unsigned int (R,G,B).
o GetTildeDisplayInfo
| public virtual GetTildeDisplayInfo( | | oInfo) |
-
Retrieves the state of the TildeDisplay parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTildeDisplay
| public virtual GetTildeDisplay( | | oTildeDisplay) |
-
Retrieves the TildeDisplay attribute.
- Parameters:
-
- ioTildeDisplay
- Legal values:
0 : No tilde displayed for approximate measurement.
1 : Tilde displayed for approximate measurement.
o SetBoxDisplayLock
| public virtual SetBoxDisplayLock( | | iLocked) |
-
Locks or unlocks the BoxDisplay parameter.
Role: Locks or unlocks the BoxDisplay parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBoxDisplay
| public virtual SetBoxDisplay( | | iBoxDisplay) |
-
Sets the BoxDisplay attribute.
- Parameters:
-
- iBoxDisplay
- Legal values:
0 : Measure label background is filled.
1 : Measure label has no background, only borders.
o SetLabelColorLock
| public virtual SetLabelColorLock( | | iLocked) |
-
Locks or unlocks the LabelColor parameter.
Role: Locks or unlocks the LabelColor parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetLabelColor
| public virtual SetLabelColor( | | iLabelColor) |
-
Sets the LabelColor attribute.
- Parameters:
-
- iLabelColor:
- Legal values:
Array of 3 unsigned int (R,G,B).
o SetLineWidthLock
| public virtual SetLineWidthLock( | | iLocked) |
-
Locks or unlocks the LineWidth parameter.
Role: Locks or unlocks the LineWidth parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetLineWidth
| public virtual SetLineWidth( | | iLineWidth) |
-
Sets the LineWidth attribute.
- Parameters:
-
- iLineWidth:
- Legal values:
The line weight returned ranges from 1 to 63.
o SetPartUpdateStatusLock
| public virtual SetPartUpdateStatusLock( | | iLocked) |
-
Locks or unlocks the PartUpdateStatus parameter.
Role: Locks or unlocks the PartUpdateStatus parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPartUpdateStatus
| public virtual SetPartUpdateStatus( | | iPartUpdateStatus) |
-
Sets the PartUpdateStatus attribute.
- Parameters:
-
- iPartUpdateStatus
- Legal values:
0 : No automatic update in part.
1 : Automatic update in part.
o SetProductUpdateStatusLock
| public virtual SetProductUpdateStatusLock( | | iLocked) |
-
Locks or unlocks the ProductUpdateStatus parameter.
Role: Locks or unlocks the ProductUpdateStatus parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetProductUpdateStatus
| public virtual SetProductUpdateStatus( | | iProductUpdateStatus) |
-
Sets the ProductUpdateStatus attribute.
- Parameters:
-
- iProductUpdateStatus
- Legal values:
0 : No automatic update in product.
1 : Automatic update in product.
o SetTextColorLock
| public virtual SetTextColorLock( | | iLocked) |
-
Locks or unlocks the TextColor parameter.
Role: Locks or unlocks the TextColor parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTextColor
| public virtual SetTextColor( | | iTextColor) |
-
Sets the TextColor attribute.
- Parameters:
-
- iTextColor:
- Legal values:
Array of 3 unsigned int (R,G,B).
o SetTildeDisplayLock
| public virtual SetTildeDisplayLock( | | iLocked) |
-
Locks or unlocks the TildeDisplay parameter.
Role: Locks or unlocks the TildeDisplay parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTildeDisplay
| public virtual SetTildeDisplay( | | iTildeDisplay) |
-
Sets the TildeDisplay attribute.
- Parameters:
-
- iTildeDisplay
- Legal values:
0 : No tilde displayed for approximate measurement.
1 : Tilde displayed for approximate measurement.
This object is included in the file: CATISPAMeasureSettingAtt.h
If needed, your Imakefile.mk should include the module: CATSaiSpaceAnalysisItf