All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATTPSInterfaces Interface CATITPSSet
System.IUnknown
|
+---CATITPSSet
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATITPSSet
Interface for the TPS Set of objects.
Method Index
- o
GetActiveView(CATITPSView**)
- Retrieves the active view in the set.
- o
GetCaptures(CATITPSCaptureList**)
- Retrieves all the Captures that belong to the set.
- o
GetGeometries(CATITPSGeometryList**)
- Retrieves the geometrical components of the set.
- o
GetReferenceProduct(CATIProduct**)
- Retrieves the reference product of the set.
- o
GetStandard(wchar_t**)
- Retrieves the Parent Standard defined at set creation.
- o
GetStdName(wchar_t**)
- Retrieves File Name of the standard defined at set creation.
- o
GetTPSs(CATITPSList**)
- Retrieves the TPS components of the set.
- o
GetTTRSs(CATITTRSList**)
- Retrieves the TTRSs involved in the set definition.
- o
GetViews(CATITPSViewList**)
- Retrieves all the TPSViews that belong to the set.
- o
SetActiveView(CATITPSView*)
- Defines the active view in the set.
- o
SetTPSs(CATITPSList*)
- Sets the components of the set.
Methods
o GetActiveView
-
Retrieves the active view in the set. The active view is the view
where annotation are created in priority. There is only one active view
in a set.
- Parameters:
-
- opiActiveView
- Can be NULL when all views in the set have been removed. In that
case E_FAIL is returned.
o GetCaptures
-
Retrieves all the Captures that belong to the set.
- Parameters:
-
- iopiList
- List of returned Captures.
o GetGeometries
-
Retrieves the geometrical components of the set.
- Parameters:
-
- iopiList
- List of returned component.
o GetReferenceProduct
-
Retrieves the reference product of the set.
- Parameters:
-
- opiProd
- Reference product to which this set is associated.
o GetStandard
public virtual HRESULT GetStandard( | wchar_t** | opParentStdName) const = 0 |
-
Retrieves the Parent Standard defined at set creation.
- Parameters:
-
- opParentStdName
- Name of the Parent Standard applied for all TPS in the set.
The Parent Standard is the international standard on which
Standard File is based on. It can only be ISO, ANSI and JIS.
(ANSI stands for ASME).
o GetStdName
public virtual HRESULT GetStdName( | wchar_t** | opFileStdName) const = 0 |
-
Retrieves File Name of the standard defined at set creation.
- Parameters:
-
- opFileStdName
- Name of the Standard File applied for all TPS in the set.
Standard File can be customised, it is based on a Parent Standard.
Its name is different of ISO, ANSI and JIS.
o GetTPSs
-
Retrieves the TPS components of the set.
- Parameters:
-
- iopiList
- List of returned component.
o GetTTRSs
-
Retrieves the TTRSs involved in the set definition.
- Parameters:
-
- opiTTRSList
- List of TTRSs used by this Set of specifications.
o GetViews
-
Retrieves all the TPSViews that belong to the set.
- Parameters:
-
- iopiList
- List of returned views.
o SetActiveView
-
Defines the active view in the set.
- Parameters:
-
- ipiActiveView
- Must be a view that belongs to the set. If not E_FAIL is returned.
o SetTPSs
-
Sets the components of the set.
Replace the existing list by the new one.
- Parameters:
-
- ipiList
- New list of component of set.
This object is included in the file: CATITPSSet.h