Represents a builder class that performs variant rule configuration. More...

Inheritance diagram for NXOpen::PDM::VariantConfigurationBuilder:

Public Member Functions
void	AddMultipleVariantRules (const std::vector< NXString > &contextIds, const std::vector< NXString > &variantRules)
	Adds given variant rules in case of multiple variant rules to NXOpen::PDM::VariantConfigurationBuilder The input contextIds comprising of multifield key and itemRev_id: In case of default domain: contextId should contain Teamcenter item ID. More...

std::vector< NXString >	AskAvailableVariantRules (const NXString &contextId, const NXString &revId)
	Returns the saved variant rules for the give context ID The input contextId: In case of default domain: it should be Teamcenter item ID. More...

std::vector< NXString >	AskAvailableVariantRules (const char contextId, const char revId)
	Returns the saved variant rules for the give context ID The input contextId: In case of default domain: it should be Teamcenter item ID. More...

void	GetVariantRuleTableInformation (std::vector< NXString > &contextIds, std::vector< NXString > &variantRules)
	Returns selected variant rules stored inside NXOpen::PDM::VariantConfigurationBuilder The input contextIds comprising of multifield key and itemRev_id: In case of default domain: contextId should contain Teamcenter item ID. More...

void	RemoveVariantRule (const NXString &contextId, const NXString &variantRule)
	Removes the given variant rule from NXOpen::PDM::VariantConfigurationBuilder if applicable The input contextId comprising of multifield key and itemRev_id: In case of default domain: contextId should contain Teamcenter item ID. More...

void	RemoveVariantRule (const char contextId, const char variantRule)
	Removes the given variant rule from NXOpen::PDM::VariantConfigurationBuilder if applicable The input contextId comprising of multifield key and itemRev_id: In case of default domain: contextId should contain Teamcenter item ID. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a builder class that performs variant rule configuration.

Created in NX9.0.0.

Member Function Documentation

void NXOpen::PDM::VariantConfigurationBuilder::AddMultipleVariantRules	(	const std::vector< NXString > &	contextIds,
		const std::vector< NXString > &	variantRules
	)

Adds given variant rules in case of multiple variant rules to NXOpen::PDM::VariantConfigurationBuilder The input contextIds comprising of multifield key and itemRev_id: In case of default domain: contextId should contain Teamcenter item ID.

In case of non-default domain: contextId should contain the multifield keys. e.g. %MFK#%,=item_id=001, object_type=SupplierPart, supplier_code=x

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

contextIds	context id comprising of multifield key and itemRev_id in which variant rule resides
variantRules	variant rules of corresponding context ids to be added

std::vector<NXString> NXOpen::PDM::VariantConfigurationBuilder::AskAvailableVariantRules	(	const NXString &	contextId,
		const NXString &	revId
	)

Returns the saved variant rules for the give context ID The input contextId: In case of default domain: it should be Teamcenter item ID.

In case of non-default domain: it should be the multifield key. e.g. %MFK#%,=item_id=001, object_type=SupplierPart, supplier_code=x

Returns: variant rules from the given context
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

contextId	multifield key in case of product assembly or collaborative design id
revId	itemRev_id in case of product assembly

std::vector<NXString> NXOpen::PDM::VariantConfigurationBuilder::AskAvailableVariantRules	(	const char *	contextId,
		const char *	revId
	)

Returns the saved variant rules for the give context ID The input contextId: In case of default domain: it should be Teamcenter item ID.

In case of non-default domain: it should be the multifield key. e.g. %MFK#%,=item_id=001, object_type=SupplierPart, supplier_code=x

Returns: variant rules from the given context
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

contextId	multifield key in case of product assembly or collaborative design id
revId	itemRev_id in case of product assembly

void NXOpen::PDM::VariantConfigurationBuilder::GetVariantRuleTableInformation	(	std::vector< NXString > &	contextIds,
		std::vector< NXString > &	variantRules
	)

Returns selected variant rules stored inside NXOpen::PDM::VariantConfigurationBuilder The input contextIds comprising of multifield key and itemRev_id: In case of default domain: contextId should contain Teamcenter item ID.

In case of non-default domain: contextId should contain the multifield keys. e.g. %MFK#%,=item_id=001, object_type=SupplierPart, supplier_code=x

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

contextIds	array of contextIds comprising of multifield key and itemRev_id from which variant rules are selected
variantRules	array of selected variant rules

void NXOpen::PDM::VariantConfigurationBuilder::RemoveVariantRule	(	const NXString &	contextId,
		const NXString &	variantRule
	)

Removes the given variant rule from NXOpen::PDM::VariantConfigurationBuilder if applicable The input contextId comprising of multifield key and itemRev_id: In case of default domain: contextId should contain Teamcenter item ID.

In case of non-default domain: contextId should contain the multifield keys. e.g. %MFK#%,=item_id=001, object_type=SupplierPart, supplier_code=x

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

contextId	context id comprising of multifield key and itemRev_id in which variant rule resides
variantRule	variant rule to be removed

void NXOpen::PDM::VariantConfigurationBuilder::RemoveVariantRule	(	const char *	contextId,
		const char *	variantRule
	)

Removes the given variant rule from NXOpen::PDM::VariantConfigurationBuilder if applicable The input contextId comprising of multifield key and itemRev_id: In case of default domain: contextId should contain Teamcenter item ID.

In case of non-default domain: contextId should contain the multifield keys. e.g. %MFK#%,=item_id=001, object_type=SupplierPart, supplier_code=x

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

contextId	context id comprising of multifield key and itemRev_id in which variant rule resides
variantRule	variant rule to be removed

virtual bool NXOpen::PDM::VariantConfigurationBuilder::Validate ( )

virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns: Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

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

PDM_VariantConfigurationBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation