Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATTPSBaseUseItf Interface 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 GetReferenceContext(IUnknown**): Retrieves the reference context 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 GlobalCopySetTo(CATIMmiUsePrtPart*,CATUnicodeString&,CATUnicodeString*,CATMathTransformation*): Copies the entire or a subpart of a part level Annotation Set into a destination 3DPart.
o GlobalCopySetTo(CATIMmiUsePrtPart*,CATUnicodeString&,CATBaseUnknown_Associations&,CATUnicodeString*,CATMathTransformation*): Copies the entire or a subpart of a part level Annotation Set into a destination 3DPart
o LogicalGlobalCopySetTo(CATIMmiUsePrtPart*,CATListValCATBaseUnknown_var&,CATBoolean&,CATUnicodeString&,CATUnicodeString*): Copies the entire or a subpart of an Annotation Set into a target 3D Shape Representation using a logical reroute.
o RepairDeleteInvalidFTAFeatures(unsigned int): Repair Delete invalid FTA features.
o SetActiveView(CATITPSView*): Defines the active view in the set.
o SetTPSs(CATITPSList*): Sets the components of the set.

Methods

o GetActiveView

public virtual GetActiveView( opiActiveView)

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

public virtual GetCaptures( iopiList)

Retrieves all the Captures that belong to the set.

Parameters:

iopiList: List of returned Captures.

o GetGeometries

public virtual GetGeometries( iopiList)

Retrieves the geometrical components of the set.

Parameters:

iopiList: List of returned component.

o GetReferenceContext

public virtual GetReferenceContext( opiUnknownObj)

Retrieves the reference context of the set.

Parameters:

opiUnknownObj: Representation Reference context to which this set is associated.

o GetStandard

public virtual GetStandard( opParentStdName)

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 GetStdName( opFileStdName)

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

public virtual GetTPSs( iopiList)

Retrieves the TPS components of the set.

Parameters:

iopiList: List of returned component.

o GetTTRSs

public virtual GetTTRSs( opiTTRSList)

Retrieves the TTRSs involved in the set definition.

Parameters:

opiTTRSList: List of TTRSs used by this Set of specifications.

o GetViews

public virtual GetViews( iopiList)

Retrieves all the TPSViews that belong to the set.

Parameters:

iopiList: List of returned views.

o GlobalCopySetTo

public virtual GlobalCopySetTo(	`ipiDestinationPart`,
	`oMessage`,
	`ipCaptureName`	`= NULL`,
	`ipTransfo`	`= NULL`)

Copies the entire or a subpart of a part level Annotation Set into a destination 3DPart.

Parameters:

ipiDestinationPart: Destination 3DPart where the annotation set will be copied. Destination 3DPart has to be different from the origin 3DPart.
oMessage: Result of datums merge. If there is no merge done, the returned message is empty.
ipCaptureName: Optional argument. String used to filter FTA features. The system keeps only the FTA features that belong to the captures FTA that contain the string ipCaptureName. If the ipCaptureName is null, the system keeps all the FTA features (it performs a global copy).
ipTransfo: Optional argument. Transformation matrix to apply to FTA features during copy. The transformation is also used for retrieving in the destination 3DPart the geometrical elements the FTA features are rerouted on.

o GlobalCopySetTo

public virtual GlobalCopySetTo(	`ipiDestinationPart`,
	`oMessage`,
	`ioAssocTableBodiesGeomSet`,
	`ipCaptureName`	`= NULL`,
	`ipTransfo`	`= NULL`)

Copies the entire or a subpart of a part level Annotation Set into a destination 3DPart

Parameters:

ipiDestinationPart: Destination 3DPart where the annotation set will be copied. Destination 3DPart has to be different from the origin 3DPart.
oMessage: Result of datums merge. If there is no merge done, the returned message is empty.
ioAssocTableBodiesGeomSet: Association table used by the system to reconnect FTA Captures to Bodies and GeometricalSets.
ipCaptureName: Optional argument. String used to filter FTA features. The system keeps only the FTA features that belong to the captures FTA that contain the string ipCaptureName. If the ipCaptureName is null, the system keeps all the FTA features (it performs a global copy).
ipTransfo: 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.

o LogicalGlobalCopySetTo

public virtual LogicalGlobalCopySetTo(	`ipiTarget3DSR`,
	`iListOfBodiesAndGeometricalSets`,
	`ibImportOnce`,
	`oMessage`,
	`ipCaptureName`	`= NULL`)

Copies the entire or a subpart of an Annotation Set into a target 3D Shape Representation using a logical reroute.

Parameters:

ipiTarget3DSR: Target 3D Shape Representation where the annotation set will be copied. Target 3D Shape Representation has to be different from the source 3D Shape Representation.
iListOfBodiesAndGeometricalSets: List of bodies and geometrical sets on which the reroute of the FTA features will apply. If this list is empty, the system uses all the bodies and geometrical sets of the ipiTarget3DSR to reroute the copied FTA features.
ibImportOnce: TRUE if the system launches one import which is applied on all bodies and geometrical set of the previous list iListOfBodiesAndGeometricalSets FALSE if the system launches 1 import per body and geometrical set of the previous list iListOfBodiesAndGeometricalSets. In this case the reroute of FTA features is done on the current body or geometrical set.
oMessage: Result of datums merge. If there is no merge done, the returned message is empty.
ipCaptureName: Optional argument. String used to filter FTA features. The system keeps only the FTA features that belong to the captures FTA that contain the string ipCaptureName. If the ipCaptureName is null, the system keeps all the FTA features (it performs a global copy). returns S_OK when the TPSSet is valid and when the Logical global copy SUCCEEDED. returns S_FALSE when the TPSSet is invalid (not yet flagged) returns E_FAIL otherwise.

o RepairDeleteInvalidFTAFeatures

public virtual RepairDeleteInvalidFTAFeatures( OptionsToRepairDelete)

Repair Delete invalid FTA features.

Parameters:

OptionsToRepairDelete: Repair and Delete options. For the available values see RepairDeleteOptionFTAFeatures these options must be combined using the different values of typedef RepairDeleteOptionFTAFeatures. the operations associated to these options must be launch in the order given by the list of RepairDeleteOptionFTAFeatures whatever the order of options given in arguments of this method. The options order given by the list of RepairDeleteOptionFTAFeatures is the same as the order of options into the interactive panel of command “Repair/Delete Invalid FTA Features”. * The options order: RepairDeleteOptionFTAFeatures_RepairUserSurfaceGeometricComponents RepairDeleteOptionFTAFeatures_RepairGroupOfSurfacesComponents RepairDeleteOptionFTAFeatures_DeleteInvalidFTAHavingAllLinksBroken RepairDeleteOptionFTAFeatures_DeleteInvalidFTAHavingAtLeast1BrokenLink RepairDeleteOptionFTAFeatures_DeleteAllInvalidFTA returns S_OK when SUCCEEDED. returns E_INVALIDARG if there is no option selected returns E_FAIL otherwise.

o SetActiveView

public virtual SetActiveView( ipiActiveView)

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

public virtual SetTPSs( const ipiList)

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