The Journalling class for PlcMethodBuilder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreatePlcMethodBuilder

Created in NX11.0.0. More...

Inheritance diagram for NXOpen::AME::PlcMethodBuilder:

Public Member Functions
void	AddCompileUnitIndex (int idx)
	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. More...

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

int	AssignCallParameterToParameter (int compileUnitIndex, int statementIndex, int callParameterIndex, NXOpen::NXObject *obj)
	Assign parameter to operand. More...

int	AssignOperandToParameter (int compileUnitIndex, int statementIndex, int operandIndex, NXOpen::NXObject *obj)
	Assign parameter to operand. More...

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

void	CreateMethod ()
	To Create Method Created in NX11.0.0. More...

NXOpen::NXObject *	CreateParameter ()
	Add a parameter. More...

void	DeleteParameter (NXOpen::NXObject *obj)
	Delete Parameter Created in NX11.0.0. More...

void	DeletePlcMethod ()
	To Delete Method Created in NX11.0.0. More...

void	DeletePosition (NXOpen::NXObject *position)
	Delete a position Created in NX11.0.0. More...

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

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

std::vector< NXOpen::NXObject * >	GetALLParameters ()
	Gets all existing parameter. More...

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

bool	InsertOnCreate ()
	Returns the automatic insertion setting Created in NX11.0.0. More...

NXOpen::AME::PlcMethod *	Method ()
	Returns the method Created in NX11.0.0. More...

NXString	MethodName ()
	Returns the code/data block name Created in NX11.0.0. More...

void	SetInsertOnCreate (bool insertOnCreate)
	Sets the automatic insertion setting Created in NX11.0.0. More...

void	SetMethodName (const NXString &name)
	Sets the code/data block name Created in NX11.0.0. More...

void	SetMethodName (const char *name)
	Sets the code/data block name Created in NX11.0.0. More...

int	SetNewParameterDataType (NXOpen::NXObject *obj, const NXString &newDataType)
	Set new data type to a parameter. More...

int	SetNewParameterDataType (NXOpen::NXObject obj, const char newDataType)
	Set new data type to a parameter. More...

int	SetNewParameterName (NXOpen::NXObject *obj, const NXString &newName)
	Set new name to a parameter. More...

int	SetNewParameterName (NXOpen::NXObject obj, const char newName)
	Set new name to a parameter. More...

void	SetPlcCodeBlock (NXOpen::AME::PlcBlock *plcBlock)
	Set selected PlcCodeBlock 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

The Journalling class for PlcMethodBuilder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreatePlcMethodBuilder

Created in NX11.0.0.

Member Function Documentation

void NXOpen::AME::PlcMethodBuilder::AddCompileUnitIndex ( int idx )

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 idx

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

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	compileunitindex
startStatementIndex	startstatementindex
endStatementIndex	endstatementindex

int NXOpen::AME::PlcMethodBuilder::AssignCallParameterToParameter	(	int	compileUnitIndex,
		int	statementIndex,
		int	callParameterIndex,
		NXOpen::NXObject *	obj
	)

Assign parameter to operand.

Returns: Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

compileUnitIndex	compileunitindex
statementIndex	statementindex
callParameterIndex	callparameterindex
obj	obj

int NXOpen::AME::PlcMethodBuilder::AssignOperandToParameter	(	int	compileUnitIndex,
		int	statementIndex,
		int	operandIndex,
		NXOpen::NXObject *	obj
	)

Assign parameter to operand.

Returns: Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

compileUnitIndex	compileunitindex
statementIndex	statementindex
operandIndex	operandindex
obj	obj

void NXOpen::AME::PlcMethodBuilder::ClearCompileUnitIndexCountAndStatementIndexCount ( )

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")

void NXOpen::AME::PlcMethodBuilder::CreateMethod ( )

To Create Method
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::NXObject* NXOpen::AME::PlcMethodBuilder::CreateParameter ( )

Add a parameter.

Returns: Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::PlcMethodBuilder::DeleteParameter ( NXOpen::NXObject * obj )

Delete Parameter
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

obj obj

void NXOpen::AME::PlcMethodBuilder::DeletePlcMethod ( )

To Delete Method
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::PlcMethodBuilder::DeletePosition ( NXOpen::NXObject * position )

Delete a position
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

position position

int NXOpen::AME::PlcMethodBuilder::DoesMethodNameAlreadyExist ( const NXString & methodName )

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

Returns: Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

methodName methodname

int NXOpen::AME::PlcMethodBuilder::DoesMethodNameAlreadyExist ( const char * methodName )

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

Returns: Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

methodName methodname

std::vector<NXOpen::NXObject *> NXOpen::AME::PlcMethodBuilder::GetALLParameters ( )

Gets all existing parameter.

Returns: Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

int NXOpen::AME::PlcMethodBuilder::GetSelectedCompileUnitIndexCount ( )

Get selected compileUnitIndex size.

Returns: Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::PlcMethodBuilder::InsertOnCreate ( )

Returns the automatic insertion setting
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::PlcMethod* NXOpen::AME::PlcMethodBuilder::Method ( )

Returns the method
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::PlcMethodBuilder::MethodName ( )

Returns the code/data block name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::PlcMethodBuilder::SetInsertOnCreate ( bool insertOnCreate )

Sets the automatic insertion setting
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

insertOnCreate insertoncreate

void NXOpen::AME::PlcMethodBuilder::SetMethodName ( const NXString & name )

Sets the code/data block name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

name name

void NXOpen::AME::PlcMethodBuilder::SetMethodName ( const char * name )

Sets the code/data block name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

name name

int NXOpen::AME::PlcMethodBuilder::SetNewParameterDataType	(	NXOpen::NXObject *	obj,
		const NXString &	newDataType
	)

Set new data type to a parameter.

Returns: Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

obj	obj
newDataType	newdatatype

int NXOpen::AME::PlcMethodBuilder::SetNewParameterDataType	(	NXOpen::NXObject *	obj,
		const char *	newDataType
	)

Set new data type to a parameter.

Returns: Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

obj	obj
newDataType	newdatatype

int NXOpen::AME::PlcMethodBuilder::SetNewParameterName	(	NXOpen::NXObject *	obj,
		const NXString &	newName
	)

Set new name to a parameter.

Returns: Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

obj	obj
newName	newname

int NXOpen::AME::PlcMethodBuilder::SetNewParameterName	(	NXOpen::NXObject *	obj,
		const char *	newName
	)

Set new name to a parameter.

Returns: Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

obj	obj
newName	newname

void NXOpen::AME::PlcMethodBuilder::SetPlcCodeBlock ( NXOpen::AME::PlcBlock * plcBlock )

Set selected PlcCodeBlock
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

plcBlock plcblock

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

AME_PlcMethodBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation