All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATPlantShipInterfaces Interface CATIPspFunctional

System.IUnknown
  |
  +---CATIPspFunctional
 

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


interface CATIPspFunctional

Interface to access Plant Ship functional object information.
Role: To access Plant Ship object information.


Method Index


o CanBeRealizedBy(CATIUnknownList*,CATListOfInt*&)
Check if this function can be realized by the input list of physical objects.
o GetCatalogPartName(CATUnicodeString&)
Get catalog part name of physical object that realizes this function.
o GetFilterAttributes(CATListValCATUnicodeString*&,CATListValCATUnicodeString*&)
Get filter attributes.
o GetFunctionStatus(CATPspFunctionStatus&)
Get function object status.
o GetPartCatalogName(CATUnicodeString&)
Get physical part catalog name.
o GetPartNumber(CATUnicodeString&)
Get part number of physical object that realizes this function.
o GetPartType(CATUnicodeString&)
Get the part type of physical object that realizes this function.
o GetStandard(CATUnicodeString&)
Get Standard name.
o IsOKToIntegrate(CATBoolean&)
Is it OK to integrate (realize) this function with a physical part.
o IsRealized(CATBoolean&)
Is this function realized by a placed part.
o IsSpecDriven(CATBoolean&)
Is functional object specification driven.
o ListCompatiblePartNumbers(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATListValCATUnicodeString*&,CATListValCATUnicodeString*&,CATIUnknownList*)
Get all the physical part numbers compatible to the given PartType, Standard and Catalog.
o ListCompatiblePartTypes(CATUnicodeString&,CATListValCATUnicodeString*&)
Get all physical part types that are compatible for this function.
o ListPhysicalAttributes(CATListValCATUnicodeString*&,CATListValCATUnicodeString*&)
List physical attributes.
o ListPhysicals(CATIUnknownList*&)
Get all associated physical objects.
o SetCatalogPartName(CATUnicodeString&)
Set catalog part name.
o SetFilterAttributes(CATListValCATUnicodeString*,CATListValCATUnicodeString*)
Set filter attributes.
o SetIntegrationStatus(CATBoolean)
Set the integration status.
o SetPartCatalogName(CATUnicodeString&)
Set part catalog name.
o SetPartNumber(CATUnicodeString&)
Set part number.
o SetPartType(CATUnicodeString&)
Set part type.
o SetStandard(CATUnicodeString&)
Set standard.

Methods


o CanBeRealizedBy
public virtual HRESULT CanBeRealizedBy( const CATIUnknownList* iListOfPhysicals,
CATListOfInt*& oListOfStatus)=0
Check if this function can be realized by the input list of physical objects.
Parameters:
iListOfPhysicals
A list of physical objects.
oListOfStatus
A list of status 1: can be realized. 0: can not be realized.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o GetCatalogPartName
public virtual HRESULT GetCatalogPartName(CATUnicodeString& ouCatalogPartName)=0
Get catalog part name of physical object that realizes this function.
Parameters:
ouCatalogPartName
Catalog part name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o GetFilterAttributes
public virtual HRESULT GetFilterAttributes(CATListValCATUnicodeString*& oListOfFilterAttrNames,
CATListValCATUnicodeString*& oListOfFilterAttrValues)=0
Get filter attributes.
Parameters:
oListOfFilterAttrNames
List of Filter Attribute names.
oListOfFilterAttrValues
List of Filter Attribute values.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o GetFunctionStatus
public virtual HRESULT GetFunctionStatus(CATPspFunctionStatus& oStatus)=0
Get function object status.
Parameters:
oStatus
Function object status.
See also:
CATPspFunctionStatus
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o GetPartCatalogName
public virtual HRESULT GetPartCatalogName(CATUnicodeString& ouCatalogName)=0
Get physical part catalog name.
Parameters:
ouCatalogName
Part Catalog Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o GetPartNumber
public virtual HRESULT GetPartNumber(CATUnicodeString& ouPartNumber)=0
Get part number of physical object that realizes this function.
Parameters:
ouPartNumber
Part number.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o GetPartType
public virtual HRESULT GetPartType(CATUnicodeString& ouPartType)=0
Get the part type of physical object that realizes this function.
Parameters:
ouPartType
Part type.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o GetStandard
public virtual HRESULT GetStandard(CATUnicodeString& ouStandard)=0
Get Standard name.
Parameters:
ouStandard
Standard name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o IsOKToIntegrate
public virtual HRESULT IsOKToIntegrate(CATBoolean& oStatus)=0
Is it OK to integrate (realize) this function with a physical part.
Parameters:
oStatus
True or False.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o IsRealized
public virtual HRESULT IsRealized(CATBoolean& oStatus)=0
Is this function realized by a placed part.
Parameters:
oStatus
TRUE if this object has placed part.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o IsSpecDriven
public virtual HRESULT IsSpecDriven(CATBoolean& oStatus)=0
Is functional object specification driven.
Parameters:
oStatus
TRUE if this object is specification driven.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE
operation failed
o ListCompatiblePartNumbers
public virtual HRESULT ListCompatiblePartNumbers( const CATUnicodeString& iuPartType,
const CATUnicodeString& iuStandard,
const CATUnicodeString& iuCatalogName,
CATListValCATUnicodeString*& oListOfCatalogPartNames,
CATListValCATUnicodeString*& oListOfPartNumbers,
const CATIUnknownList* ipiListOverrideParameters= NULL )=0
Get all the physical part numbers compatible to the given PartType, Standard and Catalog.
Parameters:
iuPartType
Part type.
iuStandard
Standard name.
iuCatalogName
Catalog name.
oListOfCatalogPartNames
A list of compatible part names.
oListOfPartNumbers
A list of compatible part numbers.
ipiListOverrideParameters
Optional input list of parameters to override.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListCompatiblePartTypes
public virtual HRESULT ListCompatiblePartTypes( const CATUnicodeString& iuStandard,
CATListValCATUnicodeString*& oListOfPartTypes)=0
Get all physical part types that are compatible for this function.
Parameters:
iuStandard
Standard name.
oListOfPartTypes
A list of compatible part types.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListPhysicalAttributes
public virtual HRESULT ListPhysicalAttributes(CATListValCATUnicodeString*& oListOfPhysAttrNames,
CATListValCATUnicodeString*& oListOfPhysAttrValues)=0
List physical attributes.
Parameters:
oListOfPhysAttrNames
Physical part's attribute names.
oListOfPhysAttrValues
Physical part's attribute values.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o ListPhysicals
public virtual HRESULT ListPhysicals(CATIUnknownList*& oListOfPhysicals)=0
Get all associated physical objects.
Parameters:
oListOfPhysicals
[out, IUnknown#Release] A list of physical objects
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL/dt>
operation failed
o SetCatalogPartName
public virtual HRESULT SetCatalogPartName( const CATUnicodeString& iuCatalogPartName)=0
Set catalog part name.
Parameters:
iuCatalogPartName
Catalog part name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o SetFilterAttributes
public virtual HRESULT SetFilterAttributes( const CATListValCATUnicodeString* iListOfFilterAttrNames,
const CATListValCATUnicodeString* iListOfFilterAttrValues)=0
Set filter attributes.
Parameters:
iListOfFilterAttrNames,
iListOfFilterAttrValues Filter Attributes.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o SetIntegrationStatus
public virtual HRESULT SetIntegrationStatus(CATBoolean iStatus)=0
Set the integration status.
Parameters:
iStatus
True or False.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o SetPartCatalogName
public virtual HRESULT SetPartCatalogName( const CATUnicodeString& iuCatalogName)=0
Set part catalog name.
Parameters:
iuCatalogName
Part Catalog Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o SetPartNumber
public virtual HRESULT SetPartNumber( const CATUnicodeString& iuPartNumber)=0
Set part number.
Parameters:
iuPartNumber
Part number.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o SetPartType
public virtual HRESULT SetPartType( const CATUnicodeString& iuPartType)=0
Set part type.
Parameters:
iuPartType
Part type.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed
o SetStandard
public virtual HRESULT SetStandard( const CATUnicodeString& iuStandard)=0
Set standard.
Parameters:
iuStandard
Standard.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FALSE/dt>
operation failed

This object is included in the file: CATIPspFunctional.h

Copyright © 2003, Dassault Systèmes. All rights reserved.