CATPLMComponentInterfaces Interface CATIPLMNavRepInstance

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

interface CATIPLMNavRepInstance

Interface to navigate on a Representation Instance.

Method Index

o GetFather(CATIPLMNavReference*&): Retrieves the Reference which aggregates the Representation Instance.
o GetRepReferenceInstanceOf(CATIPLMNavRepReference*&): Retrieves the instanciated Representation Reference.

Methods

o GetFather

public virtual GetFather( opiReference)

Retrieves the Reference which aggregates the Representation 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 RepInstance is not valid or the state of the system is not correct for this operation.
E_UNEXPECTED: There is an unexpected failure.

o GetRepReferenceInstanceOf

public virtual GetRepReferenceInstanceOf( opiRepReference)

Retrieves the instanciated Representation Reference.

Parameters:

opiRepReference

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

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

Returns:

HRESULT
Legal values:

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