Functional Tolerancing & Annotations Methods

This page describes the various methods specific to the app.

This page discusses:

CATTPSBasicDim.GetRepresentationStrings()

Signature

CATTPSBasicDim.GetRepresentationStrings(ListOfRepStringsValueOutput : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
ListOfRepStringsValueOutput Out List -

ReturnType

Boolean

Example

      

CATTPSCoordDim.GetRepresentationStrings()

Signature

CATTPSCoordDim.GetRepresentationStrings(ListOfRepStringsValueOutput : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
ListOfRepStringsValueOutput Out List -

ReturnType

Boolean

Example

      

CATTPSFlagNote.GetRepresentationStrings()

Signature

CATTPSFlagNote.GetRepresentationStrings(ListOfRepStringsValueOutput : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
ListOfRepStringsValueOutput Out List -

ReturnType

Boolean

Example

      

CATTPSNoa.GetRepresentationStrings()

Signature

CATTPSNoa.GetRepresentationStrings(ListOfRepStringsValueOutput : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
ListOfRepStringsValueOutput Out List -

ReturnType

Boolean

Example

      

CATTPSReferenceFrame.GetRepresentationStrings()

Signature

CATTPSReferenceFrame.GetRepresentationStrings(ListOfRepStringsValueOutput : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
ListOfRepStringsValueOutput Out List -

ReturnType

Boolean

Example

      

CATTPSRoughness.GetRepresentationStrings()

Signature

CATTPSRoughness.GetRepresentationStrings(ListOfRepStringsValueOutput : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
ListOfRepStringsValueOutput Out List -

ReturnType

Boolean

Example

      

CATTPSSet.ApplyViewReUseWhenCopySetTo()

CATTPSSet.ApplyViewReUseWhenCopySetTo()

Signature

CATTPSSet.ApplyViewReUseWhenCopySetTo() : Boolean

ReturnType

Boolean

CATTPSSet.RepairDeleteInvalidFTAFeatures()

Repairs and deletes invalid FTA features.

This operation is performed on all the FTA features contained in an annotation set.

Signature

CATTPSSet.RepairDeleteInvalidFTAFeatures(RepairDeleteOption : Integer) : Boolean

Arguments

Name Input/Output Required? Type Comment
RepairDeleteOption In Integer Possible values are -

2 - To repair User Surface features, which have at least one connected Geometric Component feature.

4 - To repair Group of Surfaces features, which have at least two valid components.

8 - To delete invalid FTA features, which have all their geometrical links broken.

16 - To delete invalid FTA features, which have at least one geometrical link broken.

32 - To delete all invalid FTA features.

ReturnType

Boolean

Example

// Get the annotation set to clean
Let TPSSet (CATTPSSet)

// Assign the clean-up option as a compound value of possible facet.
// For instance, to repair User Surface with 1 valid component at least (2),
// and complement this previous run with removal of FTA Feature having at
// least one broken geometrical link (16), express the option as the sum of
// 2 + 16 = 18.
Let RepairOrDeleteOption( Integer )
RepairOrDeleteOption = 18

// Invoke the clean-up handling
if ( TPSSet.RepairDeleteInvalidFTAFeatures( RepairOrDeleteOption ))
{
	// Error handling
	...
}

// Notice that applying 1 as option value allows to run the method without
// impacting the annotation set; this could be useful in loop treatment
// to let one set free of any change

CATTPSText.GetRepresentationStrings()

Signature

CATTPSText.GetRepresentationStrings(ListOfRepStringsValueOutput : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
ListOfRepStringsValueOutput Out List -

ReturnType

Boolean

Example

      

CATTPSUndefinedEdgeSymbol.GetRepresentationStrings()

Signature

CATTPSUndefinedEdgeSymbol.GetRepresentationStrings(ListOfRepStringsValueOutput : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
ListOfRepStringsValueOutput Out List -

ReturnType

Boolean

Example

      

CATTPSView.AddPlaneAssociativity()

CATTPSView.AddPlaneAssociativity()

Signature

CATTPSView.AddPlaneAssociativity(SupportPln: Plane) : Integer

Arguments

Name Input/Output Required? Type Comment
SupportPln In Plane -

ReturnType

Integer

CATTPSViewText.GetRepresentationStrings()

Signature

CATTPSViewText.GetRepresentationStrings(ListOfRepStringsValueOutput : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
ListOfRepStringsValueOutput Out List -

ReturnType

Boolean

Example

      

CATTPSWeld.GetRepresentationStrings()

Signature

CATTPSWeld.GetRepresentationStrings(ListOfRepStringsValueOutput : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
ListOfRepStringsValueOutput Out List -

ReturnType

Boolean

Example

      

TPSDatumAnnot.GetRepresentationStrings()

Signature

TPSDatumAnnot.GetRepresentationStrings(ListOfRepStringsValueOutput : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
ListOfRepStringsValueOutput Out List -

ReturnType

Boolean

Example

      

TPSDimensionAnnot.GetRepresentationStrings()

Signature

TPSDimensionAnnot.GetRepresentationStrings(ListOfRepStringsValueOutput : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
ListOfRepStringsValueOutput Out List -

ReturnType

Boolean

Example

      

TPSGeometricalAnnot.GetRepresentationStrings()

Signature

TPSGeometricalAnnot.GetRepresentationStrings(ListOfRepStringsValueOutput : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
ListOfRepStringsValueOutput Out List -

ReturnType

Boolean

Example

      

CATTPSAllAnnotations.GetNbrOfGeometricalComponent()

Gets the number of geometrical components.

This call returns the number of geometrical components employed by the annotation.

When one geometrical component is involved several times to point out underlying geometry, this call sends back the sum of each individual object (one geometrical component being used twice with the annotation is counted as one).

This result determines the legal range of variation of the index to pass to the related calls, GetGeometricalComponentName, and SetGeometricalComponentName.

Signature

CATTPSAllAnnotations.GetNbrOfGeometricalComponent(ListOfRepStringsValueOutput : List) : Boolean

ReturnType

Boolean

Example

// Considered annotation
Let Annot (CATTPSAllAnnotations)

// Read the total number of different geometrical components
if ( Annot.GetNbrOfGeometricalComponent( ) <= -1 )
{
	// Error handling
	...
}

// Script can continue using a range of index between 1 to Annot.GetNbrOfGeometricalComponent
... 

CATTPSAllAnnotations.GetGeometricalComponentName()

Gets the geometrical component name at given index.

Signature

CATTPSAllAnnotations.GetGeometricalComponentName(Index : Integer, GeometricalComponentName : String)

Arguments

Name Input/Output Required? Type Comment
Index In Integer The index of the geometrical component. This value is greater than or equal to 1 and lower than or equal to the value returned by GetNbrOfGeometricalComponent.
GeometricalComponentName Out String The characters string constituting the name of the geometrical component.

ReturnType

Boolean

Example

// Considered annotation
Let Annot (CATTPSAllAnnotations)

// Retrieve the number of geometrical components
Let NbrOfGeometricalCmp(Integer)
NbrOfGeometricalCmp = Annot.GetNbrOfGeometricalComponent( )

// Error management
if ( NbrOfGeometricalCmp <= -1 )
{
	// Error handling
	...
}

// Following lines are showing how to dump geometrical component names
Let GeometricalComponentName (String)
Trace(1,\"_ List of the geometrical component(s) for annotation: #\", Annot.Name )
for Index = 1 while Index <= NbrOfGeometricalCmp
{
  if ( Annot.GetGeometricalComponentName( Index, GeometricalComponentName ) <> true )
  {
	 // Error handling
	 ...
  }
  else
  {
	Trace(2,\"Name of geometrical component at index # is:\", Index, GeometricalComponentName )
  }
}

CATTPSAllAnnotations.SetGeometricalComponentName()

Specifies the geometrical component name at given index.

It renames the geometrical component using the provided characters string.

The system retrieves the geometrical component using the index whose legal value is comprised between 1 and N, N being the maximum bound for the range of indexes and corresponds to the outcome of call to GetNbrOfGeometricalComponent.

During this processing, an optional confirm about the applied naming uniqueness can be triggered.

The automatic renaming is yet another possibility when you specify a null index.

On error, the renaming processing stops without any change. This happens when an already existing name is passed to this method or when automatic processing faces naming ambiguity.

Signature

CATTPSAllAnnotations.SetGeometricalComponentName(Index : Integer, NewName String, CheckNameUnicityOption: Boolean) : Boolean

Arguments

Name Input/Output Required? Type Comment
Index In Integer The index of the geometrical component; this value is greater or equal to 1 and lower or equal to the value returned by GetNbrOfGeometricalComponent. The user is allowed to pass a 0 value as index; in this case, an automatic renaming is triggered. If so, the usual path of a geometrical component (for example Face/Name of the feature/Body.1) is used to extract the logical name to apply name of the feature.

In case of automatic renaming, the full scope of the geometrical components under the annotation is tackled. That is, any previous renaming is possibly overwritten.

NewName In Optional String The string used to rename the geometrical component.
CheckNameUnicityOption In Optional Boolean When specify to TRUE, this option triggers an additional verification during renaming to guarantee that the entire set of the geometrical components in the representation has a different name.

ReturnType

Boolean

Example

// Considered annotation
Let Annot (CATTPSAllAnnotations)

// Differenciate automatic renaming from individual renaming
Let AutomaticMode (Boolean)
...

// Renaming processing
if ( AutomaticMode == false )
{
  // Arguments preparation.
  // Retrieve the number of geometrical components
  Let NbrOfGeometricalCmp(Integer)
  NbrOfGeometricalCmp = Annot.GetNbrOfGeometricalComponent( )

  // Error management for this scenario (1st item renaming)
  if ( NbrOfGeometricalCmp < 1 )
  {
	 // Error handling
	 ...
  }

  // Apply renaming of the first component
  Let GeomComponentNewName (String)
  GeomComponentNewName = \"New name For First Geometrical Component\"

  // Let's run this processing without name uniqueness checking
  // Beneath to the last argument being optional in signature specification, this call only uses 2 formal inputs
  if ( Annot.SetGeometricalComponentName( 1, GeomComponentNewName ) <> true )
  {
	 // Error handling
	 ...
  }
}
else
{
  // Let's run into the automatic renaming with uniqueness checking
  // In this case the second argument to specify the new name is useless
  if ( Annot.SetGeometricalComponentName( 0, \"\", true ) <> true )
  {
	 // Error handling
	 ...
  }
}