All Frameworks Class Hierarchy This Framework Indexes Previous Next

ObjectModelerBase CATOmbObjectInContext

Usage: you must use this class as is. You should never derive it.

public class CATOmbObjectInContext

Class representing an object in a context.

Role:This class represents an object in a context. A context means an occurrence or a representation occurrence which can be seen as a path of instances and/or a representation instance. An object a PLM object other that an instance (a connection, a port, a reference or a representation) or an internal object of a representation or of a connection. An object in a context means the usage of this object in the context of this occurrence.

Method Index

o Compare(CATOmbObjectInContext*): Compares this object in context to an other object in context (same path of instances and/or representation instance, same object out of context).
o CreateObjectInContext(CATLISTP(CATIPLMComponent)&,CATIPLMComponent*,CATBaseUnknown*,CATOmbObjectInContext*&): Creates a CATOmbObjectInContext for an object and a context.
o CreateObjectInContext(CATLISTP(CATIPLMComponent)&,CATIPLMComponent*,CATBaseUnknown*,CATOmbObjectInContext_var&): Creates a CATOmbObjectInContext_var for an object and a context.
o GetContextRootReference(CATIPLMComponent*&): Retrieves the root PLM Reference of the context.
o GetInstanceOfRepresentation(CATIPLMComponent*&): Gets (if exists) the representation instance defining this CATOmbObjectInContext instance.
o GetObjectOutOfContext(CATBaseUnknown*&,IID&): Gets (if exists) the object defining this CATOmbObjectInContext instance.
o GetPathOfInstances(CATLISTP(CATIPLMComponent)&): Gets (if exists) the path of instances defining this CATOmbObjectInContext instance.

Methods

o Compare

public virtual Compare( const ipObjectInContextToCompare)

Compares this object in context to an other object in context (same path of instances and/or representation instance, same object out of context).

Parameters:

ipObjectInContextToCompare: [in] The object in context to compare with.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.

Returns:

S_OK if the method succeeds and the two object in context are identical.
S_FALSE if the method succeeds but the two object in context are different.
E_INVALIDARG if parameter provided are unexpected.
E_FAIL otherwise.

o CreateObjectInContext

public static CreateObjectInContext(		`iPathOfInstances`,
		`iRepInstance`,
		`iObject`,
		`oObjectInContext`)

Creates a CATOmbObjectInContext for an object and a context.

Parameters:

iPathOfInstances: The path of instances describing the context of the object (optional).
iRepInstance: The instance of the representation containing the object (optional).
iObject: The object (optional).
oObjectInContext: [out, CATBaseUnknown#Release] The built CATOmbObjectInContext representing the object in this context.

Returns:

S_OK if oObjectInContext has been successfully created.
E_INVALIDARG if iPathOfInstances and iRepInstance do not represent a valid context for iObject
E_FAIL otherwise.

o CreateObjectInContext

public static CreateObjectInContext(		`iPathOfInstances`,
		`iRepInstance`,
		`iObject`,
		`oObjectInContext`)

Creates a CATOmbObjectInContext_var for an object and a context.

Parameters:

iPathOfInstances: The path of instances describing the context of the object (optional).
iRepInstance: The instance of the representation containing the object (optional).
iObject: The object (optional).
oObjectInContext: The built CATOmbObjectInContext_var representing the object in this context.

Returns:

S_OK if oObjectInContext has been successfully created.
E_INVALIDARG if iPathOfInstances and iRepInstance do not represent a valid context for iObject
E_FAIL otherwise.

o GetContextRootReference

public virtual GetContextRootReference( oContextRootReference)

Retrieves the root PLM Reference of the context. The root PLM Reference of the context is retrieved with the following algorithm:

If there is a path of PLM Instances, the root reference is the PLM Reference aggregating the first PLM Instance of the path
If there is no path of PLM Instances but a PLM Representation instance, the root reference is the PLM Reference aggregating the PLM Representation instance
If there is no PLM first instances and no PLM Representation instance, there is no context and therefore no Context Root Reference.

Parameters:

oContextRootReference: [CATBaseUnknown#Release] A PLM Reference.
Output parameter.
This parameter MUST be provided by caller as NULL. This method returns an error otherwise.
This parameter is valuated if method returns S_OK. This parameter is returned to caller as NULL if method returns S_FALSE.
This parameter is returned to caller as NULL if method fails.

Returns:

S_OK if the method succeeds.
S_FALSE if the method succeeds but there no Context Root Reference to return.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o GetInstanceOfRepresentation

public virtual GetInstanceOfRepresentation( opRepresentationInstance)

Gets (if exists) the representation instance defining this CATOmbObjectInContext instance.

Parameters:

opRepresentationInstance: [CATBaseUnknown#Release] A Representation Instance.
Output parameter.
This parameter MUST be provided by caller as NULL. This method returns an error otherwise.
This parameter is returned to caller as NULL if method fails.
This parameter is valuated if method succeeds.

Returns:

S_OK if the method succeeds.
S_FALSE if the method succeeds but there no defined representation instance.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o GetObjectOutOfContext

public virtual GetObjectOutOfContext(		`opObject`,
	const	`iIID`	`=IID_CATBaseUnknown`)

Gets (if exists) the object defining this CATOmbObjectInContext instance.
Note: The object can be a proxy if this CATOmbObjectInContext has been retrieved from a link.

Parameters:

opObject: [CATBaseUnknown#Release] The object if defined.
Output parameter.
This parameter MUST be provided by caller as NULL. This method returns an error otherwise.
This parameter is returned to caller as NULL if method fails.
This parameter is valuated if method succeeds.
iIID: The desired interface.

Returns:

S_OK if the method succeeds.
S_FALSE if the method succeeds but there no defined object.
E_NOINTERFACE if the method succeeds but there defined object does not adhere to the specified interface.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o GetPathOfInstances

public virtual GetPathOfInstances( oPathOfInstances)

Gets (if exists) the path of instances defining this CATOmbObjectInContext instance.
In the case of a VO Descriptor only composed of an instance, it corresponds to a path of instances composed of a single instance.

Parameters:

oPathOfInstances: A path of instances.
Output parameter.
This list MUST be provided by caller as empty. This method returns an error otherwise.
This list is returned to caller as empty if method fails. Items in this returned list must be released by the caller after use !!

Returns:

S_OK if the method succeeds and the path was successfully retrieved.
S_FALSE if the method succeeds but there no defined path.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

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

ObjectModelerBase writeClassCharacteristic(); CATOmbObjectInContext

Method Index

Methods

ObjectModelerBase CATOmbObjectInContext