NXOpen::AME::NamingRuleBuilder Class Reference

Naming Rule Builder
To create a new instance of this class, use NXOpen::AME::NamingRuleListBuilder::CreateRule

Created in NX11.0.0. More...

Inheritance diagram for NXOpen::AME::NamingRuleBuilder:

Public Member Functions
NXOpen::AME::SelectClassificationBuilder *	ClassificationItem ()
	Returns the classification item Created in NX11.0.0. More...
NXString	EoName ()
	Returns the engineering object name Created in NX11.0.0. More...
int	IndexDigitsInFunction ()
	Returns the index display digits in function aspect Created in NX11.0.0. More...
int	IndexDigitsInLocation ()
	Returns the index display digits in location aspect Created in NX11.0.0. More...
int	IndexDigitsInProduct ()
	Returns the index display digits in product aspect Created in NX11.0.0. More...
int	IndexIncrementInFunction ()
	Returns the index increment in function aspect Created in NX11.0.0. More...
int	IndexIncrementInLocation ()
	Returns the index increment in location aspect Created in NX11.0.0. More...
int	IndexIncrementInProduct ()
	Returns the index increment in product aspect Created in NX11.0.0. More...
NXString	NameInFunction ()
	Returns the name in function aspect Created in NX11.0.0. More...
NXString	NameInLocation ()
	Returns the name in location aspect Created in NX11.0.0. More...
NXString	NameInProduct ()
	Returns the name in product aspect Created in NX11.0.0. More...
NXString	SelectedClassification ()
	Returns the Classification ID Created in NX11.0.0. More...
void	SetEoName (const NXString &eoName)
	Sets the engineering object name Created in NX11.0.0. More...
void	SetEoName (const char *eoName)
	Sets the engineering object name Created in NX11.0.0. More...
void	SetIndexDigitsInFunction (int indexIncrement)
	Sets the index display digits in function aspect Created in NX11.0.0. More...
void	SetIndexDigitsInLocation (int indexIncrement)
	Sets the index display digits in location aspect Created in NX11.0.0. More...
void	SetIndexDigitsInProduct (int indexIncrement)
	Sets the index display digits in product aspect Created in NX11.0.0. More...
void	SetIndexIncrementInFunction (int indexIncrement)
	Sets the index increment in function aspect Created in NX11.0.0. More...
void	SetIndexIncrementInLocation (int indexIncrement)
	Sets the index increment in location aspect Created in NX11.0.0. More...
void	SetIndexIncrementInProduct (int indexIncrement)
	Sets the index increment in product aspect Created in NX11.0.0. More...
void	SetNameInFunction (const NXString &nameInFunction)
	Sets the name in function aspect Created in NX11.0.0. More...
void	SetNameInFunction (const char *nameInFunction)
	Sets the name in function aspect Created in NX11.0.0. More...
void	SetNameInLocation (const NXString &nameInLocation)
	Sets the name in location aspect Created in NX11.0.0. More...
void	SetNameInLocation (const char *nameInLocation)
	Sets the name in location aspect Created in NX11.0.0. More...
void	SetNameInProduct (const NXString &nameInProduct)
	Sets the name in product aspect Created in NX11.0.0. More...
void	SetNameInProduct (const char *nameInProduct)
	Sets the name in product aspect Created in NX11.0.0. More...
void	SetSelectedClassification (const NXString &classification)
	Sets the Classification ID Created in NX11.0.0. More...
void	SetSelectedClassification (const char *classification)
	Sets the Classification ID Created in NX11.0.0. More...
void	SetStartIndexInFunction (int startIndex)
	Sets the start index in function aspect Created in NX11.0.0. More...
void	SetStartIndexInLocation (int startIndex)
	Sets the start index in location aspect Created in NX11.0.0. More...
void	SetStartIndexInProduct (int startIndex)
	Sets the start index in product aspect Created in NX11.0.0. More...
int	StartIndexInFunction ()
	Returns the start index in function aspect Created in NX11.0.0. More...
int	StartIndexInLocation ()
	Returns the start index in location aspect Created in NX11.0.0. More...
int	StartIndexInProduct ()
	Returns the start index in product aspect Created in NX11.0.0. More...
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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

Naming Rule Builder
To create a new instance of this class, use NXOpen::AME::NamingRuleListBuilder::CreateRule

Created in NX11.0.0.

Member Function Documentation

NXOpen::AME::SelectClassificationBuilder* NXOpen::AME::NamingRuleBuilder::ClassificationItem

(

)

Returns the classification item
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::NamingRuleBuilder::EoName

(

)

Returns the engineering object name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

int NXOpen::AME::NamingRuleBuilder::IndexDigitsInFunction

(

)

Returns the index display digits in function aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

int NXOpen::AME::NamingRuleBuilder::IndexDigitsInLocation

(

)

Returns the index display digits in location aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

int NXOpen::AME::NamingRuleBuilder::IndexDigitsInProduct

(

)

Returns the index display digits in product aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

int NXOpen::AME::NamingRuleBuilder::IndexIncrementInFunction

(

)

Returns the index increment in function aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

int NXOpen::AME::NamingRuleBuilder::IndexIncrementInLocation

(

)

Returns the index increment in location aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

int NXOpen::AME::NamingRuleBuilder::IndexIncrementInProduct

(

)

Returns the index increment in product aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::NamingRuleBuilder::NameInFunction

(

)

Returns the name in function aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::NamingRuleBuilder::NameInLocation

(

)

Returns the name in location aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::NamingRuleBuilder::NameInProduct

(

)

Returns the name in product aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::NamingRuleBuilder::SelectedClassification

(

)

Returns the Classification ID
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::NamingRuleBuilder::SetEoName

(

const NXString &

eoName

)

Sets the engineering object name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

eoName

eoname

void NXOpen::AME::NamingRuleBuilder::SetEoName

(

const char *

eoName

)

Sets the engineering object name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

eoName

eoname

void NXOpen::AME::NamingRuleBuilder::SetIndexDigitsInFunction

(

int

indexIncrement

)

Sets the index display digits in function aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

indexIncrement

indexincrement

void NXOpen::AME::NamingRuleBuilder::SetIndexDigitsInLocation

(

int

indexIncrement

)

Sets the index display digits in location aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

indexIncrement

indexincrement

void NXOpen::AME::NamingRuleBuilder::SetIndexDigitsInProduct

(

int

indexIncrement

)

Sets the index display digits in product aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

indexIncrement

indexincrement

void NXOpen::AME::NamingRuleBuilder::SetIndexIncrementInFunction

(

int

indexIncrement

)

Sets the index increment in function aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

indexIncrement

indexincrement

void NXOpen::AME::NamingRuleBuilder::SetIndexIncrementInLocation

(

int

indexIncrement

)

Sets the index increment in location aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

indexIncrement

indexincrement

void NXOpen::AME::NamingRuleBuilder::SetIndexIncrementInProduct

(

int

indexIncrement

)

Sets the index increment in product aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

indexIncrement

indexincrement

void NXOpen::AME::NamingRuleBuilder::SetNameInFunction

(

const NXString &

nameInFunction

)

Sets the name in function aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

nameInFunction

nameinfunction

void NXOpen::AME::NamingRuleBuilder::SetNameInFunction

(

const char *

nameInFunction

)

Sets the name in function aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

nameInFunction

nameinfunction

void NXOpen::AME::NamingRuleBuilder::SetNameInLocation

(

const NXString &

nameInLocation

)

Sets the name in location aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

nameInLocation

nameinlocation

void NXOpen::AME::NamingRuleBuilder::SetNameInLocation

(

const char *

nameInLocation

)

Sets the name in location aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

nameInLocation

nameinlocation

void NXOpen::AME::NamingRuleBuilder::SetNameInProduct

(

const NXString &

nameInProduct

)

Sets the name in product aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

nameInProduct

nameinproduct

void NXOpen::AME::NamingRuleBuilder::SetNameInProduct

(

const char *

nameInProduct

)

Sets the name in product aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

nameInProduct

nameinproduct

void NXOpen::AME::NamingRuleBuilder::SetSelectedClassification

(

const NXString &

classification

)

Sets the Classification ID
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

classification

classification

void NXOpen::AME::NamingRuleBuilder::SetSelectedClassification

(

const char *

classification

)

Sets the Classification ID
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

classification

classification

void NXOpen::AME::NamingRuleBuilder::SetStartIndexInFunction

(

int

startIndex

)

Sets the start index in function aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

startIndex

startindex

void NXOpen::AME::NamingRuleBuilder::SetStartIndexInLocation

(

int

startIndex

)

Sets the start index in location aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

startIndex

startindex

void NXOpen::AME::NamingRuleBuilder::SetStartIndexInProduct

(

int

startIndex

)

Sets the start index in product aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

startIndex

startindex

int NXOpen::AME::NamingRuleBuilder::StartIndexInFunction

(

)

Returns the start index in function aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

int NXOpen::AME::NamingRuleBuilder::StartIndexInLocation

(

)

Returns the start index in location aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

int NXOpen::AME::NamingRuleBuilder::StartIndexInProduct

(

)

Returns the start index in product aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

---

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

• AME_NamingRuleBuilder.hxx