AnnotationSet (Object)

Interface for the TPS Set of objects.

Properties


Property ActiveView() As
Gets or Sets Annotation Set ActiveView.
Parameters:
oView
Value of CATIATPSView.
Property AnEmptyAnnotationsList() As (Read Only)
Retrieves an empty Annotations'Collection.
Parameters:
oAnnots
Empty Annotations' Collection.
Property AnnotationFactory() As (Read Only)
Gets the factory to create annotations.
Parameters:
oAFact
Annotations' factory.
Property AnnotationFactory2() As (Read Only)
Gets the factory to create annotations.
Parameters:
oAFact
Annotations' factory.
Property AnnotationSetPupose() As (Read Only)
Gets the annotation Set specifications purpose.
Any existing set is implicitly an Engineering Annotation Set.
Parameters:
oAnnotationSetSpecification
Value indicating purpose of the Annotation Set.
List of legal values:
oAnnotationSetSpecification = "FTA_EngineeringSet",
oAnnotationSetSpecification = "FTA_ManufacturingSet".
Property AnnotationSetType() As (Read Only)
Gets the annotation Set type.
Parameters:
oAnnotationSetType
Value of Set Type.
Property Annotations() As (Read Only)
Retrieves the TPS components of the set.
Parameters:
oAnnots
Collection of returned component.
Property CaptureFactory() As (Read Only)
Gets the factory to create Capture.
Parameters:
opiCapFact
Capture factory.
Property Captures() As (Read Only)
Retrieves all the Captures that belong to the set.
Parameters:
oCaptures
Collection of returned Captures.
Property KindOfSet() As (Read Only)
Gives the kind of set (Part, Product...).
Parameters:
oKindOfSet
It could be : Part Product Product_TP Process_BB Cgr Cgr_TP.
Property Standard() As (Read Only)
Retrieves the Parent Standard defined at set creation.
Parameters:
oStandard
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).
Property SwitchOn() As
Gets or Sets Annotation Set Visualization.
Parameters:
oDisplay
Value of visualisation mode.
Property TPSViewFactory() As (Read Only)
Gets the factory to create TPS Views.
Parameters:
oTPSViewFact
TPS Views' factory.
Property TPSViews() As (Read Only)
Retrieves all the TPSViews that belong to the set.
Parameters:
oViews
Collection of returned views.

Methods


Sub ApplyResultWithLinkWhenCopySetTo()
Register for next call to either GlobalCopySetTo and like methods.
See also:
CATIAAnnotationSet#GlobalCopySetTo or CATIAAnnotationSet, this option is reset at the end of import. When activated, the annotations are copied as result with link annotations.
Example: 
 This example illustrates activation of the 'as result with link' option for the next import (GlobalCopySetTo) run.
 
 Dim myPart As Part
 Set myPart = CATIA.ActiveEditor.ActiveObject
 Dim mySelection As Selection
 Set mySelection = CATIA.ActiveEditor.Selection
 Dim SelectionFilter(0)
 SelectionFilter(0)="AnnotationSet"
 Dim Status As String
 Status = mySelection.SelectElement2(SelectionFilter, "Select an Annotation Set to copy: ", False)
 Dim SelectedEntity As SelectedElement
 Set SelectedEntity = mySelection.Item( 1 )
 Dim SetToReplicate As AnnotationSet
 Set SetToReplicate = SelectedEntity.Value
 SetToReplicate.ApplyResultWithLinkWhenCopySetTo
 SetToReplicate.GlobalCopySetTo(myPart)
Sub ApplyViewReUseWhenCopySetTo()
Register for next call to either GlobalCopySetTo and like methods.
See also:
CATIAAnnotationSet#GlobalCopySetTo or CATIAAnnotationSet, they are placed in existing Views. This call sets an option valid for the next import run only; in other words, this option is reset at the end of import. When activated, this option will not break the import processing; if no View in target set can receive a candidate FTA entity resulting from the import, regular handling is carried on
Func GlobalCopySetTo( iDestinationPart) As
Copies the entire or a subpart of a part level Annotation Set into a destination CATPart
Parameters:
iDestinationPart
destination CATPart.
oMessage
result of datums merge.
Func GlobalCopySetToWithTransformation( iDestinationPart, iTransfo) As
Copies the entire Annotation Set into a destination CATPart
Parameters:
iDestinationPart
destination CATPart.
iTransfo
Optional argument. Transformation matrix to apply to FTA features during copy. The transformation is also used for retrieving in the destination CATPart the geometrical elements the FTA features are rerouted on.
Transformation matrix is composed by a matrix3x3 and a translation vector:
[[a11 a12 a13
a21 a22 a23
a31 a32 a33]
[u1 u2 u3]]

a11 is in iTransfo(0)
a12 is in iTransfo(1)
a13 is in iTransfo(2)
a21 is in iTransfo(3)
a22 is in iTransfo(4)
a23 is in iTransfo(5)
a31 is in iTransfo(6)
a32 is in iTransfo(7)
a33 is in iTransfo(8)
u1 is in iTransfo(9)
u2 is in iTransfo(10)
u3 is in iTransfo(11)
oMessage
result of datums merge.
Func ReadISODefaultProperties( oISODefaults) As
Retrieves the ISO 14405 and ISO 1101 default specifications. This method is not relevant in case of ASME Standard.
Parameters:
oISODefaults
Array of ISO default defined onto the annotation set. Composition of the array may looks like the following schema
[ Linear size ISO 14405 property
Angular size ISO 14405 property
Default specification elements for form association property
Default specification elements for toleranced feature filtering property ]
When oCount is not null, minimal size of oISODefaults "vector" of string is 3 (the 3 first strings are always existing); depending on GDT toleranced feature filtering options activated on the annotation set, oCount may reach the limit of 7 (4 more texts).
oCount
Number of lines in returned array of strings. When this procedure is not applicable (either due to wrong Standard, old annotation set), oCount equals 0.