Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATSimPLMAppModelerItf Interface CATISimulationPLMManager

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

interface CATISimulationPLMManager

This interface will manage the Simulation Object.
Enable to have access to the simulation data.

Method Index

o AggregateRepresentationAuthoring(SimulationCategoryIdentifier,CATUnicodeString&,CATIAdpType*,CATUnicodeString&,CATISimulationPLMObject*&)
o AggregateRepresentationAuthoring(SimulationCategoryIdentifier,CATUnicodeString&,CATIType_var&,CATUnicodeString&,CATISimulationPLMObject*&)
o AggregateSimulationDocument(SimulationCategoryIdentifier,CATIType_var&,CATUnicodeString&,CATUnicodeString&,CATISimulationPLMObject*&): Aggregates a representation reference under a given category.
o AggregateSimulationDocument(SimulationCategoryIdentifier,CATIAdpType*,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATISimulationPLMObject*&)
o AggregateSimulationDocument(SimulationCategoryIdentifier,CATIType_var&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATISimulationPLMObject*&)
o GetRootManagerFromSO(SimulationCategoryIdentifier&,CATBaseUnknown*&): Retrieves root manager of V5 rep.
o ListObjects(SimulationCategoryIdentifier,CATListValCATBaseUnknown_var&): Retrieves the lists of objects attached under a given category.
o ListRepRefUnderCategory(SimulationCategoryIdentifier,CATListValCATBaseUnknown_var&): Gives the Representation Reference list under category.
o RetrieveSimulatedComponent(CATIPLMComponent*&): Retrieves the Component pointed under the category Model.

o SimulationCategoryIdentifier: Enumeration of Category's type.

Methods

o AggregateRepresentationAuthoring

public virtual AggregateRepresentationAuthoring(		`iCategory`,
		`Name`,
		`ipiType`,
		`iDiscipline`,
		`opiRepresentation`)

Deprecated:

R214 AggregateSimulationDocument (Discipline replaced by CATIType) Aggregates a V5 representation reference under a given category.

Parameters:

iCategory: The category where the representation will be added. All Categories except Products and Context. The category is created if it does not exist.
ipiType: The type of the representation. If the representation belongs to the simulation modeler the V5 stream is directly created.
iDiscipline: Must be defined if the representation belongs to the simulation modeler.
opiRepresentation: [out , CATBaseUnknown#Release] The pointer of the created V5 representation instance.

o AggregateRepresentationAuthoring

public virtual AggregateRepresentationAuthoring(		`iCategory`,
		`Name`,
	const	`ipiType`,
		`iDiscipline`,
		`opiRepresentation`)

Deprecated:

R214 AggregateRepresentationAuthoring (Discipline replaced by CATIType) Aggregates a V5 representation reference under a given category.

Parameters:

iCategory: The category where the representation will be added. All Categories except Products and Context. The category is created if it does not exist.
ipiType: The type of the representation. If the representation belongs to the simulation modeler the V5 stream is directly created.
iDiscipline: Must be defined if the representation belongs to the simulation modeler.
opiRepresentation: [out , CATBaseUnknown#Release] The pointer of the created V5 representation instance.

o AggregateSimulationDocument

public virtual AggregateSimulationDocument(		`iCategory`,
	const	`ipiType`,
	const	`iuPath`,
	const	`iuType`,
		`opiRepresentation`)

Aggregates a representation reference under a given category.

Parameters:

iCategory: The category where the representation will be added. All categories except Product and Context. The category is created if it does not exist.
ipiType: The type of the representation.
iuPath: The path of where is tored the file on the file system.
iuType: The extention of the file.
opiRepresentation: [out, CATBaseUnknown#Release] The pointer on the Non V5 representation.

o AggregateSimulationDocument

public virtual AggregateSimulationDocument(		`iCategory`,
		`ipiType`,
	const	`iuPath`,
	const	`iuType`,
		`iDiscipline`,
		`opiRepresentation`)

Deprecated:

R214 AggregateSimulationDocument (Discipline replaced by CATIType) Aggregates a non V5 rep reference under a given category.

Parameters:

iCategory: The category where the representation will be added. All Categories except Product and Context. The category is created if it does not exist.
ipiType: The type of the representation.
iuPath: The path of where is tored the file on the file system.
iuType: The extention of the file.
opiRepresentation: [out, CATBaseUnknown#Release] The pointer on the Non V5 representation.

o AggregateSimulationDocument

public virtual AggregateSimulationDocument(		`iCategory`,
	const	`ipiType`,
	const	`iuPath`,
	const	`iuType`,
		`iDiscipline`,
		`opiRepresentation`)

Deprecated:

R214 AggregateSimulationDocument (Discipline replaced by CATIType) Aggregates a non V5 rep reference under a given category.

Parameters:

iCategory: The category where the representation will be added. All Categories except Product and Context. The category is created if it does not exist.
ipiType: The type of the representation.
iuPath: The path of where is tored the file on the file system.
iuType: The extention of the file.
opiRepresentation: [out, CATBaseUnknown#Release] The pointer on the Non V5 representation.

o GetRootManagerFromSO

public virtual GetRootManagerFromSO(		`iCategory`,
		`oRoot`)

Retrieves root manager of V5 rep.

Parameters:

iSO

iCategory category type that aggregate the rep.

oRoot

[out , CATBaseUnknown#Release] . An HRESULT value.
Legal values:

S_OK: CATISimulationPLMObject has been created and agregated
E_FAIL: An error occured during the process.

o ListObjects

public virtual ListObjects(		`iCategory`,
		`opiSimulationPLMObjects`)

Retrieves the lists of objects attached under a given category.

Parameters:

iCategory: The category under which you want to get the objects. All Categories excepted Product and Context.
opiSimulationPLMObjects: The list of simulation objects classified under the given category and corresponding to the given filter.

o ListRepRefUnderCategory

public virtual ListRepRefUnderCategory(		`iCategory`,
		`oSimulationPLMObject`)

Gives the Representation Reference list under category.

Parameters:

iCategory

category where representation should be added. All Categories excepted Product and Context.

iObjectType

see CATISimulationPLMObject enum

oSimulationPLMObject

list of simulation objects agregated in category. An HRESULT value.
Legal values:

S_OK: Category and objects are found
E_FAIL: An error occured during the process.

o RetrieveSimulatedComponent

public virtual RetrieveSimulatedComponent( opiSimulatedComponent)

Retrieves the Component pointed under the category Model.

Parameters:

opiSimulatedComponent: [out, CATBaseUnknown#Release] The Simulated Component

Enumerated Types

o SimulationCategoryIdentifier

enum SimulationCategoryIdentifier {
  Model,
  Scenario,
  Result
}

Enumeration of Category's type.

Parameters:

Model: The value of the enum to reference the Model Category.
Scenario: The value of the enum to reference the Scenario Category.
Result: The value of the enum to reference the Result Category.

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

CATSimPLMAppModelerItf Interface CATISimulationPLMManager

Method Index

Enumerated Type Index

Methods

Enumerated Types