Represents a NXOpen.Mechatronics.PlcSimAdvClientBuilder builder. More...

Inheritance diagram for NXOpen.Mechatronics.PlcSimAdvClientBuilder:

Classes
struct	_TagInfo
	Represents PLCTag info definition structure.

struct	_TagInfoV2
	Represents Extended PLCTag info definition structure.

struct	TagInfo
	Represents PLCTag info definition structure. More...

struct	TagInfoV2
	Represents Extended PLCTag info definition structure. More...

Public Types
enum	AreaType { Unknow = -1, Input = 1, Output, Marker = 4, Datablock = 8, Counter = 16, Timer = 32 }
	Represents the plc signal area type. More...

Public Member Functions
unsafe void	GetInstanceInformationV2 (string instanceName, NXOpen.Part ownerPart, out NXOpen.Mechatronics.PlcSimAdvClientBuilder.TagInfoV2[] tagInfos, out int cyclic, out int stepFactor)
	Gets PLCSIMAdv instance information More...

unsafe string[]	GetInstanceNames (out NXOpen.Part[] ownerParts)
	Gets PLCSIMAdv instance names More...

unsafe void	GetInstanceUpdateOptions (string instanceName, NXOpen.Part ownerPart, out int tagListDetails, out bool isHMIVisibleOnly, out string dataBlockFilterList)
	Gets instance update options. More...

unsafe void	RefreshRegisteredInstances ()
	Refresh registered PLCSIMAdv instances. More...

unsafe void	SetInstanceInformationV2 (string instanceName, NXOpen.Part ownerPart, NXOpen.Mechatronics.PlcSimAdvClientBuilder.TagInfoV2[] tagInfos, int cyclic, int stepFactor)
	Sets PLCSIMAdv instance information More...

unsafe void	SetInstanceNames (NXOpen.Part[] ownerParts, string[] names)
	Sets PLCSIMAdv instance names More...

unsafe void	SetInstanceUpdateOptions (string instanceName, NXOpen.Part ownerPart, int tagListDetails, bool isHMIVisibleOnly, string dataBlockFilterList)
	Sets instance update options. More...

unsafe void	UpdateInstance (string instanceName, NXOpen.Part ownerPart)
	Updates instance. 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 string	SelectedConfigurationName `[get, set]`
	Returns or sets the selected configuration name. More...

unsafe NXOpen.Part	SelectedConfigurationPart `[get, set]`
	Returns or sets the selected configuration part. 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

Represents a NXOpen.Mechatronics.PlcSimAdvClientBuilder builder.

This class is sub-object of another builder, and cannot be directly instantiated.

Created in NX12.0.0

Member Enumeration Documentation

enum NXOpen.Mechatronics.PlcSimAdvClientBuilder.AreaType

Represents the plc signal area type.

Enumerator
Unknow	Unknow
Input	Input
Output	Output
Marker	Marker
Datablock	DataBlock
Counter	Counter
Timer	Timer

Member Function Documentation

unsafe void NXOpen.Mechatronics.PlcSimAdvClientBuilder.GetInstanceInformationV2	(	string	instanceName,
		NXOpen.Part	ownerPart,
		out NXOpen.Mechatronics.PlcSimAdvClientBuilder.TagInfoV2[]	tagInfos,
		out int	cyclic,
		out int	stepFactor
	)

inline

Gets PLCSIMAdv instance information

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters

instanceName
ownerPart
tagInfos	Array of TagInfoExs
cyclic	Cyclic object for synchronization: 0:NoSyn,1:OB1,2~32:PIP1~PIP31,33:Servo
stepFactor	How many MCD steps to run for each PLC cyclic object synchronization point reached

unsafe string [] NXOpen.Mechatronics.PlcSimAdvClientBuilder.GetInstanceNames ( out NXOpen.Part[] ownerParts )

inline

Gets PLCSIMAdv instance names

Created in NX12.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters

ownerParts

Returns

unsafe void NXOpen.Mechatronics.PlcSimAdvClientBuilder.GetInstanceUpdateOptions	(	string	instanceName,
		NXOpen.Part	ownerPart,
		out int	tagListDetails,
		out bool	isHMIVisibleOnly,
		out string	dataBlockFilterList
	)

inline

Gets instance update options.

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters

instanceName
ownerPart
tagListDetails	PLC area type: 0:NONE,1:IO,2:M,3:IOM,4:CT,5:IOCT,6:MCT,7:IOMCT,8:DB,9:IODB,10:MDB,11:IOMDB,12:CTDB,13:IOCTDB,14:MCTDB,15:IOMCTDB
isHMIVisibleOnly	Whether only to get PLC HMI visible tags or not
dataBlockFilterList	Data block names for which PLC tags will be got

unsafe void NXOpen.Mechatronics.PlcSimAdvClientBuilder.RefreshRegisteredInstances ( )

inline

Refresh registered PLCSIMAdv instances.

Created in NX12.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

unsafe void NXOpen.Mechatronics.PlcSimAdvClientBuilder.SetInstanceInformationV2	(	string	instanceName,
		NXOpen.Part	ownerPart,
		NXOpen.Mechatronics.PlcSimAdvClientBuilder.TagInfoV2[]	tagInfos,
		int	cyclic,
		int	stepFactor
	)

inline

Sets PLCSIMAdv instance information

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters

instanceName
ownerPart
tagInfos	Array of TagInfoExs
cyclic	Cyclic object for synchronization: 0:NoSyn,1:OB1,2~32:PIP1~PIP31,33:Servo
stepFactor	How many MCD steps to run for each PLC cyclic object synchronization point reached

unsafe void NXOpen.Mechatronics.PlcSimAdvClientBuilder.SetInstanceNames	(	NXOpen.Part[]	ownerParts,
		string[]	names
	)

inline

Sets PLCSIMAdv instance names

Created in NX12.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters

ownerParts
names

unsafe void NXOpen.Mechatronics.PlcSimAdvClientBuilder.SetInstanceUpdateOptions	(	string	instanceName,
		NXOpen.Part	ownerPart,
		int	tagListDetails,
		bool	isHMIVisibleOnly,
		string	dataBlockFilterList
	)

inline

Sets instance update options.

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters

instanceName
ownerPart
tagListDetails	PLC area type: 0:NONE,1:IO,2:M,3:IOM,4:CT,5:IOCT,6:MCT,7:IOMCT,8:DB,9:IODB,10:MDB,11:IOMDB,12:CTDB,13:IOCTDB,14:MCTDB,15:IOMCTDB
isHMIVisibleOnly	Whether only to get PLC HMI visible tags or not
dataBlockFilterList	Data block names for which PLC tags will be got

unsafe void NXOpen.Mechatronics.PlcSimAdvClientBuilder.UpdateInstance	(	string	instanceName,
		NXOpen.Part	ownerPart
	)

inline

Updates instance.

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters

instanceName
ownerPart

Property Documentation

unsafe string NXOpen.Mechatronics.PlcSimAdvClientBuilder.SelectedConfigurationName

getset

Returns or sets the selected configuration name.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("Mechatronics Concept Designer")

unsafe NXOpen.Part NXOpen.Mechatronics.PlcSimAdvClientBuilder.SelectedConfigurationPart

getset

Returns or sets the selected configuration part.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("Mechatronics Concept Designer")

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

Mechatronics_PlcSimAdvClientBuilder.cs

Classes

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation