Teamcenter C++ API Reference  2312
Static Public Member Functions | Static Private Member Functions | List of all members
Teamcenter::ImpliedEffectivityCalc Class Reference

#include <ImpliedEffectivityCalc.hxx>

Static Public Member Functions

static void getImpliedEffectivity (tag_t revRule, const std::vector< tag_t > &itemRevs, std::vector< std::string > &effectivities)
 
static void getRevisionImpliedDateEffectivity (const tag_t &revRule, const tag_t &itemRev, bool &isRevRuleDateWithinRevImpliedEff, date_t &suggestedItemRevReleasedDateForRevRule, date_t &suggestedItemRevEffectiveDateForRevRule)
 

Static Private Member Functions

static void populateStatusWithRevision (tag_t revisionRule, const std::vector< tag_t > &items, std::vector< std::vector< std::pair< tag_t, tag_t > > > &revStats)
 

Detailed Description

Definition at line 49 of file ImpliedEffectivityCalc.hxx.

Member Function Documentation

static void Teamcenter::ImpliedEffectivityCalc::getImpliedEffectivity ( tag_t  revRule,
const std::vector< tag_t > &  itemRevs,
std::vector< std::string > &  effectivities 
)
static

Calculates the Implied Effectivity of the each input Item Revision.
To do so, it retrieves the Effectivity from the Release Status (Has Status, Any Status) objects of each Item Revision.

Exceptions
IFailexception with following errors.
  • #CFM_rev_rule_not_supported if the specified Revision Rule does not have "Has Status" or "Any Status" clause.
  • #PROP_invalid_object if an invalid object instance is used in conjunction with the property.
Parameters
revRule(I) Revison Rule based on which the Effectivities are to be calculated
itemRevs(I) Item Revisions for which the Effectivities needs to be calculated
effectivities(O) Array of Effectivities for the Item Revision
static void Teamcenter::ImpliedEffectivityCalc::getRevisionImpliedDateEffectivity ( const tag_t &  revRule,
const tag_t &  itemRev,
bool &  isRevRuleDateWithinRevImpliedEff,
date_t &  suggestedItemRevReleasedDateForRevRule,
date_t &  suggestedItemRevEffectiveDateForRevRule 
)
static
static void Teamcenter::ImpliedEffectivityCalc::populateStatusWithRevision ( tag_t  revisionRule,
const std::vector< tag_t > &  items,
std::vector< std::vector< std::pair< tag_t, tag_t > > > &  revStats 
)
staticprivate

Creates pair of item revision and release status object, pairs belong to one item are put into one vector.

Exceptions
IFailexception with following errors.
  • #CFM_rev_rule_not_supported if the specified Revision Rule does not have "Has Status" or "Any Status" clause.
  • #PROP_invalid_object if an invalid object instance is used in conjunction with the property.
Parameters
revisionRule(I) Revison Rule based on which effectivity will be calculated
items(I) Array of Items
revStats(O) This will be populated by this function. Each vector will contain pairs (item revision - release status) belong to one item

The documentation for this class was generated from the following file: