All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATEnsLogicalUseItf Interface CATIEnsLogPLMElectricalProperties

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

interface CATIEnsLogPLMElectricalProperties

Class to use the PLMEnsElectricalProperties extension on Logical Equipment.
Role This extension allows the creation and the manipulation of the Nominal Power Attribute on Logical Equipment.

Method Index

o AddElectricalExtension(): Creates the extension:
o GetNominalPower(CATICkeParm_var&): GetNominalPower: Gets the value of the electrical attribute object Nominal Power.
o HasElectricalExtension(CATBoolean&): Tests the existence of the extension from the object:
o RemoveElectricalExtension(): Removes the extension from the object:
o SetNominalPower(CATICkeParm_var&): SetNominalPowerAttribute: Sets the value of the electrical attribute object Nominal Power.

Methods

o AddElectricalExtension

public virtual AddElectricalExtension(

)

Creates the extension:

Returns:: S_OK if the creation succeeds.
E_FAIL otherwise.

o GetNominalPower

public virtual GetNominalPower( ospAttributeParm)

GetNominalPower: Gets the value of the electrical attribute object Nominal Power.

Parameters:

ospAttributeParm: Attribute value, must be passed set to NULL_var.

Returns:

S_OK if the method succeeds.
E_FAIL otherwise.

o HasElectricalExtension

public virtual HasElectricalExtension( oExists)

Tests the existence of the extension from the object:

Parameters:

oExists: The extension existence: TRUE if the Extension exists FALSE otherwise.

Returns:

S_OK if the method succeeds.
E_FAIL otherwise.

o RemoveElectricalExtension

public virtual RemoveElectricalExtension(

)

Removes the extension from the object:

Returns:: S_OK if the method succeeds.
E_FAIL otherwise.

o SetNominalPower

public virtual SetNominalPower( const ispAttributeValue)

SetNominalPowerAttribute: Sets the value of the electrical attribute object Nominal Power. If this attribute doesn't exist it will be created and setted to the value ispAttributeValue

Parameters:

ispAttributeValue: Attribute value.

Returns:

S_OK if the method succeeds.
E_INVALIDARG if the provided parameter is unexpected.
E_FAIL otherwise.

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