NXOpen::AME::CallMethodRuleBuilder Class Reference

JA class for the call method rule dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateCallMethodRuleBuilder

Created in NX12.0.0. More...

Inheritance diagram for NXOpen::AME::CallMethodRuleBuilder:

Public Types
enum	CreationType { CreationTypePort, CreationTypeObject, CreationTypeNoCreate }
	replace or insert rule Type More...

Public Member Functions
NXOpen::AME::ConditionsBuilder *	Conditions ()
	Returns the object condition ui block Created in NX12.0.0. More...
NXOpen::AME::PlcRule::Type	CurrentParameterRuleType ()
	Returns the rule type of selected parameter Created in NX12.0.0. More...
NXOpen::AME::CallMethodRuleBuilder::CreationType	IterativeMethodSelectionType ()
	Returns the iterative method selection type Created in NX12.0.0. More...
NXOpen::AME::ObjectConnectionBuilder *	IterativeObjectConnection ()
	Returns the iterative object connection block Created in NX12.0.0. More...
NXOpen::AME::SelectAMEPort *	IterativeSelectedPort ()
	Returns the eo any port selection Created in NX12.0.0. More...
NXOpen::AME::ObjectConnectionBuilder *	ObjectConnection ()
	Returns the object connection ui block Created in NX12.0.0. More...
NXOpen::AME::ObjectConnectionDetailBuilder *	ObjectConnectionDetail ()
	Returns the object connection detail ui block Created in NX12.0.0. More...
NXOpen::AME::ObjectConnectionBuilder *	ParameterObjectConnection ()
	Returns the parameter object connection ui block Created in NX12.0.0. More...
NXString	ParameterText ()
	Returns the constantText of a parameter Created in NX12.0.0. More...
void	RefreshContent (const NXString &paramOwnerId, const NXString &paramName)
	Update the builder of the reuse blocks Created in NX12.0.0. More...
void	RefreshContent (const char *paramOwnerId, const char *paramName)
	Update the builder of the reuse blocks Created in NX12.0.0. More...
void	RefreshParameterDetail ()
	Refresh the content of the detail builder Created in NX12.0.0. More...
NXOpen::AME::CallMethodRuleBuilder::CreationType	RuleCreationType ()
	Returns the creation type by creating a position Created in NX12.0.0. More...
NXString	RuleName ()
	Returns the rule name Created in NX12.0.0. More...
NXOpen::AME::SelectAMEExtendedObject *	SelectionPort ()
	Returns the replacement port selection Created in NX12.0.0. More...
void	SetCurrentParameterRuleType (NXOpen::AME::PlcRule::Type ruleType)
	Sets the rule type of selected parameter Created in NX12.0.0. More...
void	SetIterativeMethodSelectionType (NXOpen::AME::CallMethodRuleBuilder::CreationType type)
	Sets the iterative method selection type Created in NX12.0.0. More...
void	SetParameterText (const NXString &resultText)
	Sets the constantText of a parameter Created in NX12.0.0. More...
void	SetParameterText (const char *resultText)
	Sets the constantText of a parameter Created in NX12.0.0. More...
void	SetRuleCreationType (NXOpen::AME::CallMethodRuleBuilder::CreationType type)
	Sets the creation type by creating a position Created in NX12.0.0. More...
void	SetRuleName (const NXString &resultText)
	Sets the rule name Created in NX12.0.0. More...
void	SetRuleName (const char *resultText)
	Sets the rule name Created in NX12.0.0. More...
void	UpdateAllParameters ()
	Update the selected parameter list Created in NX12.0.0. More...
void	UpdateSelectedParameter (const NXString &paramOwnerId, const NXString &paramName)
	Update the selected parameter Created in NX12.0.0. More...
void	UpdateSelectedParameter (const char *paramOwnerId, const char *paramName)
	Update the selected parameter Created in NX12.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

JA class for the call method rule dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateCallMethodRuleBuilder

Created in NX12.0.0.

Member Enumeration Documentation

enum NXOpen::AME::CallMethodRuleBuilder::CreationType

replace or insert rule Type

Enumerator
CreationTypePort	port
CreationTypeObject	object
CreationTypeNoCreate	no create

Member Function Documentation

NXOpen::AME::ConditionsBuilder* NXOpen::AME::CallMethodRuleBuilder::Conditions

(

)

Returns the object condition ui block
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::PlcRule::Type NXOpen::AME::CallMethodRuleBuilder::CurrentParameterRuleType

(

)

Returns the rule type of selected parameter
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::CallMethodRuleBuilder::CreationType NXOpen::AME::CallMethodRuleBuilder::IterativeMethodSelectionType

(

)

Returns the iterative method selection type
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::ObjectConnectionBuilder* NXOpen::AME::CallMethodRuleBuilder::IterativeObjectConnection

(

)

Returns the iterative object connection block
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectAMEPort* NXOpen::AME::CallMethodRuleBuilder::IterativeSelectedPort

(

)

Returns the eo any port selection
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::ObjectConnectionBuilder* NXOpen::AME::CallMethodRuleBuilder::ObjectConnection

(

)

Returns the object connection ui block
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::ObjectConnectionDetailBuilder* NXOpen::AME::CallMethodRuleBuilder::ObjectConnectionDetail

(

)

Returns the object connection detail ui block
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::ObjectConnectionBuilder* NXOpen::AME::CallMethodRuleBuilder::ParameterObjectConnection

(

)

Returns the parameter object connection ui block
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::CallMethodRuleBuilder::ParameterText

(

)

Returns the constantText of a parameter
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::CallMethodRuleBuilder::RefreshContent	(	const NXString &	paramOwnerId,
		const NXString &	paramName
	)

Update the builder of the reuse blocks
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

paramOwnerId	paramownerid
paramName	paramname

void NXOpen::AME::CallMethodRuleBuilder::RefreshContent	(	const char *	paramOwnerId,
		const char *	paramName
	)

Update the builder of the reuse blocks
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

paramOwnerId	paramownerid
paramName	paramname

void NXOpen::AME::CallMethodRuleBuilder::RefreshParameterDetail

(

)

Refresh the content of the detail builder
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::CallMethodRuleBuilder::CreationType NXOpen::AME::CallMethodRuleBuilder::RuleCreationType

(

)

Returns the creation type by creating a position
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::CallMethodRuleBuilder::RuleName

(

)

Returns the rule name
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectAMEExtendedObject* NXOpen::AME::CallMethodRuleBuilder::SelectionPort

(

)

Returns the replacement port selection
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::CallMethodRuleBuilder::SetCurrentParameterRuleType

(

NXOpen::AME::PlcRule::Type

ruleType

)

Sets the rule type of selected parameter
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

ruleType

ruletype

void NXOpen::AME::CallMethodRuleBuilder::SetIterativeMethodSelectionType

(

NXOpen::AME::CallMethodRuleBuilder::CreationType

type

)

Sets the iterative method selection type
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

type

type

void NXOpen::AME::CallMethodRuleBuilder::SetParameterText

(

const NXString &

resultText

)

Sets the constantText of a parameter
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

resultText

resulttext

void NXOpen::AME::CallMethodRuleBuilder::SetParameterText

(

const char *

resultText

)

Sets the constantText of a parameter
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

resultText

resulttext

void NXOpen::AME::CallMethodRuleBuilder::SetRuleCreationType

(

NXOpen::AME::CallMethodRuleBuilder::CreationType

type

)

Sets the creation type by creating a position
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

type

type

void NXOpen::AME::CallMethodRuleBuilder::SetRuleName

(

const NXString &

resultText

)

Sets the rule name
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

resultText

resulttext

void NXOpen::AME::CallMethodRuleBuilder::SetRuleName

(

const char *

resultText

)

Sets the rule name
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

resultText

resulttext

void NXOpen::AME::CallMethodRuleBuilder::UpdateAllParameters

(

)

Update the selected parameter list
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::CallMethodRuleBuilder::UpdateSelectedParameter	(	const NXString &	paramOwnerId,
		const NXString &	paramName
	)

Update the selected parameter
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

paramOwnerId	paramownerid
paramName	paramname

void NXOpen::AME::CallMethodRuleBuilder::UpdateSelectedParameter	(	const char *	paramOwnerId,
		const char *	paramName
	)

Update the selected parameter
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

paramOwnerId	paramownerid
paramName	paramname

---

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

• AME_CallMethodRuleBuilder.hxx