CATTPSBaseUseItf Interface CATITPSDatumTarget
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATITPSDatumTarget
Interface for Datum Target TPS (datum entity).
TPS for Technological Product Specifications.
Method Index
- o
GetAreaForm(AreaForm&)
- Gets the form of the target area.
- o
GetCircularAreaSize(double&)
- Gets the size of the circular area.
- o
GetDatum(CATITPSDatumSimple**)
- Retrieves simple datum, the target belongs to.
- o
GetLabel(wchar_t**)
- Retrieves Label.
- o
GetMovableDirectionTTRS(CATITTRS_var&)
- Gets the movable Direction TTRS.
- o
GetRectangularAreaSize(double&,double&)
- Gets the size of the rectangular area.
- o
IsMovable(CATBoolean&)
- Get the Datum Target movable or not
- o
SetAreaForm(AreaForm)
- Sets the form of the target area.
- o
SetCircularAreaSize(double)
- Sets the size of the circular area.
- o
SetLabel(wchar_t*)
- Sets Label.
- o
SetMovable(CATBoolean&)
- Set the Datum Target movable or not
- o
SetMovableDirectionTTRS(CATITTRS_var&)
- Sets the movable Direction TTRS.
- o
SetRectangularAreaSize(double,double)
- Sets the size of the rectangular area.
Enumerated Type Index
- o
AreaForm
- Enum to describe the form of the target area .
Methods
o GetAreaForm
| public virtual GetAreaForm( | | oAreaForm) |
-
Gets the form of the target area.
- Parameters:
-
- oAreaForm
- Form of the target area.
returns S_OK when the value has been correctly retrieved,
o GetCircularAreaSize
| public virtual GetCircularAreaSize( | | oAreaForm) |
-
Gets the size of the circular area.
- Parameters:
-
- oAreaForm
- Size of the Circular target area.
returns S_OK when the value has been correctly retrieved,
returns E_FAIL otherwise.
o GetDatum
| public virtual GetDatum( | | oDatum) |
-
Retrieves simple datum, the target belongs to.
- Parameters:
-
- oDatum
- [out, CATITPSDatumSimple#Release] The Target list.
o GetLabel
| public virtual GetLabel( | | oLabel) |
-
Retrieves Label.
o GetMovableDirectionTTRS
| public virtual GetMovableDirectionTTRS( | | ospDirectionTTRS) |
-
Gets the movable Direction TTRS.
- Parameters:
-
- ospDirectionTTRS
- Movable Direction TTRS
returns S_OK when the TTRS has been correctly retrieved,
returns E_FAIL otherwise.
o GetRectangularAreaSize
| public virtual GetRectangularAreaSize( | | oLength, |
| | oWidth) |
-
Gets the size of the rectangular area.
- Parameters:
-
- oLength
- Length of the Rectangular target area.
- oWidth
- Width of the Rectangular target area.
returns S_OK when the values have been correctly retrieved,
returns E_FAIL otherwise.
o IsMovable
| public virtual IsMovable( | | obMovable) |
-
Get the Datum Target movable or not
- Parameters:
-
- obMovable
- FALSE : Not movable
TRUE : Movable.
returns S_OK when the value has been correctly retrieved,
returns E_FAIL otherwise.
o SetAreaForm
| public virtual SetAreaForm( | const | iAreaForm) |
-
Sets the form of the target area.
- Parameters:
-
- iAreaForm
- Form of the target area.
returns S_OK when the value has been correctly set,
returns E_FAIL otherwise.
o SetCircularAreaSize
| public virtual SetCircularAreaSize( | const | iAreaSize) |
-
Sets the size of the circular area.
- Parameters:
-
- iAreaSize
- Size of the Circular target area.
returns S_OK when the value has been correctly set,
returns E_FAIL otherwise.
o SetLabel
| public virtual SetLabel( | const | iLabel) |
-
Sets Label.
o SetMovable
| public virtual SetMovable( | | ibMovable) |
-
Set the Datum Target movable or not
- Parameters:
-
- ibMovable
- FALSE : Not movable
TRUE : Movable.
returns S_OK when the value has been correctly set,
returns E_FAIL otherwise.
o SetMovableDirectionTTRS
| public virtual SetMovableDirectionTTRS( | const | ispDirectionTTRS) |
-
Sets the movable Direction TTRS.
- Parameters:
-
- ispDirectionTTRS
- Movable Direction TTRS
If the ispDirectionTTRS is NULL_var, the
direction TTRS inside the model is removed.
returns S_OK when the TTRS has been correctly set,
returns E_FAIL otherwise.
o SetRectangularAreaSize
| public virtual SetRectangularAreaSize( | const | iLength, |
| const | iWidth) |
-
Sets the size of the rectangular area.
- Parameters:
-
- iLength
- Length of the Rectangular target area.
- iWidth
- Width of the Rectangular target area.
returns S_OK when the values have been correctly set,
returns E_FAIL otherwise.
Enumerated Types
o AreaForm
-
enum AreaForm {
Point,
Circular,
Rectangular
}
Enum to describe the form of the target area .
- Parameters:
-
- Point
- to show Point in visualization for target area.
- Circular
- to show Circle in visualization for target area.
- Rectangular
- to show Rectangle in visualization for target area.
This object is included in the file: CATITPSDatumTarget.h
If needed, your Imakefile.mk should include the module: CATTPSBaseUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.