CATPLMComponentInterfaces Interface CATIPLMNavReference

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

interface CATIPLMNavReference

Interface to navigate on a Reference.

Method Index

o ListChildren(CATListPtrCATIPLMNavEntity&,int&,CATPLMCoreType*): Retrieves the list of direct children (Instance or Representation Instance for this version) of the Reference.
o ListInstances(CATListPtrCATIPLMNavInstance&): Retrieves the list of Instances which are instance of the Reference.
o ListRelatedOccurrences(CATBaseUnknown*,CATListPtrCATIPLMNavOccurrence&): Retrieves the Occurrences related to the Reference in a given context.

Methods

o ListChildren

public virtual ListChildren(		`ioChildrenList`,
	const	`iiFilterSize`,
		`ipFilter`)

Retrieves the list of direct children (Instance or Representation Instance for this version) of the Reference.

Parameters:

ioChildrenList

The list of direct children. Warning this list is cleaned before treatment.
Legal values:

Empty: The Reference has no child.
Filled: The Reference has children (in this case the order is not guaranteed).

iiFilterSize

The size of the array of types to filter.
Legal values:

0: All children are listed.
> 0: Only the children of the given types are listed.

ipFilter

The array of types to filter.

Returns:

HRESULT
Legal values:

S_OK: The list (Empty or Filled) is successfully returned.
E_INVALIDARG: One of the arguments is incorrect (iiFilterSize < 0).
E_FAIL: The Reference is not valid or the state of the system is not correct for this operation.
E_UNEXPECTED: There is an unexpected failure.

Example:

      CATIPLMNavReference * piReference = ...;
   CATListPtrCATIPLMNavEntity allChildrenList;
   HR = piReference->ListChildren(allChildrenList, 0, NULL);
   CATListPtrCATIPLMNavEntity oneTypeChildrenList;
   CATPLMCoreType coreType = PLMCoreRepInstance;
   HR = piReference->ListChildren(oneTypeChildrenList,  1, &coreType);

o ListInstances

public virtual ListInstances( ioInstancesList)

Retrieves the list of Instances which are instance of the Reference.

Parameters:

ioInstancesList

The list of Instances. Warning this list is cleaned before treatment.
Legal values:

Empty: The Reference is not instanciated.
Filled: The References is instanciated (in this case the order is not guaranteed).

Returns:

HRESULT
Legal values:

S_OK: The list (Empty or Filled) is successfully returned.
E_FAIL: The Reference is not valid or the state of the system is not correct for this operation.
E_UNEXPECTED: There is an unexpected failure.

o ListRelatedOccurrences

public virtual ListRelatedOccurrences(		`ipiContext`,
		`ioRelatedOccurrencesList`)

Retrieves the Occurrences related to the Reference in a given context.

Parameters:

ipiContext

The context of navigation.
Legal values:

Object implementing CATIPLMNavReference: To navigate under the root Occurrence which corresponds to the Reference.
Object implementing CATIPLMNavOccurrence: To navigate under the given Occurrence.

ioRelatedOccurrencesList

The list of related Occurrences. Warning this list is cleaned before treatment.
Legal values:

Empty: There is no Occurrences in the context.
Filled: There are Occurrences in the context (in this case the order is not guaranteed).

Returns:

HRESULT
Legal values:

S_OK: The list (Empty or Filled) is successfully returned.
E_INVALIDARG: The context is not correct.
E_FAIL: The Reference is not valid or the state of the system is not correct for this operation.
E_UNEXPECTED: There is an unexpected failure.

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