All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVInterfaces Interface ENOVIABOPartReference

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATBaseDispatch
        |
        +---System.CATIABase
          |
          +---ENOVInterfaces.ENOVIABusinessObject
            |
            +---ENOVInterfaces.ENOVIABOVersionMaster
              |
              +---ENOVIABOPartReference
 

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


interface ENOVIABOPartReference

Interface to define the Business Object view of the reference of a Part.
Role : As every Business Object, this interface provides a userfriendly view of some modeler objects, to hide a certain complexity and to allow an easier use of methods. In this case, a Part Reference hides the two modeler objects PartMaster and PartVersion.

See also:
ENOVIABusinessObject, CATIAVPMPartMaster, CATIAVPMPartVersion


Method Index


o HasChildAbsolute(boolean&)
Indicates whether this version OR any other version of this part has at least one child.
o IsExposedBy(boolean&,ENOVIABODocument_var&)
Indicates whether the input document is exposed on this part.
o RemoveAlternate(long)
Removes an alternate Part Reference of the current one, located by its index in the list of alternate references.
o SetExposedBy(ENOVIABODocument_var&)
Set the expose link between a Part and a CATIA document.
o getLatestPartReferenceChildren(CATListPtrENOVIABO&,CATListPtrENOVIABO&)
Gets all the latest PartReferences children of the current PartReference, along with the quantity defined for each of them.
o get_Alternate(long,CATUnicodeString&,ENOVIABOPartReference*&)
Retrieves an alternate reference of the current reference located by its index in the list of alternate references.
o get_AlternateBase(long,CATUnicodeString&,ENOVIABOPartReference*&)
Retrieves an alternate base reference of the current one located by its index in the list of alternate base references.
o get_AlternateBaseCount(long&)
Retrieves the number of alternate base references of the current reference.
o get_AlternateCount(long&)
Retrieves the number of alternate references to this current one.
o get_Opposite(ENOVIABOPartReference*&)
Returns the opposite part.
o get_PartInstance(long,ENOVIABOPartInstance*&)
Retrieves an instance of the current reference located by its index in the list of instances.
o get_PartInstanceCount(long&)
Retrieves the number of instances of the current reference.
o put_Alternate(CATUnicodeString&,ENOVIABOPartReference*)
Sets a Part Reference as alternate of the current one.
o synchInstances(CATLISTV(CATBaseUnknown_var)&,CATLISTV(CATBaseUnknown_var)&)
synchronizes instances of this part.

Methods


o HasChildAbsolute
public virtual HRESULT __stdcall HasChildAbsolute(boolean& oHasChild) = 0
Indicates whether this version OR any other version of this part has at least one child.
Parameters:
oHasChild
TRUE or FALSE, as determined by this method.
Returns:
S_OK if no errors encountered during calculation of children. E_FAIL if error encountered.
o IsExposedBy
public virtual HRESULT __stdcall IsExposedBy(boolean& oIsExposed,
const ENOVIABODocument_var& idoc) = 0
Indicates whether the input document is exposed on this part. "is exposed" means that the CATIA geometry link exists between the part and the document. If no input document is supplied or if it is NULL_var, then the method returns true if there is an exposed document on the part. There can only be one exposed document on a part.
Parameters:
oIsExposed
- output - TRUE or FALSE, as determined by this method.
idoc
- input - document to check if it is exposed. If not supplied or input as NULL_var, oIsExposed simply indicates if there is an exposed document on this part.
Returns:
S_OK if no errors encountered during calculation of isExposedBy. E_FAIL if error encountered.
o RemoveAlternate
public virtual HRESULT __stdcall RemoveAlternate(long iIndex)= 0
Removes an alternate Part Reference of the current one, located by its index in the list of alternate references.
Parameters:
iIndex
The index of the aternate reference to remove.
Returns:
S_OK in case of success, E_FAIL in case of error.
o SetExposedBy
public virtual HRESULT __stdcall SetExposedBy( const ENOVIABODocument_var& idoc)= 0
Set the expose link between a Part and a CATIA document. Also known as the geometry link. Part must be locked by the current user and in an updatable lifecycle state. Document must already be attached to the part as a Representation document. No document can already be defined as exposed on this part.
Parameters:
iDoc
CATIA document (*.CATProduct or *.CATPart) to be set as exposed document
Returns:
S_OK if iDoc successfully set as exposed on this part. S_FALSE if any of the conditions (lock, updatable, etc) were not met. E_FAIL if any failures were encountered in the processing.
o getLatestPartReferenceChildren
public virtual HRESULT __stdcall getLatestPartReferenceChildren(CATListPtrENOVIABO& Children,
CATListPtrENOVIABO& ARAttributes)= 0
Gets all the latest PartReferences children of the current PartReference, along with the quantity defined for each of them.
Parameters:
Children
All the latest PartReferences children.
ARAttributes
All the assembly relations between the current PartReference and its children, to be casted into CATIVPMBOAttribute to get the values of attributes.
Returns:
S_OK if no errors encountered. E_ERROR if error encountered.
o get_Alternate
public virtual HRESULT __stdcall get_Alternate(long iIndex,
CATUnicodeString& oFullfilledRequirements,
ENOVIABOPartReference*& oAlternate)= 0
Retrieves an alternate reference of the current reference located by its index in the list of alternate references. This index is constrained by the number of alternates given by get_AlternateCount().
Parameters:
iIndex
The index of the alternate reference to retrieve. Must be between 1 and oNbAternates.
oFullfilledRequirements
The FullfilledRequirements of the alternate reference.
oAlternate
The alternate reference.
Returns:
S_OK in case of success, E_FAIL in case of error, for example if index is not in the bounds.
o get_AlternateBase
public virtual HRESULT __stdcall get_AlternateBase(long iIndex,
CATUnicodeString& oFullfilledRequirements,
ENOVIABOPartReference*& oPartReference)= 0
Retrieves an alternate base reference of the current one located by its index in the list of alternate base references. This index is constrained by the number of alternate base references given by get_AlternateBaseCount().
Parameters:
iIndex
The index of the alternate base reference to get.
oFullfilledRequirements
The FullfilledRequirements of the alternate base reference.
oPartReference
The alternate base reference to get.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_AlternateBaseCount
public virtual HRESULT __stdcall get_AlternateBaseCount(long& oNbAlternateBase)= 0
Retrieves the number of alternate base references of the current reference.
Parameters:
oNbAlternateBase
Number of alternate base references.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_AlternateCount
public virtual HRESULT __stdcall get_AlternateCount(long& oNbAternates)= 0
Retrieves the number of alternate references to this current one.
Parameters:
oNbAternates
The number of alternate references.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_Opposite
public virtual HRESULT __stdcall get_Opposite(ENOVIABOPartReference*& oOpposite)= 0
Returns the opposite part.
Parameters:
oOpposite
the opposite part
Returns:
S_OK if no errors encountered. E_ERROR if error encountered.
o get_PartInstance
public virtual HRESULT __stdcall get_PartInstance(long iIndex,
ENOVIABOPartInstance*& oInstance)= 0
Retrieves an instance of the current reference located by its index in the list of instances. This index is constrained by the number of instances given by get_PartInstanceCount().
Parameters:
iIndex
The index of the instance to retrieve. Must be between 1 and oNbInstances.
oInstance
The instance of the reference.
Returns:
S_OK in case of success, E_FAIL in case of error, for example if index is not in the bounds.
o get_PartInstanceCount
public virtual HRESULT __stdcall get_PartInstanceCount(long& oNbInstances)= 0
Retrieves the number of instances of the current reference.
Parameters:
oNbInstances
The number of instances.
Returns:
S_OK in case of success, E_FAIL in case of error. S_FALSE in case there are no instances.
o put_Alternate
public virtual HRESULT __stdcall put_Alternate( const CATUnicodeString& iFullfilledRequirements,
ENOVIABOPartReference* iPartReference)= 0
Sets a Part Reference as alternate of the current one.
Parameters:
iFullfilledRequirements
The FullfilledRequirements of the Aternate Reference.
iPartReference
The Part Reference which will be an alternate part of the current one.
Returns:
S_OK in case of success, E_FAIL in case of error.
o synchInstances
public virtual HRESULT __stdcall synchInstances(CATLISTV(CATBaseUnknown_var)& iPRC,
CATLISTV(CATBaseUnknown_var)& oListII)= 0
synchronizes instances of this part.
Parameters:
iPRC
list of PRCs to synch (if 1st item in list NULL_var then all PRC will be done, if size of list 0 then none done))
oListII
list of IIs that couldn't be synched (due to locking)
Returns:
S_OK if no errors encountered. E_ERROR if error encountered.

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

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