All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMFastenerUseItf Interface CATIFmaPLMSessionServices

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

interface CATIFmaPLMSessionServices

This interface gives access to methods allowing retrieving in session all the elements that contribute to the fastener structure: the fastener instances and the fastener connections.

Method Index

o GetFastenConnections(CATLISTP(CATBaseUnknown)**,CATBaseUnknown*): Retrieves all fastener connections in session.
o GetFasteners(CATLISTP(CATBaseUnknown)**,CATBaseUnknown*,CATString*): Retrieves all fastener instances in session present under given context.

Methods

o GetFastenConnections

public virtual GetFastenConnections(		`opListOfConnections`,
	const	`ipContext`	`= NULL` )

Retrieves all fastener connections in session.

Parameters:

opListOfConnections: [out] The list of fastener connections. This list may be empty. After use, each element of the list must be released and the list must be deleted.
ipContext: [in] A context (can be a Reference, an Instance or an Occurrence). If no context is given, the entire session will be considered.

Returns:

S_OK if everything ran ok, otherwise associated failure code.

o GetFasteners

public virtual GetFasteners(		`opListOfFasteners`,
	const	`ipContext`,
	const	`iFastenerType`	`= NULL` )

Retrieves all fastener instances in session present under given context.

Parameters:

opListOfFasteners

[out] The list of fastener instances. This list may be empty. After use, each element of the list must be released and the list must be deleted.

ipContext

[in] A context can be Object implementing CATIPLMNavReference To navigate under the root Occurrence which corresponds to the Reference All the fastener Occurrences under this reference will be retrieved recursively Object implementing CATIPLMNavOccurrence Fastener Occurrences present only under this Occurrence are retrieved

iFastenerType

[in] The type of fastener to retrieve.
Legal Values:

"SpotFastener"
"SpotAssyFastener"
"SpotFastenerSet"
"BeadFastener"
"BeadBundleFastener"

If no type is given, all types of fastener will be considered.

Returns:

S_OK if everything is ok, otherwise associated failure code.

This object is included in the file: CATIFmaPLMSessionServices.h
If needed, your Imakefile.mk should include the module: CATPLMFmaBrowseInterfaces