All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATSnapshotItf Interface CATISnapshotEdtFactory

SystemTS.IUnknown

System.IDispatch

System.CATBaseUnknown

CATISnapshotEdtFactory

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

interface CATISnapshotEdtFactory

Interface to create Snapshots.

Method Index

o CreateSnapshot(CATIPLMComponent*,CATBaseUnknown*,CATICAASnapshotReference_var&): Creates a new Snapshot based on a "Fit all"
o GetSnapshots(CATIPLMComponent*,CATBaseUnknown*,CATListValCATBaseUnknown_var&): Get the snapshots of the context/root object.
o UpdateSnapshot(CATIPLMComponent*,CATBaseUnknown*,CATICAASnapshotReference*): Update the snapshott.
o UpdateSnapshots(CATIPLMComponent*,CATBaseUnknown*): Update the snapshots of the context/root object.

Methods

o CreateSnapshot

public virtual HRESULT CreateSnapshot(	CATIPLMComponent*	`iObject`,
	CATBaseUnknown*	`iContext`,
	CATICAASnapshotReference_var&	`oSnapshot`) = 0

Creates a new Snapshot based on a "Fit all"

Parameters:

iObject: [in] The root object used to create the snapshot
iContext: [in] The context used to create the snapshot. If NULL, MainView is used.
oSnapshot: [out]]
The created oSnapshot.
This parameter is valuated if method succeeds.

Returns:

S_OK if the method succeeds.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o GetSnapshots

public virtual HRESULT GetSnapshots(	CATIPLMComponent*	`iObject`,
	CATBaseUnknown*	`iContext`,
	CATListValCATBaseUnknown_var&	`oSnapshotList`) = 0

Get the snapshots of the context/root object.

Parameters:

iObject: [in] The root object used to get the snapshot
iContext: [in] The context used to get the snapshots. If NULL, MainView is used.
oSnapshotList: [out]]
The associeted oSnapshots.
This parameter is valuated if method succeeds.

Returns:

S_OK if the method succeeds.
S_FALSE if the method succeeds but no snapshot associated.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o UpdateSnapshot

public virtual HRESULT UpdateSnapshot(	CATIPLMComponent*	`iObject`,
	CATBaseUnknown*	`iContext`,
	CATICAASnapshotReference*	`iSnapshot`) = 0

Update the snapshott.

Parameters:

iObject: [in] The root object used to update the snapshot
iContext: [in] The context used to update the snapshot. If NULL, MainView is used.
iSnapshot: [in] The snapshot.

Returns:

S_OK if the method succeeds.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o UpdateSnapshots

public virtual HRESULT UpdateSnapshots(	CATIPLMComponent*	`iObject`,
	CATBaseUnknown*	`iContext`) = 0

Update the snapshots of the context/root object.

Parameters:

iObject: [in] The root object used to update the snapshot
iContext: [in] The context used to update the snapshots. If NULL, MainView is used.

Returns:

S_OK if the method succeeds.
S_FALSE if the method succeeds but no snapshot associated.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

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