The Journalling class for PlcMethodBuilder More...

Inheritance diagram for NXOpen.AME.PlcMethodBuilder:

Public Types
enum	ParameterLevelType { All, First, Second, Third }
	the parameter level enum type More...

Public Member Functions
unsafe void	AddCompileUnitIndex (int idx)
	Add a index of network that will be in a method with this function is possible to add several network More...

unsafe void	AddStatementIndexes (int compileUnitIndex, int startStatementIndex, int endStatementIndex)
	Add a index of start statment in a network and index of end of statment More...

unsafe int	AssignSoftwareGeneratableObjectToParameter (int compileUnitIndex, int statementLineIndex, int statementLineInnerIndex, NXOpen.NXObject obj)
	Assign parameter to operand More...

unsafe void	ChangeSubVariable (NXOpen.AME.PlcCodePosition position, string[] subVariablePath)
	Change subvariable of method parameter More...

unsafe void	ClearCompileUnitIndexCountAndStatementIndexCount ()
	Clear the number of statments and networks which are saved to creating a method More...

unsafe NXOpen.NXObject	CreateAndAssignParameter (int compileUnitIndex, int statementLineIndex, int statementLineInnerIndex)
	Create and assigns a parameter. More...

unsafe void	CreateMethod ()
	To Create Method More...

unsafe NXOpen.NXObject	CreateParameter ()
	Create a parameter More...

unsafe NXOpen.NXObject	CreateParameter (string parameterName)
	Create a parameter by a given name More...

unsafe void	CreateParametersByExternalRelation (NXOpen.AME.PlcSoftwareGenPort swGenerationPort, out NXOpen.NXObject[] createdParameters)
	Creates one ore more parameters by a given external relation port More...

unsafe void	DeleteParameter (NXOpen.NXObject obj)
	Delete Parameter More...

unsafe void	DeletePlcMethod ()
	To Delete Method More...

unsafe void	DeletePosition (NXOpen.NXObject position)
	Delete a position More...

unsafe int	DoesMethodNameAlreadyExist (string methodName)
	To find out that the given for method name already exist or not More...

unsafe NXOpen.NXObject[]	GetALLParameters ()
	Gets all existing parameter More...

unsafe int	GetSelectedCompileUnitIndexCount ()
	Get selected compileUnitIndex size More...

unsafe int	SetNewParameterDataType (NXOpen.NXObject obj, string newDataType)
	Set new data type to a parameter More...

unsafe int	SetNewParameterName (NXOpen.NXObject obj, string newName)
	Set new name to a parameter More...

unsafe void	SetPlcCodeBlock (NXOpen.AME.PlcBlock plcBlock)
	Set selected PlcCodeBlock More...

Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject	Commit ()
	Commits any edits that have been applied to the builder. More...

unsafe void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...

unsafe void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

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

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe bool	InsertOnCreate `[get, set]`
	Returns or sets the automatic insertion setting More...

unsafe NXOpen.AME.PlcMethod	Method `[get]`
	Returns the method More...

unsafe string	MethodName `[get, set]`
	Returns or sets the code/data block name More...

unsafe NXOpen.AME.PlcMethodBuilder.ParameterLevelType	ParameterLevel `[get, set]`
	Returns or sets the level of the created or assigned parameter More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

The Journalling class for PlcMethodBuilder

To create a new instance of this class, use NXOpen.AME.AMEManager.CreatePlcMethodBuilder

Created in NX11.0.0

Member Enumeration Documentation

enum NXOpen.AME.PlcMethodBuilder.ParameterLevelType

the parameter level enum type

Enumerator
All
First
Second
Third

Member Function Documentation

unsafe void NXOpen.AME.PlcMethodBuilder.AddCompileUnitIndex ( int idx )

inline

Add a index of network that will be in a method with this function is possible to add several network

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

idx

unsafe void NXOpen.AME.PlcMethodBuilder.AddStatementIndexes	(	int	compileUnitIndex,
		int	startStatementIndex,
		int	endStatementIndex
	)

inline

Add a index of start statment in a network and index of end of statment

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

compileUnitIndex
startStatementIndex
endStatementIndex

unsafe int NXOpen.AME.PlcMethodBuilder.AssignSoftwareGeneratableObjectToParameter	(	int	compileUnitIndex,
		int	statementLineIndex,
		int	statementLineInnerIndex,
		NXOpen.NXObject	obj
	)

inline

Assign parameter to operand

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

compileUnitIndex
statementLineIndex
statementLineInnerIndex
obj

Returns

unsafe void NXOpen.AME.PlcMethodBuilder.ChangeSubVariable	(	NXOpen.AME.PlcCodePosition	position,
		string[]	subVariablePath
	)

inline

Change subvariable of method parameter

Created in NX1899.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

position
subVariablePath

unsafe void NXOpen.AME.PlcMethodBuilder.ClearCompileUnitIndexCountAndStatementIndexCount ( )

inline

Clear the number of statments and networks which are saved to creating a method

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.NXObject NXOpen.AME.PlcMethodBuilder.CreateAndAssignParameter	(	int	compileUnitIndex,
		int	statementLineIndex,
		int	statementLineInnerIndex
	)

inline

Create and assigns a parameter.

Created in NX1899.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Returns

Parameters

compileUnitIndex
statementLineIndex
statementLineInnerIndex

unsafe void NXOpen.AME.PlcMethodBuilder.CreateMethod ( )

inline

To Create Method

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.NXObject NXOpen.AME.PlcMethodBuilder.CreateParameter ( )

inline

Create a parameter

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Returns

unsafe NXOpen.NXObject NXOpen.AME.PlcMethodBuilder.CreateParameter ( string parameterName )

inline

Create a parameter by a given name

Created in NX1899.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Returns

Parameters

parameterName

unsafe void NXOpen.AME.PlcMethodBuilder.CreateParametersByExternalRelation	(	NXOpen.AME.PlcSoftwareGenPort	swGenerationPort,
		out NXOpen.NXObject[]	createdParameters
	)

inline

Creates one ore more parameters by a given external relation port

Created in NX1899.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

swGenerationPort
createdParameters

unsafe void NXOpen.AME.PlcMethodBuilder.DeleteParameter ( NXOpen.NXObject obj )

inline

Delete Parameter

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

obj

unsafe void NXOpen.AME.PlcMethodBuilder.DeletePlcMethod ( )

inline

To Delete Method

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe void NXOpen.AME.PlcMethodBuilder.DeletePosition ( NXOpen.NXObject position )

inline

Delete a position

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

position

unsafe int NXOpen.AME.PlcMethodBuilder.DoesMethodNameAlreadyExist ( string methodName )

inline

To find out that the given for method name already exist or not

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

methodName

Returns

unsafe NXOpen.NXObject [] NXOpen.AME.PlcMethodBuilder.GetALLParameters ( )

inline

Gets all existing parameter

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Returns

unsafe int NXOpen.AME.PlcMethodBuilder.GetSelectedCompileUnitIndexCount ( )

inline

Get selected compileUnitIndex size

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Returns

unsafe int NXOpen.AME.PlcMethodBuilder.SetNewParameterDataType	(	NXOpen.NXObject	obj,
		string	newDataType
	)

inline

Set new data type to a parameter

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

obj
newDataType

Returns

unsafe int NXOpen.AME.PlcMethodBuilder.SetNewParameterName	(	NXOpen.NXObject	obj,
		string	newName
	)

inline

Set new name to a parameter

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

obj
newName

Returns

unsafe void NXOpen.AME.PlcMethodBuilder.SetPlcCodeBlock ( NXOpen.AME.PlcBlock plcBlock )

inline

Set selected PlcCodeBlock

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

plcBlock

Property Documentation

unsafe bool NXOpen.AME.PlcMethodBuilder.InsertOnCreate

getset

Returns or sets the automatic insertion setting

Created in NX11.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.AME.PlcMethod NXOpen.AME.PlcMethodBuilder.Method

get

Returns the method

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe string NXOpen.AME.PlcMethodBuilder.MethodName

getset

Returns or sets the code/data block name

Created in NX11.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.AME.PlcMethodBuilder.ParameterLevelType NXOpen.AME.PlcMethodBuilder.ParameterLevel

getset

Returns or sets the level of the created or assigned parameter

Created in NX1899.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

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

AME_PlcMethodBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation