All Frameworks Class Hierarchy This Framework Previous Next Indexes
System.IUnknown | +---CATITPSReferenceFrame
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATITPSReferenceFrame
Interface designed to manage reference frame associated to a TPS.
Reference frame is composed of three boxes.
Reference Frame / _____|_____ / \ --------------------- | | |Box|Box|Box| | | | 1 | 2 | 3 | --------------------- Reference Frame must be defined with the SetFrame method that returns a semantic diagnostic on the input frame. When not in a definition context, this diagnostic on frame is included in global diagnostic returned by CATITPSSemanticValidity::Check() method.
Method Index
- o GetAllDatumsSimple(CATITPSList**)
- Retrieves all datums simple used in Reference Frame.
- o GetFrame(wchar_t**,wchar_t**,wchar_t**)
- Retrieves Frame of the TPS.
- o SetFrame(wchar_t*,wchar_t*,wchar_t*,wchar_t**)
- Set Frame of the TPS.
Methods
o GetAllDatumsSimple
public virtual HRESULT GetAllDatumsSimple( CATITPSList** oDatums) const = 0
- Retrieves all datums simple used in Reference Frame.
- Parameters:
- oDatums
- All objects of the collection adhere to CATITPSDatumSimple.
o GetFrame
public virtual HRESULT GetFrame( wchar_t** oFirstBox, wchar_t** oSecondBox, wchar_t** oThirdBox) const = 0
- Retrieves Frame of the TPS.
- Parameters:
- oFirstBox
- oSecondBox
- oThirdBox
- Texts in first, second and third boxes.
o SetFrame
public virtual HRESULT SetFrame( const wchar_t* iFirstBox, const wchar_t* iSecondBox, const wchar_t* iThirdBox, wchar_t** oDiagnostic) = 0
- Set Frame of the TPS. Frame is defined by a string in each box.
- Parameters:
- iFirstBox
- iSecondBox
- iThirdBox
- Texts in first, second and third boxes.
- oDiagnostic
- Message that contains semantic diagnostic on Reference Frame. It is composed of [0...n] NLS Keys separated by blank. oDiagnostic must be deleted after use.
This object is included in the file: CATITPSReferenceFrame.h
Copyright © 2003, Dassault Systèmes. All rights reserved.