DELPPRSystemItf Interface DELIPPRRequirementMgt

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


interface DELIPPRRequirementMgt



Method Index


o GetListOfGlobalLinkedRequirements(CATIPLMNavReference*,CATListPtrCATBaseUnknown&,CATListPtrCATBaseUnknown&)
Gets the list of requirements linked to a given process, system or operation *reference with a global link with the list of associated connections
o GetListOfImplementingProcessReferences(CATBaseUnknown*,CATListPtrCATBaseUnknown&,CATListOfCATUnicodeString&,CATListPtrCATBaseUnknown&)
Returns the list of Process References linked to a given requirement through a Specification link
o GetListOfImplementingProcessReferencesForGlobalSpecification(CATBaseUnknown*,CATListPtrCATBaseUnknown&,CATListPtrCATBaseUnknown&)
Returns the list of Process References linked to a given requirement through a Global Specification link
o GetListOfImplementingSystemOperationReferences(CATBaseUnknown*,CATListPtrCATBaseUnknown&,CATListOfCATUnicodeString&,CATListPtrCATBaseUnknown&)
Returns the list of System/Operation References linked to the current requirement through a Specification link
o GetListOfImplementingSystemOperationReferencesForGlobalSpecification(CATBaseUnknown*,CATListPtrCATBaseUnknown&,CATListPtrCATBaseUnknown&)
Returns the list of System/Operation References linked to the current requirement through a Global Specification link
o GetListOfLinkedRequirements(CATIPLMNavReference*,CATListPtrCATBaseUnknown&,CATListPtrCATBaseUnknown&)
Gets the list of requirements linked to a given process, system or operation *reference and the list of associated connections.
o GlobalLinkToRequirement(CATIPLMNavReference*,CATBaseUnknown*)
Links a requirement entity to a given process, system or operation reference with a global link
o LinkToRequirement(CATIPLMNavReference*,CATBaseUnknown*,CATUnicodeString)
Links the input requirement to the Manufacturing System or Operation *reference
o RemoveAllGlobalLinksToRequirement(CATIPLMNavReference*)
Removes all global links to requirement
o RemoveAllLinksToRequirement(CATIPLMNavReference*)
Removes all the requirements linked to this reference
o RemoveGlobalLinkToRequirement(CATIPLMNavReference*,CATBaseUnknown*)
Removes the global link to the input requirement if any
o RemoveLinkToRequirement(CATIPLMNavReference*,CATBaseUnknown*,CATUnicodeString)
Remove the link to the input requirement if any

Methods


o GetListOfGlobalLinkedRequirements
public virtual GetListOfGlobalLinkedRequirements( ipiReference,
oListRequirements,
oListOfSpecifyHowToCnx)
Gets the list of requirements linked to a given process, system or operation *reference with a global link with the list of associated connections
Parameters:
ipiReference
The system, process or the operation reference
oListRequirements
The list of requirement
oListOfSpecifyHowToCnx
The list of associated connections
Returns:
S_OK
if there is at least one requirement *linked
S_FALSE
if there is no requirement
E_INVALIDARG
for an invalid argument
E_FAIL
if the method fails for any other reason
o GetListOfImplementingProcessReferences
public virtual GetListOfImplementingProcessReferences( iRequirementEntity,
oListOfProcessReferences,
oListOfUsages,
oListOfSpecifyHowToCnx)
Returns the list of Process References linked to a given requirement through a Specification link
Parameters:
iRequirementEntity
The given requirement entity
oListOfProcessReferences
list of linked process references
oListOfSpecifyHowToCnx
list of associated connections
Returns:
Legal values:
  • S_OK : The method successfully ended.
  • E_FAIL : An error occurred.
o GetListOfImplementingProcessReferencesForGlobalSpecification
public virtual GetListOfImplementingProcessReferencesForGlobalSpecification( iRequirementEntity,
oListOfProcessReferences,
oListOfSpecifyHowToCnx)
Returns the list of Process References linked to a given requirement through a Global Specification link
Parameters:
iRequirementEntity
The given requirement entity
oListOfProcessReferences
list of linked process references
oListOfSpecifyHowToCnx
list of associated connections
Returns:
Legal values:
  • S_OK : The method successfully ended.
  • E_FAIL : An error occurred.
o GetListOfImplementingSystemOperationReferences
public virtual GetListOfImplementingSystemOperationReferences( iRequirementEntity,
oListOfSystemOperationReferences,
oListOfUsages,
oListOfSpecifyHowToCnx)
Returns the list of System/Operation References linked to the current requirement through a Specification link
Parameters:
iRequirementEntity
The given requirement entity
oListOfSystemOperationReferences
list of linked system or operation references
oListOfSpecifyHowToCnx
list of associated connections
Returns:
Legal values:
  • S_OK : The method successfully ended.
  • E_FAIL : An error occurred.
o GetListOfImplementingSystemOperationReferencesForGlobalSpecification
public virtual GetListOfImplementingSystemOperationReferencesForGlobalSpecification( iRequirementEntity,
oListOfSystemOperationReferences,
oListOfSpecifyHowToCnx)
Returns the list of System/Operation References linked to the current requirement through a Global Specification link
Parameters:
iRequirementEntity
The given requirement entity
oListOfSystemOperationReferences
list of linked system or operation references
oListOfSpecifyHowToCnx
list of associated connections
Returns:
Legal values:
  • S_OK : The method successfully ended.
  • E_FAIL : An error occurred.
o GetListOfLinkedRequirements
public virtual GetListOfLinkedRequirements( ipiReference,
oListRequirements,
oListOfSpecifyHowToCnx)
Gets the list of requirements linked to a given process, system or operation *reference and the list of associated connections.
Parameters:
ipiReference
The system, process or the operation reference
oListRequirements
The list of requirement
oListOfSpecifyHowToCnx
The list of associated connections
Returns:
S_OK
if there is at least one requirement *linked
S_FALSE
if there is no requirement
E_INVALIDARG
for an invalid argument
E_FAIL
if the method fails for any other reason
o GlobalLinkToRequirement
public virtual GlobalLinkToRequirement( ipiReference,
iRequirementEntity)
Links a requirement entity to a given process, system or operation reference with a global link
Parameters:
ipiReference
The system, process or the operation reference
iRequirementEntity
The requirement entity to link
Returns:
S_OK
if the method succeeds
E_INVALIDARG
if the arguments are not valid
E_FAIL
if the method fails for any other reason
o LinkToRequirement
public virtual LinkToRequirement( ipiReference,
iRequirementEntity,
istrUsage)
Links the input requirement to the Manufacturing System or Operation *reference
Parameters:
ipiReference
The system, process or the operation reference
iRequirementEnt
The requirement entity
Returns:
Legal values:
  • S_OK : The method successfully ended.
  • E_INVALIDARG : The input is not a requirement
  • E_FAIL : An error occurred.
o RemoveAllGlobalLinksToRequirement
public virtual RemoveAllGlobalLinksToRequirement( ipiReference)
Removes all global links to requirement
Parameters:
ipiReference
The process, system or operation reference
Returns:
S_OK
if the method succeeds
S_FALSE
if the system or the operation has no *link to any requirements
E_FAIL
if the method fails for any other reason
o RemoveAllLinksToRequirement
public virtual RemoveAllLinksToRequirement( ipiReference)
Removes all the requirements linked to this reference
Parameters:
ipiReference
The process, system or operation reference
Returns:
Legal values:
  • S_OK : The method successfully ended.
  • S_FALSE : The Operation reference has no link to any requirement.
  • E_FAIL : An error occurred.
o RemoveGlobalLinkToRequirement
public virtual RemoveGlobalLinkToRequirement( ipiReference,
iRequirementEntity)
Removes the global link to the input requirement if any
Parameters:
ipiReference
The process, system or operation reference
iRequirementEntity
The requirement entity to remove
Returns:
S_OK
if the method succeeds
S_FALSE
if the system or the operation has *no link to the input requirement
E_INVALIDARG
if the arguments are not valid
E_FAIL
if the method fails for any other reason
o RemoveLinkToRequirement
public virtual RemoveLinkToRequirement( ipiReference,
iRequirementEntity,
istrUsage)
Remove the link to the input requirement if any
Parameters:
ipiReference
The system, process or the operation reference
iRequirementEnt
The requirement entity
Returns:
Legal values:
  • S_OK : The method successfully ended.
  • S_FALSE : The reference has no link to this requirement
  • E_INVALIDARG : The input is not a requirement
  • E_FAIL : An error occurred.

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

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.