CATPLMComponentInterfaces Interface CATIPLMNavOccurrence

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

interface CATIPLMNavOccurrence

Interface to navigate on an Occurrence.

An Occurrence is a projection of contextual Instance-Reference pair.

The context being the root is also projected
It is however the sole occurrence with no target instance, and no aggregating parent occurrence

An Occurrence carries conceptually:

The id of the corresponding target Reuse Model object (Reference or Representation)
The id of the Path of the corresponding Reuse Model object, including the target Instance
All static (i.e: non-computed) attributes of represented Instance and Reference(including those from customization)
The projection of (i.e: absolute) computed attributes of represented Instance-Reference pair

An occurrence has no attributes on its own

Any edition can and must be fully delegated to the projected Instance-Reference pair
Update of projection will then reflect this change
No overloading of attribute is supported by Occurrence

The projection is not done automatically during navigation. Only few operations creates the occurrences:

Expand all with a filter
Expand Step by step
Direct Open of an Occurrence

This means that the ListRelatedOccurrences method returns no occurrence for a given Reference or Instance in a given context if, at least, one occurrence was not cretated before using one of these operations.

Method Index

o GetFather(CATIPLMNavOccurrence*&): Retrieves the Occurrence which aggregates the Occurrence.
o GetRelatedInstance(CATIPLMNavInstance*&): Retrieves the related Instance (which is related to the Occurrence in a given context).
o GetRelatedReference(CATIPLMNavReference*&): Retrieves the related Reference (which is related to the Occurrence in a given context).
o ListChildren(CATListPtrCATIPLMNavOccurrence&): Retrieves the list of direct child Occurrences of the Occurrence.

Methods

o GetFather

public virtual GetFather( opiOccurrence)

Retrieves the Occurrence which aggregates the Occurrence.

Parameters:

opiOccurrence

[out, CATBaseUnknown#Release] The father.
Legal values:

NULL: An error is detected.
Valid: Usable Occurrence.

Returns:

HRESULT
Legal values:

S_OK: The father is successfully returned.
E_FAIL: The Occurrence is not valid or the state of the system is not correct for this operation.
E_UNEXPECTED: There is an unexpected failure.

o GetRelatedInstance

public virtual GetRelatedInstance( opiInstance)

Retrieves the related Instance (which is related to the Occurrence in a given context).

Parameters:

opiInstance

[out, CATBaseUnknown#Release] The related Instance.
Legal values:

NULL: An error is detected or the Occurrence is a root.
Valid: Usable Instance.

Returns:

HRESULT
Legal values:

S_OK: The related Instance is successfully returned.
S_FALSE: The Occurrence is a root.
E_FAIL: The Occurrence is not valid or the state of the system is not correct for this operation.
E_UNEXPECTED: There is an unexpected failure.

o GetRelatedReference

public virtual GetRelatedReference( opiReference)

Retrieves the related Reference (which is related to the Occurrence in a given context).

Parameters:

opiReference

[out, CATBaseUnknown#Release] The related Reference.
Legal values:

NULL: An error is detected.
Valid: Usable Reference.

Returns:

HRESULT
Legal values:

S_OK: The related Reference is successfully returned.
E_FAIL: The Occurrence is not valid or the state of the system is not correct for this operation.
E_UNEXPECTED: There is an unexpected failure.

o ListChildren

public virtual ListChildren( ioChildrenList)

Retrieves the list of direct child Occurrences of the Occurrence.

Parameters:

ioChildrenList

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

Empty: The Occurrence has no child.
Filled: The Occurrence has children (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 Occurrence 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: CATIPLMNavOccurrence.h
If needed, your Imakefile.mk should include the module: CATPLMComponentInterfaces