CATAnnotationUseItf Interface CATIDftDatumTarget
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDftDatumTarget
Interface for DatumTarget objects.
Method Index
- o
GetDiameter()
-
- o
GetLowText(CATUnicodeString&)
- Get the lower text of Datum Target.
- o
GetSizeSpecifier(SizeSpecifier*)
- Get the presence of a symbol in the upper part of DatumTarget.
- o
GetUpText(CATUnicodeString&)
- Get the upper text of Datum Target.
- o
IsMovable(CATBoolean&)
- Ask if datum target is movable or not
- o
SetDiameter(CATBoolean)
-
- o
SetLowText(CATUnicodeString&)
- Set the lower text of DatumTarget.
- o
SetMovable(CATBoolean)
- Set the Datum Target movable or not
- o
SetSizeSpecifier(SizeSpecifier)
- Set the presence of the diameter or rectangle symbol in the upper part of DatumTarget.
- o
SetUpText(CATUnicodeString&)
- Set the upper text of Datum Target.
Enumerated Type Index
- o
SizeSpecifier
- Defines SizeSpecifier parameter types.
Methods
o GetDiameter
| public virtual GetDiameter( | ) |
-
- Deprecated:
- R210 use
o GetLowText
| public virtual GetLowText( | | oLowText) |
-
Get the lower text of Datum Target.
- Parameters:
-
- oLowText
- [out] The lower text of the Datum Target
- Returns:
-
S_OK lower text has been correctly retrieved
E_UNEXPECTED An unexpected error occured
o GetSizeSpecifier
| public virtual GetSizeSpecifier( | | oSpec) |
-
Get the presence of a symbol in the upper part of DatumTarget.
- Parameters:
-
- iSpec
- [out]
-
- - None : No symbol.
-
- - Diameter : a diameter symbol is set as prefix of upper text.
-
- - Square : a square symbol is set as prefix of upper text.
- Returns:
-
S_OK if the operation succeeded.
E_UNEXPECTED An unexpected error occured
o GetUpText
| public virtual GetUpText( | | oUpText) |
-
Get the upper text of Datum Target.
- Parameters:
-
- oUpText
- [out] The upper text of the Datum Target
- Returns:
-
S_OK upper text has been correctly retrieved
E_UNEXPECTED An unexpected error occured
o IsMovable
| public virtual IsMovable( | | oBool) |
-
Ask if datum target is movable or not
- Parameters:
-
- iBool
- [out]
-
- - FALSE : Not movable
-
- - TRUE : Movable.
- Returns:
-
S_OK if the operation succeeded.
E_FAIL An unexpected error occured
o SetDiameter
| public virtual SetDiameter( | | iHasDiameter) |
-
- Deprecated:
- R210 use
o SetLowText
| public virtual SetLowText( | const | iLowText) |
-
Set the lower text of DatumTarget.
- Parameters:
-
- iLowText
- [in] The lower text of the Datum Target
- Returns:
-
S_OK lower text has been correctly set
E_UNEXPECTED An unexpected error occured
o SetMovable
| public virtual SetMovable( | | iBool) |
-
Set the Datum Target movable or not
- Parameters:
-
- iBool
- [in]
-
- - FALSE : Not movable
-
- - TRUE : Movable.
- Returns:
-
S_OK if the operation succeeded.
E_UNEXPECTED An unexpected error occured
o SetSizeSpecifier
| public virtual SetSizeSpecifier( | | iSpec) |
-
Set the presence of the diameter or rectangle symbol in the upper part of DatumTarget.
- Parameters:
-
- iSpec
- [in]
-
- - None : No symbol.
-
- - Diameter : Add a diameter symbol as prefix of upper text.
-
- - Square : Add a square symbol as prefix of upper text.
- Returns:
-
S_OK if the operation succeeded.
E_UNEXPECTED An unexpected error occured
o SetUpText
| public virtual SetUpText( | const | iUpText) |
-
Set the upper text of Datum Target.
- Parameters:
-
- iUpText
- [in] The upper text of the Datum Target
- Returns:
-
S_OK upper text has been correctly set
E_UNEXPECTED An unexpected error occured
Enumerated Types
o SizeSpecifier
-
enum SizeSpecifier {
NoSymb,
Diameter,
Square
}
Defines SizeSpecifier parameter types.
- Parameters:
-
- None
- no symbol to set as prefix of upper text.
- Diameter
- a diameter symbol is set as prefix of upper text.
- Square
- a square symbol is set as prefix of upper text.
This object is included in the file: CATIDftDatumTarget.h
If needed, your Imakefile.mk should include the module: CATAnnotationUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.