NXOpen::Mechatronics::PlcSimAdvClientBuilder Class Reference

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

Inheritance diagram for NXOpen::Mechatronics::PlcSimAdvClientBuilder:

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

Public Types
enum	AreaType {   AreaTypeUnknow = -1, AreaTypeInput = 1, AreaTypeOutput, AreaTypeMarker = 4,   AreaTypeDatablock = 8 }
	Represents the plc signal area type. More...

Public Member Functions
void	GetInstanceInformation (const NXString &instanceName, NXOpen::Part *ownerPart, std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfo > &tagInfos)
	Gets PLCSIMAdv instance information. More...
void	GetInstanceInformation (const char *instanceName, NXOpen::Part *ownerPart, std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfo > &tagInfos)
	Gets PLCSIMAdv instance information. More...
std::vector< NXString >	GetInstanceNames (std::vector< NXOpen::Part * > &ownerParts)
	Gets PLCSIMAdv instance names. More...
void	RefreshRegisteredInstances ()
	Refresh registered PLCSIMAdv instances. More...
NXString	SelectedConfigurationName ()
	Returns the selected configuration name. More...
NXOpen::Part *	SelectedConfigurationPart ()
	Returns the selected configuration part. More...
void	SetInstanceInformation (const NXString &instanceName, NXOpen::Part *ownerPart, const std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfo > &tagInfos)
	Sets PLCSIMAdv instance information. More...
void	SetInstanceInformation (const char *instanceName, NXOpen::Part *ownerPart, const std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfo > &tagInfos)
	Sets PLCSIMAdv instance information. More...
void	SetInstanceNames (const std::vector< NXOpen::Part * > &ownerParts, std::vector< NXString > &names)
	Sets PLCSIMAdv instance names. More...
void	SetSelectedConfigurationName (const NXString &configurationName)
	Sets the selected configuration name. More...
void	SetSelectedConfigurationName (const char *configurationName)
	Sets the selected configuration name. More...
void	SetSelectedConfigurationPart (NXOpen::Part *ownerPart)
	Sets the selected configuration part. 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

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
AreaTypeUnknow	Unknow.
AreaTypeInput	Input.
AreaTypeOutput	Output.
AreaTypeMarker	Marker.
AreaTypeDatablock	DataBlock.

Member Function Documentation

void NXOpen::Mechatronics::PlcSimAdvClientBuilder::GetInstanceInformation	(	const NXString &	instanceName,
		NXOpen::Part *	ownerPart,
		std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfo > &	tagInfos
	)

Gets PLCSIMAdv instance information.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

instanceName	instancename
ownerPart	ownerpart
tagInfos	Array of TagInfos

void NXOpen::Mechatronics::PlcSimAdvClientBuilder::GetInstanceInformation	(	const char *	instanceName,
		NXOpen::Part *	ownerPart,
		std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfo > &	tagInfos
	)

Gets PLCSIMAdv instance information.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

instanceName	instancename
ownerPart	ownerpart
tagInfos	Array of TagInfos

std::vector<NXString> NXOpen::Mechatronics::PlcSimAdvClientBuilder::GetInstanceNames

(

std::vector< NXOpen::Part * > &

ownerParts

)

Gets PLCSIMAdv instance names.

Returns

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

ownerParts

ownerparts

void NXOpen::Mechatronics::PlcSimAdvClientBuilder::RefreshRegisteredInstances

(

)

Refresh registered PLCSIMAdv instances.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::PlcSimAdvClientBuilder::SelectedConfigurationName

(

)

Returns the selected configuration name.

Created in NX12.0.0.

License requirements : None

NXOpen::Part* NXOpen::Mechatronics::PlcSimAdvClientBuilder::SelectedConfigurationPart

(

)

Returns the selected configuration part.

Created in NX12.0.0.

License requirements : None

void NXOpen::Mechatronics::PlcSimAdvClientBuilder::SetInstanceInformation	(	const NXString &	instanceName,
		NXOpen::Part *	ownerPart,
		const std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfo > &	tagInfos
	)

Sets PLCSIMAdv instance information.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

instanceName	instancename
ownerPart	ownerpart
tagInfos	Array of TagInfos

void NXOpen::Mechatronics::PlcSimAdvClientBuilder::SetInstanceInformation	(	const char *	instanceName,
		NXOpen::Part *	ownerPart,
		const std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfo > &	tagInfos
	)

Sets PLCSIMAdv instance information.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

instanceName	instancename
ownerPart	ownerpart
tagInfos	Array of TagInfos

void NXOpen::Mechatronics::PlcSimAdvClientBuilder::SetInstanceNames	(	const std::vector< NXOpen::Part * > &	ownerParts,
		std::vector< NXString > &	names
	)

Sets PLCSIMAdv instance names.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

ownerParts	ownerparts
names	names

void NXOpen::Mechatronics::PlcSimAdvClientBuilder::SetSelectedConfigurationName

(

const NXString &

configurationName

)

Sets the selected configuration name.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

configurationName

configurationname

void NXOpen::Mechatronics::PlcSimAdvClientBuilder::SetSelectedConfigurationName

(

const char *

configurationName

)

Sets the selected configuration name.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

configurationName

configurationname

void NXOpen::Mechatronics::PlcSimAdvClientBuilder::SetSelectedConfigurationPart

(

NXOpen::Part *

ownerPart

)

Sets the selected configuration part.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

ownerPart

ownerpart

---

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

• Mechatronics_PlcSimAdvClientBuilder.hxx