All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATMatInterfaces Interface CATIMaterialDomainInfo

Usage: you can reimplement this interface by deriving the supplied CATMaterialDomainInfoAdaptor adapter class.

interface CATIMaterialDomainInfo

Interface to Material Domain Info.
Role: Interface designed to be implemented if you want to create your own Applicative Domain.

BOA information: this interface can be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.

Method Index

o AllowMultiple(int&): Specifies if a user is authorized to create more than a single domain of this type.
o GetAdditionalCatalog(CATUnicodeString&): Retrieves the name of the additional feature catalog where the latetype of the root feature has been define.
o GetIntegrationInformation(CATUnicodeString*,CATUnicodeString*,CATUnicodeString*,CATUnicodeString*,CATUnicodeString*): Retrieves additionnal information to be integrated in the UI of material domains.
o GetIntegrationInformation(CATUnicodeString*,CATUnicodeString*,CATUnicodeString*,CATUnicodeString*,CATUnicodeString*,CATUnicodeString*): Retrieves additionnal information to be integrated in the UI of material domains.
o GetRootFeatureType(CATUnicodeString&): Retrieves the latetype of the root feature in the material domain.
o UseV5SimuRep(): Says if the Representation used to store data is based on V5 Simulation Representation or not.

Methods

o AllowMultiple

public virtual AllowMultiple( ioWithDefault)

Specifies if a user is authorized to create more than a single domain of this type.

Parameters:

ioWithDefault

In case of domains that allow multiplicity, enables to specify if one of the domain could be flagged as default.

0 means that the 'default' flag does not exist.
1 means that one of the domains can be flagged as 'default'.

Returns:

An HRESULT
Legal values:

S_OK: If multiplicity is allowed.
S_FALSE: If multiplicity is not allowed.
E_FAIL: An error occures.

o GetAdditionalCatalog

public virtual GetAdditionalCatalog( oCatalog)

Retrieves the name of the additional feature catalog where the latetype of the root feature has been define.

Parameters:

oCatalog: The returned catalog.

Returns:

An HRESULT
Legal values:

S_OK: The catalog was successfully retrieved.
E_FAIL: An error occures.

o GetIntegrationInformation

public virtual GetIntegrationInformation(		`ioDomainSubTyping`,
		`ioDefaultFeatureType`,
		`ioNlsFile`,
		`ioNlsEntry`,
		`ioIconFile`)

Retrieves additionnal information to be integrated in the UI of material domains.

Parameters:

oDomainSubTypping: Used to sub type the material domain.
oDefaultFeatureType: Feature that will be added by default after PLMNew.
oNlsFile: The CATNlsFile containing entries for material domain.
oNlsEntry: Name of the entry in the CATNls for material domain name.
ioIconFile: Name of the icon for material domain.

Returns:

An HRESULT
Legal values:

S_OK: Information successfully retrieved.
E_FAIL: An error occures.

o GetIntegrationInformation

public virtual GetIntegrationInformation(		`ioDomainSubTyping`,
		`ioDefaultFeatureType`,
		`ioNlsFile`,
		`ioNlsEntry`,
		`ioIconFile`,
		`ioIconMediumFile`)

Retrieves additionnal information to be integrated in the UI of material domains.

Parameters:

oDomainSubTypping: Used to sub type the material domain.
oDefaultFeatureType: Feature that will be added by default after PLMNew.
oNlsFile: The CATNlsFile containing entries for material domain.
oNlsEntry: Name of the entry in the CATNls for material domain name.
ioIconFile: Name of the icon for material domain.
ioIconMediumFile: Name of the medium icon for material domain use in edit applied material balloon

Returns:

An HRESULT
Legal values:

S_OK: Information successfully retrieved.
E_FAIL: An error occures.

o GetRootFeatureType

public virtual GetRootFeatureType( oType)

Retrieves the latetype of the root feature in the material domain.

Parameters:

oType: The returned latetype.

Returns:

An HRESULT
Legal values:

S_OK: The root feature was successfully retrieved.
E_FAIL: An error occures.

o UseV5SimuRep

public virtual UseV5SimuRep(

)

Says if the Representation used to store data is based on V5 Simulation Representation or not.

Returns:

An HRESULT
Legal values:

S_OK: The domain is based on SimuRep.
S_FALSE: The domain is not based on SimuRep.
E_FAIL: An error occurs.

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