All Frameworks Class Hierarchy This Framework Indexes Previous Next

FeatureModelerExt CATFmStartUpFacade

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

public class CATFmStartUpFacade

Class representing a Feature Definition (StartUp).
Role: This class is a Facade object providing access to a Feature Definition, according to the provided Accreditations.
It gathers in a single place all operations defined at the Feature Modeler level that can be performed on a Feature Definition.

LifeCycle information.
The recommended usage is to create Facades as local variables in functions and methods bodies.
Feature Definition Facades are valid during the whole PLM Session in which they have been bound. They are nevertheless not really intended to be used as global variables or class member data. The life cycle of Facades should not extend beyond the scope of the funtion in which they have been created.

Access Control information.
Interactions with Feature Modeler entities, either read-only or read+write, are subject to authorization.
On a Facade with no (or insufficient) Accreditations only the methods related to the Facade binding will succeed. Such a Facade can most notably be used as an output parameter for a method like to compare it immediatly with another Feature Definition through . All other methods, i.e. those for wich E_ACCESSDENIED is a legal return value, will fail.
To be allowed to instantiate a Feature, an application must be registered as the owner of the Feature Catalog defining the Feature.

See also:

Constructor and Destructor Index

o CATFmStartUpFacade(): Constructs an empty Feature Definition (StartUp) Facade.
o CATFmStartUpFacade(CATFmCredentials&): Constructs a Feature Definition (StartUp) Facade.
o CATFmStartUpFacade(CATFmStartUpFacade&): Copy constructor.
o CATFmStartUpFacade(CATFmCredentials&,CATUnicodeString&): Constructs a Feature Definition (StartUp) Facade.
o ~CATFmStartUpFacade(): Destructor.

Method Index

o BindTo(CATUnicodeString&): Binds the Facade to a Feature Definition (StartUp).
o Clear(): Unbinds the Facade from its bound Feature Definition.
o CompareStartUpWith(CATFmStartUpFacade&): Compares the bound Feature Definition(s) of two Facades.
o GetTypeName(CATUnicodeString&): Retrieves the Late Type of a Feature Definition.
o InstantiateIn(CATFmContainerFacade&,CATFmFeatureFacade&): Instantiates a Feature.
o InstantiateUnder(CATFmContainerFacade&,CATFmFeatureFacade&,CATFmAttributeName&,CATFmFeatureFacade&): Instantiates a Feature.
o IsValid(): Checks the Facade validity.
o operator!(): Logical-negation (or logical-NOT) operator.
o operator=(CATFmStartUpFacade&): Assignment operator.

Constructor and Destructor

o CATFmStartUpFacade

public CATFmStartUpFacade(

)

Constructs an empty Feature Definition (StartUp) Facade.
Role: This constructor creates a Facade with no Accreditation and not bound to any Feature Definition.
Only the assignment operator can affect the Credentials Set of a Facade after its construction.

o CATFmStartUpFacade

public CATFmStartUpFacade( const iAccreditations)

Constructs a Feature Definition (StartUp) Facade.
Role: This constructor creates a Facade with the provided credentials and not bound to any Feature Definition.
Only the assignment operator can affect the Credentials Set of a Facade after its construction.

Parameters:

iAccreditations: [in] The set of Accreditations obtained by the application.
These Accreditations will be used to authorize or not any operation attempted on the bound Feature Container.
Lifecycle: A Facade keeps a copy of the set of accreditations it created with. Any addition of accreditations performed on the Crendentials object after the Facade has been created will not be reflected.

o CATFmStartUpFacade

public CATFmStartUpFacade( const iStartUpFacade)

Copy constructor.
Role: This method creates an exact copy of a Feature Definition (StartUp) Facade.

Parameters:

iStartUpFacade: [in] The Facade to copy.

o CATFmStartUpFacade

public CATFmStartUpFacade(	const	`iAccreditations`,
	const	`iIdentification`)

Constructs a Feature Definition (StartUp) Facade.
Role: This constructor creates a Facade with the provided credentials and bound to a Feature Definition.
Only the assignment operator can affect the Credentials Set of a Facade after its construction.

Parameters:

iAccreditations

[in] The set of Accreditations obtained by the application.
These Accreditations will be used to authorize or not any operation attempted on the bound Feature Container.
Lifecycle: A Facade keeps a copy of the set of accreditations it created with. Any addition of accreditations performed on the Crendentials object after the Facade has been created will not be reflected.

iIdentification

An identification of the Feature Definition.
Legal values:

"`StartUpIdentifier`@`Catalog.CATfct`"
"`StartUpIdentifier`#@`Catalog.CATfct`"
"0u???????-????-????-????????????????@`Catalog.CATfct`"

Deprecated value (V5-6R2015 / 3DEXPERIENCER2015x):

"StartUpLateType"

See also:

o ~CATFmStartUpFacade

public ~CATFmStartUpFacade(

)

Destructor.

Methods

o BindTo

public BindTo( const iIdentification)

Binds the Facade to a Feature Definition (StartUp).
This method does not affect the Accreditations Set of the Facade.

Parameters:

iIdentification

An identification of the Feature Definition.
Legal values:

"`StartUpIdentifier`@`Catalog.CATfct`"
"`StartUpIdentifier`#@`Catalog.CATfct`"
"0u???????-????-????-????????????????@`Catalog.CATfct`"

Deprecated value (V5-6R2015 / 3DEXPERIENCER2015x):

"StartUpLateType"

Legal values:

S_OK: The Feature Definition has been found and the Facade bound to it.
E_INVALIDARG: The Feature Definition has not been found.
E_ACCESSDENIED: Credentials do not grant access to this Feature Definition.
E_FAIL: Another failure has occured.

o Clear

public Clear(

)

Unbinds the Facade from its bound Feature Definition.
This method does not affect the Accreditations Set of the Facade.

Returns:: This Facade.

o CompareStartUpWith

public CompareStartUpWith( const iStartUpFacade)

Compares the bound Feature Definition(s) of two Facades.
Role: compares the bound Feature Definition(s) (StartUp) of two Facades without taking the Accreditations into account.
An Feature Definition remains valid until the PLM session is closed.

Parameters:

iStartUpFacade: [in] The Feature Definition Facade to be compared to this.

Returns:

An integer value.
Legal values:

TRUE: if the Facades are either both invalid or both bound to the same valid Feature Definition.
FALSE: in any other case.

o GetTypeName

public GetTypeName( oLateType)

Retrieves the Late Type of a Feature Definition.

Parameters:

oLateType: [out] A (caller provided) string in which the Late Type associated to the Feature Definition will be stored. The Late Type associated to the Feature Definition is the Late Type of the instances of Feature Definition.
If the method fails oLateType is not modified, it is otherwise overwritten with the retrieved value.

Returns:

An HRESULT value.
Legal values:

S_OK: The Late Type has been successfuly retrieved.
E_INVALIDARG: Facade is not bound to a valid Feature Definition.
E_ACCESSDENIED: Credentials do not grant access to this Feature Definition.
Other: Another failure has occured.

o InstantiateIn

public InstantiateIn(	const	`iContainer`,
		`oInstance`)

Instantiates a Feature.

Parameters:

iContainer: [in] A valid Facade bound to the container in which an Instance of this Feature Definition must be created.
oInstance: [out] A (caller provided) Facade that will bound to the created Instance.
Notice that the Credentials of the provided Facade will not be used nor be modified.
If the method fails oInstance is not modified, it is otherwise overwritten with the retrieved value.

Returns:

An HRESULT value.
Legal values:

S_OK: The instantiation succeeded.
E_ACCESSDENIED: Credentials do not grant access to this Feature or the container.
E_FMINVALIDFEATURE: This Facade is not bound to a valid Base Feature.
LCC_E_FAIL: The currently used license does not authorize the requested operation.
Other: Another failure has occured.

o InstantiateUnder

public InstantiateUnder(	const	`iContainer`,
		`iParent`,
	const	`iKey`,
		`oInstance`)

Instantiates a Feature.
Role: Instantiates a Feature and aggregates the new instance under an existing Feature.

Parameters:

iContainer: [in] A valid Facade bound to the container in which an Instance of this Feature Definition must be created.
iParent: [in] A valid Facade bound to the Feature that will agregate the new Instance.
iKey: [in] The name of the component (or list of components) typed attribute that will be used for aggregation. In case of a list, the new Feature is added at the end of the list. The attribute value must otherwise be empty.
oInstance: [out] A (caller provided) Facade that will bound to the created Instance.
Notice that the Credentials of the provided Facade will not be used nor be modified.
If the method fails oInstance is not modified, it is otherwise overwritten with the retrieved value.

Returns:

An HRESULT value.
Legal values:

S_OK: The instantiation succeeded.
E_ABORT: The attribute is not a list and there is already a component.
E_ACCESSDENIED: Credentials do not grant access to the bound Feature, the target Container, the target Feature or its attribute.
E_FMINVALIDFEATURE: This Facade is not bound to a valid Base Feature.
E_FMTYPEMISMATCH: Attribute is not an aggregation attribute.
LCC_E_FAIL: The currently used license does not authorize the requested operation.
Other: Another failure has occured.

o IsValid

public IsValid(

)

Checks the Facade validity.
An Feature Definition (StartUp) Facade remains valid until the PLM session is closed.

Returns:

An boolean value.
Legal values:

TRUE: if the Facade is valid.
FALSE: if the Facade is invalid.

o operator!

public operator!(

)

Logical-negation (or logical-NOT) operator.
Role: Checks if the Facade is invalid.
An Feature Definition (StartUp) Facade remains valid until the PLM session is closed.

Returns:

An integer value.
Legal values:

1: if the Facade is invalid.
0: if the Facade is valid.

o operator=

public operator=( const iStartUpFacade)

Assignment operator.
Role: This method transforms this Facade to an exact copy of another Feature Definition (StartUp) Facade.
Both the Credentials and the bound Feature Definition are copied.

Parameters:

iStartUpFacade: [in] The Facade to copy.

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

FeatureModelerExt writeClassCharacteristic(); CATFmStartUpFacade

Constructor and Destructor Index

Method Index

Constructor and Destructor

Methods

FeatureModelerExt CATFmStartUpFacade