VPLMRequirementModelerItf Interface PLMIReqStructuralEntity

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

interface PLMIReqStructuralEntity

Interface to Navigate from a Requirement-related object up/down the DAG structure (Direct Acyclic Graph) it belongs to.
Role: The structural entities are the Requirements, but also the other types of objects belonging to the Requirement Central data model. So, this includes the following types, and the types deriving from them (either provided by DS, either specialized in customized environments) :

Some information is also provided about its high-level classification within the Requirements model (i.e. one of the high-level types).

Method Index


o GetReqChildren(CATLISTV(CATBaseUnknown_var)*,CATLISTV(CATBaseUnknown_var)*,PLMReqRelationClassification)
Navigate from a Requirement-related object down the structure it belongs to.
o GetReqChildrenEntities(CATLISTV(CATBaseUnknown_var)&,PLMReqRelationClassification)
Navigate from a Requirement-related object down the structure it belongs to.
o GetReqChildrenRelations(CATLISTV(CATBaseUnknown_var)&,PLMReqRelationClassification)
Navigate from a Requirement-related object down the structure it belongs to.
o GetReqClassification(PLMReqEntityClassification&)
Gets the high-level classification within the Requirements model.
o GetReqParents(CATLISTV(CATBaseUnknown_var)*,CATLISTV(CATBaseUnknown_var)*,PLMReqRelationClassification)
Navigate from a Requirement-related object up the structure it belongs to.
o GetReqParentsEntities(CATLISTV(CATBaseUnknown_var)&,PLMReqRelationClassification)
Navigate from a Requirement-related object up the structure it belongs to.
o GetReqParentsRelations(CATLISTV(CATBaseUnknown_var)&,PLMReqRelationClassification)
Navigate from a Requirement-related object up the structure it belongs to.

Methods


o GetReqChildren
public virtual HRESULT GetReqChildren(CATLISTV(CATBaseUnknown_var)* oChildrenRels,
CATLISTV(CATBaseUnknown_var)* oChildren,
PLMReqRelationClassification iRelClassif= PLMReqRelationClassification_Unknown )= 0
Navigate from a Requirement-related object down the structure it belongs to.
Parameters:
oChildrenRels
pointer to gain the list of direct children relations over the entity (might be NULL).
oChildren
pointer to gain the list of direct children entities over the entity (might be NULL).
iRelClassif
Specific Relation Classification used to filter (default PLMReqRelationClassification_Unknown means that all relations are considered).
Returns:
An HRESULT value.
Legal Values:
E_FAIL
If both pointers are NULL
S_OK
Otherwise
o GetReqChildrenEntities
public virtual HRESULT GetReqChildrenEntities(CATLISTV(CATBaseUnknown_var)& oChildren,
PLMReqRelationClassification iRelClassif= PLMReqRelationClassification_Unknown )= 0
Navigate from a Requirement-related object down the structure it belongs to.
Parameters:
oChildren
list of direct children entities below the entity.
iRelClassif
Specific Relation Classification used to filter (default PLMReqRelationClassification_Unknown means that all relations are considered).
Returns:
An HRESULT value.
Legal Values:
S_OK
Always
o GetReqChildrenRelations
public virtual HRESULT GetReqChildrenRelations(CATLISTV(CATBaseUnknown_var)& oChildrenRels,
PLMReqRelationClassification iRelClassif= PLMReqRelationClassification_Unknown )= 0
Navigate from a Requirement-related object down the structure it belongs to.
Parameters:
oChildrenRels
list of direct children relations below the entity.
iRelClassif
Specific Relation Classification used to filter (default PLMReqRelationClassification_Unknown means that all relations are considered).
Returns:
An HRESULT value.
Legal Values:
S_OK
Always
o GetReqClassification
public virtual HRESULT GetReqClassification(PLMReqEntityClassification& oClassification)= 0
Gets the high-level classification within the Requirements model.
Parameters:
oClassification
classification of the entity.
  • PLMReqEntityClassification_ReqGroup Specification Folder
  • PLMReqEntityClassification_ReqSpec Requirement Specification
  • PLMReqEntityClassification_Chapter Chapter
  • PLMReqEntityClassification_Comment Comment
  • PLMReqEntityClassification_Requirement Requirement
Returns:
An HRESULT value.
Legal Values:
S_OK
Always
o GetReqParents
public virtual HRESULT GetReqParents(CATLISTV(CATBaseUnknown_var)* oParentsRels,
CATLISTV(CATBaseUnknown_var)* oParents,
PLMReqRelationClassification iRelClassif= PLMReqRelationClassification_Unknown )= 0
Navigate from a Requirement-related object up the structure it belongs to.
Parameters:
oParentsRels
pointer to gain the list of direct parent relations over the entity (might be NULL).
oParents
pointer to gain the list of direct parent entities over the entity (might be NULL).
iRelClassif
Specific Relation Classification used to filter (default PLMReqRelationClassification_Unknown means that all relations are considered).
Returns:
An HRESULT value.
Legal Values:
E_FAIL
If both pointers are NULL
S_OK
Otherwise
o GetReqParentsEntities
public virtual HRESULT GetReqParentsEntities(CATLISTV(CATBaseUnknown_var)& oParents,
PLMReqRelationClassification iRelClassif= PLMReqRelationClassification_Unknown )= 0
Navigate from a Requirement-related object up the structure it belongs to.
Parameters:
oParents
list of direct parent entities over the entity.
iRelClassif
Specific Relation Classification used to filter (default PLMReqRelationClassification_Unknown means that all relations are considered).
Returns:
An HRESULT value.
Legal Values:
S_OK
Always
o GetReqParentsRelations
public virtual HRESULT GetReqParentsRelations(CATLISTV(CATBaseUnknown_var)& oParentsRels,
PLMReqRelationClassification iRelClassif= PLMReqRelationClassification_Unknown )= 0
Navigate from a Requirement-related object up the structure it belongs to.
Parameters:
oParentsRels
list of direct parent relations over the entity.
iRelClassif
Specific Relation Classification used to filter (default PLMReqRelationClassification_Unknown means that all relations are considered).
Returns:
An HRESULT value.
Legal Values:
S_OK
Always
This object is included in the file: PLMIReqStructuralEntity.h
If needed, your Imakefile.mk should include the module: VPLMRequirementModelerItf

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