All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATTPSBaseUseItf Interface CATITPS

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

interface CATITPS

Interface for the Technological Product Specification (TPS) objects.
Leaf entity in the Design Pattern Composite. TPS modeler enables definition of specification related to surfaces. The link with the topologic/geometric element is defined thanks to TTRS.

See also:

Method Index

o GetHiddenText(CATUnicodeString&): Retrieves Hidden Text.
o GetSet(CATITPSSet**): Retrieves tolerancing set the TPS belongs too.
o GetTTRS(CATITTRSList**): Retrieves a CATITTRSList to read a list of features upon which is applied the current specification.
o GetURL(int,wchar_t**): Retrieves url.
o GetUrlListSize(int*): Retrieves the number of urls.
o SetHiddenText(CATUnicodeString&): Sets Hidden Text.
o SetTTRS(CATITTRSList*): Sets the TTRS list associated to the Specification.
o SetURL(wchar_t*): Set a link to a database object or URL.

Methods

o GetHiddenText

public virtual GetHiddenText( opstrString)

Retrieves Hidden Text.

Parameters:

opText: Hidden Text

Returns:

S_OK if succeded E_FAIL otherwise

o GetSet

public virtual GetSet( oSet)

Retrieves tolerancing set the TPS belongs too.

Parameters:

oSet: [out, CATITPSSet#Release] The Set.

o GetTTRS

public virtual GetTTRS( oTTRS)

Retrieves a CATITTRSList to read a list of features upon which is applied the current specification. Note that this list may have a null count; in such a case, we have to consider this specification as a TPS applied to the whole part. Result of this call will mostly be a singleton, but it can also happen situations where the list size is higher than 1; this way, we have defined a specification related to several surfaces (regarless the order in which the surfaces are stored)

Parameters:

oTTRS: [out, CATITTRSList#Release] The TTRS list.

o GetURL

public virtual GetURL(	const	`iIndex`,
		`opUrl`)

Retrieves url.

Parameters:

iIndex: Index of url.
opUrl: url

Returns:

S_OK if succeded (opUrl must be deleted), E)_FAIL otherwise

o GetUrlListSize

public virtual GetUrlListSize( oNumber)

Retrieves the number of urls.

Parameters:

oNumber: the size of url list.

Returns:

S_OK if succeded E_FAIL otherwise

o SetHiddenText

public virtual SetHiddenText( const ipstrString)

Sets Hidden Text.

Parameters:

ipText: Hidden Text

Returns:

S_OK if succeded E_FAIL otherwise

o SetTTRS

public virtual SetTTRS( const iTTRS)

Sets the TTRS list associated to the Specification.

o SetURL

public virtual SetURL( const pUrl)

Set a link to a database object or URL.

Parameters:

pUrl: The url or file link to set.

Returns:

S_OK if succeded, E_FAIL otherwise

This object is included in the file: CATITPS.h