CATTPSUseItf Interface CATITPSServicesContainers

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATITPSServicesContainers

Interfaces dedicated to retreieve or create Tolerancing container and Tolerancing Set.

Method Index

o CheckReferenceObjectInPath(CATPathElement*,IUnknown**,CATBoolean*,CATPathElement**): Check that the reference product is included in a path element
o GetSet(IUnknown*,CATITPSSet**): Retrieves the Annotation Set from an occurrencerepresenting an instance of 3D Shape Representation Reference.
o GetSetList(IUnknown*,CATITPSList**,CATBoolean): Retrieves Annotation Sets from a 3D Shape Representation Reference.
o RetrieveOrCreateCurrentTPSSet(IUnknown*,CATTPSSetObtentionMode,CATITPSSet**,CATBoolean*): Retrieves or creates a TPSSet.

Methods

o CheckReferenceObjectInPath

public virtual CheckReferenceObjectInPath(		`ipPath`,
		`iopiReference`,
		`obRetrievedFromPath`,
		`opUIActivePath`)

Check that the reference product is included in a path element

Parameters:

ipPath: The context path.
iopiRefProduct: The reference product already computed (can be NULL). If the reference product is NULL or not in path a new one will be computed.
obRetrievedFromPath: If TRUE indicate that the reference product has been retrieved from Path.
opUIActivePath: The UI Active Path that must be provided to the TTRS agent when the reference product is retrieved from path.

o GetSet

public virtual GetSet(		`iPLMRepRef`,
		`opiTPSSet`)

Retrieves the Annotation Set from an occurrencerepresenting an instance of 3D Shape Representation Reference.
Role: This method returns the Annotation Set from an occurrencerepresenting an instance of 3D Shape Representation Reference.

Parameters:

iPLMRepRef: [in] The Representation Reference
opiTPSSet: [out, CATBaseUnknown#Release] The Annotation Set.

Returns:

S_OK

if successful.

E_INVALIDARG

if the occurrencedoes not represent a 3D Shape representation reference.

E_FAIL

if the operation failed.

o GetSetList

public virtual GetSetList(	`ipiPLMRepRef`,
	`iopiTPSSetList`,
	`ibCreationIfNotExist`	`= FALSE`)

Retrieves Annotation Sets from a 3D Shape Representation Reference.
Role: This method returns the Annotation Set from a 3D Shape Representation Reference.

Parameters:

ipiPLMRepRef: [in] The Representation Reference
iopiTPSSetList: [out, CATITPSList#Release] The Annotation Set List. If the list does not exist, it will be created. If 3D Shape Representation Reference is in Visualization mode, a Light Set is added. In this case, a Result Set is always merged as far as its description is concerned. If 3D Shape Representation Reference is in Edit mode, a Classical (Heavy) Set is added. Moreover, if exist, a Result is added in this context too. Note that transition from Visualization to Edit mode will have impact on data returned by this API. After the switch, the previous Light Set will be destroyed by switch mechanism. GetSetList must be called another time to get the corresponding Classical/Result ones.
ibCreationIfNotExist: [in] For Visualization mode, this is the way to load a Light Set if this one has not been created yet.

Returns:

S_OK

if successful.

E_INVALIDARG

if the input does not represent a 3D Shape Representation Reference.

E_FAIL

if the operation failed.

o RetrieveOrCreateCurrentTPSSet

public virtual RetrieveOrCreateCurrentTPSSet(	const	`ipiRefContext`,
	const	`iMode`,
		`opiSet`,
		`oCreation`	`= NULL`)

Retrieves or creates a TPSSet.
Precondition 1: This method manage only TPSSet not ResultSet. To get ResultSet see method
Precondition 2: Only one TPSSet can be present into a document.

Parameters:

ipiRefContext: Defines the search/creation context. It must be a reference product. The method returns E_FAIL if it is an instance product.
iMode: Defines the obtention mode. CreateIfMissing : search a TPSSet in context, if nothing found create a new one. NoCreation : search a TPSSet in context, if nothing found output value *opiSet is NULL. CreateNew : @deprecated R417. This option is obsolete, replace it by CreateIfMissing.
opiSet: TPS set retrieved or created.
oCreation: TRUE if set has just been created. FALSE if set has been retrieved.

This object is included in the file: CATITPSServicesContainers.h