CATPLMComponentInterfaces Interface CATIPLMNavInstance

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

interface CATIPLMNavInstance

Interface to navigate on an Instance.

Method Index

o GetFather(CATIPLMNavReference*&): Retrieves the Reference which aggregates the Instance.
o GetFirstLevelOccurrence(CATIPLMNavOccurrence*,CATIPLMNavOccurrence*&): Gets the First level Occurrence in a given context.
o GetReferenceInstanceOf(CATIPLMNavReference*&): Retrieves the instanciated Reference.
o ListRelatedOccurrences(CATBaseUnknown*,CATListPtrCATIPLMNavOccurrence&): Retrieves the Occurrences related to the Instance in a given context.

Methods

o GetFather

public virtual GetFather( opiReference)

Retrieves the Reference which aggregates the Instance.

Parameters:

opiReference

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

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

Returns:

HRESULT
Legal values:

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

o GetFirstLevelOccurrence

public virtual GetFirstLevelOccurrence(		`ipiContext`,
		`opiFirstLevelOccurrence`)

Gets the First level Occurrence in a given context.
Role: This methode, retrieves the first level occurrence correponding to "this" which is an instance.

 For example this reference model:
 Ref0
  |
  +- Instance of ref1
          |
          +-Ref1
              |
              +- Instance of ref2
                          |
                          +-Ref2

Correspond to this occurrence view:

 
 Occurrence of Ref0
         |
         +- Occurrence of Ref1
                     |
                     +- Occurrence of Ref2

So in the context of Occurrence of Ref0, if we ask on Instance of Ref1 to getting the first level occurence, we will get the Occurrence of Ref1. Conversely, if we ask with the same context, on Instance of Ref2 to getting the first level occurrence, we will get an error as, there is no first level occurrence, corresponding to this instance. Also, if we ask in the context of OccurrenceOfRef1, on instance of Ref2 to getting the first level occurrence, we will get an error: This is not the right occurrence tree to get a first level occurrence of this instance.

Parameters:

ipiContext

The context of navigation.
Legal values:

Object implementing CATIPLMNavOccurrence: To navigate under the given Occurrence. It should be an occurence corresponding to the father reference of this instance. If null, we get the default context corresponding to the father of this instance.

opiFirstLevelOccurrence

[out, CATBaseUnknown#Release] The First level Occurrence.
Legal values:

NULL: There is no First level Occurrence in the context.
Filled: There is a first level Occurrence in the context.

Returns:

HRESULT
Legal values:

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

o GetReferenceInstanceOf

public virtual GetReferenceInstanceOf( opiReference)

Retrieves the instanciated Reference.

Parameters:

opiReference

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

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

Returns:

HRESULT
Legal values:

S_OK: The instanciated Reference is successfully returned.
E_FAIL: The Instance 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 Instance 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 Instance 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: CATIPLMNavInstance.h
If needed, your Imakefile.mk should include the module: CATPLMComponentInterfaces