Teamcenter C++ API Reference  2312
Public Member Functions | List of all members
Teamcenter::EquivalenceService Class Referenceabstract

#include <EquivalenceService.hxx>

Public Member Functions

virtual int getEquivalenceParameters (EquivalenceServiceInfo &info) const =0
 
virtual int getEquivalenceParameters (EquivalenceServiceInfo2 &info2) const =0
 
virtual int getEquivalentNodes (const std::vector< tag_t > &srcScopes, const std::string &closureRuleName, const std::vector< tag_t > &targetScopes, const std::string &targetClosureRuleName, const std::set< std::string > &criteriaNames, int srcDepth, int targetDepth, bool bForceTargetExpand, std::map< tag_t, std::set< tag_t > > &targetMatches, std::map< tag_t, std::set< tag_t > > *srcMatches=0, tag_t srcCtxt=NULLTAG, tag_t targetCtxt=NULLTAG)=0
 
virtual int getEquivalentNodes (const std::set< tag_t > &expandedSrcNodes, const std::vector< tag_t > &targetScopes, const std::string &targetClosureRuleName, const std::set< std::string > &criteriaNames, bool bForceTargetExpand, int targetDepth, std::map< tag_t, std::set< tag_t > > &targetMatches, std::map< tag_t, std::set< tag_t > > *srcMatches=0, tag_t srcCtxt=NULLTAG, tag_t targetCtxt=NULLTAG)=0
 
virtual int getEquivalentNodes (const std::set< tag_t > &expandedSrcNodes, const std::set< tag_t > &expandedTargetNodes, const std::set< std::string > &criteriaNames, std::map< tag_t, std::set< tag_t > > &targetMatches, std::map< tag_t, std::set< tag_t > > *srcMatches=0, tag_t srcCtxt=NULLTAG, tag_t targetCtxt=NULLTAG)=0
 
virtual int getEquivalentNodes (const std::vector< tag_t > &srcScopes, const std::string &closureRuleName, const std::vector< tag_t > &targetScopes, int srcDepth, const std::set< std::string > &criteriaNames, std::map< tag_t, std::set< tag_t > > &targetMatches, std::map< tag_t, std::set< tag_t > > *srcMatches=0, tag_t srcCtxt=NULLTAG, tag_t targetCtxt=NULLTAG)=0
 
virtual int getEquivalentNodes (const std::set< tag_t > &, const std::vector< tag_t > &, const std::set< std::string > &, std::map< tag_t, std::set< tag_t > > &, std::map< tag_t, std::set< tag_t > > *=0, tag_t srcCtxt=NULLTAG, tag_t targetCtxt=NULLTAG)=0
 
virtual int getEquivalentNodes (const std::set< tag_t > &srcNodes, const std::vector< tag_t > &tgtScopes, const std::set< std::string > &criteriaNames, std::map< tag_t, std::set< tag_t > > &tgtMatch, std::map< tag_t, std::set< tag_t > > *srcMatch=0, std::map< std::string, std::vector< std::string > > *additionalCriteria=0, tag_t srcCtxt=NULLTAG, tag_t targetCtxt=NULLTAG, int targetDepth=0)=0
 
virtual int getEquivalentNodes (const std::set< tag_t > &expandedSrcNodes, const std::set< tag_t > &expandedTargetNodes, std::map< tag_t, std::set< tag_t > > &targetMatches, std::set< tag_t > *missingInTarget=0, std::set< tag_t > *missingInSrc=0, std::map< tag_t, std::set< tag_t > > *srcMatches=0, const std::set< std::string > *criteriaNames=0, tag_t srcCtxt=NULLTAG, tag_t targetCtxt=NULLTAG)=0
 
virtual int getExpandedSrcNodes (std::set< tag_t > &nodes)=0
 
virtual int getExpandedTargetNodes (std::set< tag_t > &nodes)=0
 
virtual int populateTargetNodes (std::set< tag_t > &)=0
 
virtual ~EquivalenceService ()
 

Detailed Description

Definition at line 71 of file EquivalenceService.hxx.

Constructor & Destructor Documentation

virtual Teamcenter::EquivalenceService::~EquivalenceService ( )
virtual

Member Function Documentation

virtual int Teamcenter::EquivalenceService::getEquivalenceParameters ( EquivalenceServiceInfo &  info) const
pure virtual
virtual int Teamcenter::EquivalenceService::getEquivalenceParameters ( EquivalenceServiceInfo2 &  info2) const
pure virtual

Retrieves the results of the criteria as defined in the provided structure.

Returns
  • #ITK_ok on success.
  • #COLLABCTX_no_property_specified_for_comparison if no property is specified for comparison in the criteria of the structure info2.
  • #COLLABCTX_invalid_property_for_object_type if the properties specified in the criteria of the structure info2 are invalid.
Parameters
info2(IO) The results of the criteria as defined in the provided structure
virtual int Teamcenter::EquivalenceService::getEquivalentNodes ( const std::vector< tag_t > &  srcScopes,
const std::string &  closureRuleName,
const std::vector< tag_t > &  targetScopes,
const std::string &  targetClosureRuleName,
const std::set< std::string > &  criteriaNames,
int  srcDepth,
int  targetDepth,
bool  bForceTargetExpand,
std::map< tag_t, std::set< tag_t > > &  targetMatches,
std::map< tag_t, std::set< tag_t > > *  srcMatches = 0,
tag_t  srcCtxt = NULLTAG,
tag_t  targetCtxt = NULLTAG 
)
pure virtual
virtual int Teamcenter::EquivalenceService::getEquivalentNodes ( const std::set< tag_t > &  expandedSrcNodes,
const std::vector< tag_t > &  targetScopes,
const std::string &  targetClosureRuleName,
const std::set< std::string > &  criteriaNames,
bool  bForceTargetExpand,
int  targetDepth,
std::map< tag_t, std::set< tag_t > > &  targetMatches,
std::map< tag_t, std::set< tag_t > > *  srcMatches = 0,
tag_t  srcCtxt = NULLTAG,
tag_t  targetCtxt = NULLTAG 
)
pure virtual
virtual int Teamcenter::EquivalenceService::getEquivalentNodes ( const std::set< tag_t > &  expandedSrcNodes,
const std::set< tag_t > &  expandedTargetNodes,
const std::set< std::string > &  criteriaNames,
std::map< tag_t, std::set< tag_t > > &  targetMatches,
std::map< tag_t, std::set< tag_t > > *  srcMatches = 0,
tag_t  srcCtxt = NULLTAG,
tag_t  targetCtxt = NULLTAG 
)
pure virtual
virtual int Teamcenter::EquivalenceService::getEquivalentNodes ( const std::vector< tag_t > &  srcScopes,
const std::string &  closureRuleName,
const std::vector< tag_t > &  targetScopes,
int  srcDepth,
const std::set< std::string > &  criteriaNames,
std::map< tag_t, std::set< tag_t > > &  targetMatches,
std::map< tag_t, std::set< tag_t > > *  srcMatches = 0,
tag_t  srcCtxt = NULLTAG,
tag_t  targetCtxt = NULLTAG 
)
pure virtual
virtual int Teamcenter::EquivalenceService::getEquivalentNodes ( const std::set< tag_t > &  ,
const std::vector< tag_t > &  ,
const std::set< std::string > &  ,
std::map< tag_t, std::set< tag_t > > &  ,
std::map< tag_t, std::set< tag_t > > *  = 0,
tag_t  srcCtxt = NULLTAG,
tag_t  targetCtxt = NULLTAG 
)
pure virtual
virtual int Teamcenter::EquivalenceService::getEquivalentNodes ( const std::set< tag_t > &  srcNodes,
const std::vector< tag_t > &  tgtScopes,
const std::set< std::string > &  criteriaNames,
std::map< tag_t, std::set< tag_t > > &  tgtMatch,
std::map< tag_t, std::set< tag_t > > *  srcMatch = 0,
std::map< std::string, std::vector< std::string > > *  additionalCriteria = 0,
tag_t  srcCtxt = NULLTAG,
tag_t  targetCtxt = NULLTAG,
int  targetDepth = 0 
)
pure virtual

Retrieves the Equivalent Nodes when the source is expanded but the target is not.

Returns
  • #ITK_ok on success.
  • #RLZ0REALIZATION_invalid_input if srcNodes or tgtScopes is invalid.
  • #MDL0MODEL_null_tag if srcNodes or tgtScopes is #NULLTAG.
  • #COLLABCTX_no_property_specified_for_comparison if no property is specified for comparison in the map additionalCriteria.
  • #COLLABCTX_invalid_property_for_object_type if the properties specified in the map additionalCriteria are invalid.
Parameters
srcNodes(I) The source nodes
tgtScopes(I) The targets scopes
criteriaNames(I) The criteria names
tgtMatch(O) The targets matching each input source
srcMatch(O) The matching sources to each target
additionalCriteria(I) A map of property type to list of properties
srcCtxt(I) The Source Context
targetCtxt(I) The Target Context.
targetDepth(I) The Target depth to represent the level of target structure.
virtual int Teamcenter::EquivalenceService::getEquivalentNodes ( const std::set< tag_t > &  expandedSrcNodes,
const std::set< tag_t > &  expandedTargetNodes,
std::map< tag_t, std::set< tag_t > > &  targetMatches,
std::set< tag_t > *  missingInTarget = 0,
std::set< tag_t > *  missingInSrc = 0,
std::map< tag_t, std::set< tag_t > > *  srcMatches = 0,
const std::set< std::string > *  criteriaNames = 0,
tag_t  srcCtxt = NULLTAG,
tag_t  targetCtxt = NULLTAG 
)
pure virtual
virtual int Teamcenter::EquivalenceService::getExpandedSrcNodes ( std::set< tag_t > &  nodes)
pure virtual
virtual int Teamcenter::EquivalenceService::getExpandedTargetNodes ( std::set< tag_t > &  nodes)
pure virtual
virtual int Teamcenter::EquivalenceService::populateTargetNodes ( std::set< tag_t > &  )
pure virtual
The documentation for this class was generated from the following file: