NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Classes | Public Types | Public Member Functions | List of all members
NXOpen::Mechatronics::PlcSimAdvClientBuilder Class Reference

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

Inheritance diagram for NXOpen::Mechatronics::PlcSimAdvClientBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Classes

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

Public Types

enum  AreaType {
  AreaTypeUnknow = -1, AreaTypeInput = 1, AreaTypeOutput, AreaTypeMarker = 4,
  AreaTypeDatablock = 8, AreaTypeCounter = 16, AreaTypeTimer = 32
}
 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...
 
void GetInstanceInformationV2 (const NXString &instanceName, NXOpen::Part *ownerPart, std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfoV2 > &tagInfos, int *cyclic, int *stepFactor)
 Gets PLCSIMAdv instance information. More...
 
void GetInstanceInformationV2 (const char *instanceName, NXOpen::Part *ownerPart, std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfoV2 > &tagInfos, int *cyclic, int *stepFactor)
 Gets PLCSIMAdv instance information. More...
 
std::vector< NXString > GetInstanceNames (std::vector< NXOpen::Part * > &ownerParts)
 Gets PLCSIMAdv instance names. More...
 
void GetInstanceUpdateOptions (const NXString &instanceName, NXOpen::Part *ownerPart, int *tagListDetails, bool *isHMIVisibleOnly, NXString *dataBlockFilterList)
 Gets instance update options. More...
 
void GetInstanceUpdateOptions (const char *instanceName, NXOpen::Part *ownerPart, int *tagListDetails, bool *isHMIVisibleOnly, NXString *dataBlockFilterList)
 Gets instance update options. 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 SetInstanceInformationV2 (const NXString &instanceName, NXOpen::Part *ownerPart, const std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfoV2 > &tagInfos, int cyclic, int stepFactor)
 Sets PLCSIMAdv instance information. More...
 
void SetInstanceInformationV2 (const char *instanceName, NXOpen::Part *ownerPart, const std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfoV2 > &tagInfos, int cyclic, int stepFactor)
 Sets PLCSIMAdv instance information. More...
 
void SetInstanceNames (const std::vector< NXOpen::Part * > &ownerParts, std::vector< NXString > &names)
 Sets PLCSIMAdv instance names. More...
 
void SetInstanceUpdateOptions (const NXString &instanceName, NXOpen::Part *ownerPart, int tagListDetails, bool isHMIVisibleOnly, const NXString &dataBlockFilterList)
 Sets instance update options. More...
 
void SetInstanceUpdateOptions (const char *instanceName, NXOpen::Part *ownerPart, int tagListDetails, bool isHMIVisibleOnly, const char *dataBlockFilterList)
 Sets instance update options. 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...
 
void UpdateInstance (const NXString &instanceName, NXOpen::Part *ownerPart)
 Updates instance. More...
 
void UpdateInstance (const char *instanceName, NXOpen::Part *ownerPart)
 Updates instance. 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.

AreaTypeCounter 

Counter.

AreaTypeTimer 

Timer.

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.


Deprecated:
Deprecated in NX1847.0.0. Use Mechatronics::PlcSimAdvClientBuilder::GetInstanceInformationV2 instead.


Created in NX12.0.0.

License requirements : nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceNameinstancename
ownerPartownerpart
tagInfosArray of TagInfos
void NXOpen::Mechatronics::PlcSimAdvClientBuilder::GetInstanceInformation ( const char *  instanceName,
NXOpen::Part *  ownerPart,
std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfo > &  tagInfos 
)

Gets PLCSIMAdv instance information.


Deprecated:
Deprecated in NX1847.0.0. Use Mechatronics::PlcSimAdvClientBuilder::GetInstanceInformationV2 instead.


Created in NX12.0.0.

License requirements : nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceNameinstancename
ownerPartownerpart
tagInfosArray of TagInfos
void NXOpen::Mechatronics::PlcSimAdvClientBuilder::GetInstanceInformationV2 ( const NXString &  instanceName,
NXOpen::Part *  ownerPart,
std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfoV2 > &  tagInfos,
int *  cyclic,
int *  stepFactor 
)

Gets PLCSIMAdv instance information.


Created in NX1847.0.0.

License requirements : nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceNameinstancename
ownerPartownerpart
tagInfosArray of TagInfoExs
cyclicCyclic object for synchronization: 0:NoSyn,1:OB1,2~32:PIP1~PIP31,33:Servo
stepFactorHow many MCD steps to run for each PLC cyclic object synchronization point reached
void NXOpen::Mechatronics::PlcSimAdvClientBuilder::GetInstanceInformationV2 ( const char *  instanceName,
NXOpen::Part *  ownerPart,
std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfoV2 > &  tagInfos,
int *  cyclic,
int *  stepFactor 
)

Gets PLCSIMAdv instance information.


Created in NX1847.0.0.

License requirements : nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceNameinstancename
ownerPartownerpart
tagInfosArray of TagInfoExs
cyclicCyclic object for synchronization: 0:NoSyn,1:OB1,2~32:PIP1~PIP31,33:Servo
stepFactorHow many MCD steps to run for each PLC cyclic object synchronization point reached
std::vector<NXString> NXOpen::Mechatronics::PlcSimAdvClientBuilder::GetInstanceNames ( std::vector< NXOpen::Part * > &  ownerParts)

Gets PLCSIMAdv instance names.


Created in NX12.0.0.

License requirements : nx_mcd_core ("Mechatronics Concept Designer")

Parameters
ownerPartsownerparts
void NXOpen::Mechatronics::PlcSimAdvClientBuilder::GetInstanceUpdateOptions ( const NXString &  instanceName,
NXOpen::Part *  ownerPart,
int *  tagListDetails,
bool *  isHMIVisibleOnly,
NXString *  dataBlockFilterList 
)

Gets instance update options.


Created in NX1847.0.0.

License requirements : nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceNameinstancename
ownerPartownerpart
tagListDetailsPLC 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
isHMIVisibleOnlyWhether only to get PLC HMI visible tags or not
dataBlockFilterListData block names for which PLC tags will be got
void NXOpen::Mechatronics::PlcSimAdvClientBuilder::GetInstanceUpdateOptions ( const char *  instanceName,
NXOpen::Part *  ownerPart,
int *  tagListDetails,
bool *  isHMIVisibleOnly,
NXString *  dataBlockFilterList 
)

Gets instance update options.


Created in NX1847.0.0.

License requirements : nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceNameinstancename
ownerPartownerpart
tagListDetailsPLC 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
isHMIVisibleOnlyWhether only to get PLC HMI visible tags or not
dataBlockFilterListData block names for which PLC tags will be got
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.


Deprecated:
Deprecated in NX1847.0.0. Use Mechatronics::PlcSimAdvClientBuilder::SetInstanceInformationV2 instead.


Created in NX12.0.0.

License requirements : nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceNameinstancename
ownerPartownerpart
tagInfosArray 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.


Deprecated:
Deprecated in NX1847.0.0. Use Mechatronics::PlcSimAdvClientBuilder::SetInstanceInformationV2 instead.


Created in NX12.0.0.

License requirements : nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceNameinstancename
ownerPartownerpart
tagInfosArray of TagInfos
void NXOpen::Mechatronics::PlcSimAdvClientBuilder::SetInstanceInformationV2 ( const NXString &  instanceName,
NXOpen::Part *  ownerPart,
const std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfoV2 > &  tagInfos,
int  cyclic,
int  stepFactor 
)

Sets PLCSIMAdv instance information.


Created in NX1847.0.0.

License requirements : nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceNameinstancename
ownerPartownerpart
tagInfosArray of TagInfoExs
cyclicCyclic object for synchronization: 0:NoSyn,1:OB1,2~32:PIP1~PIP31,33:Servo
stepFactorHow many MCD steps to run for each PLC cyclic object synchronization point reached
void NXOpen::Mechatronics::PlcSimAdvClientBuilder::SetInstanceInformationV2 ( const char *  instanceName,
NXOpen::Part *  ownerPart,
const std::vector< NXOpen::Mechatronics::PlcSimAdvClientBuilder::TagInfoV2 > &  tagInfos,
int  cyclic,
int  stepFactor 
)

Sets PLCSIMAdv instance information.


Created in NX1847.0.0.

License requirements : nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceNameinstancename
ownerPartownerpart
tagInfosArray of TagInfoExs
cyclicCyclic object for synchronization: 0:NoSyn,1:OB1,2~32:PIP1~PIP31,33:Servo
stepFactorHow many MCD steps to run for each PLC cyclic object synchronization point reached
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
ownerPartsownerparts
namesnames
void NXOpen::Mechatronics::PlcSimAdvClientBuilder::SetInstanceUpdateOptions ( const NXString &  instanceName,
NXOpen::Part *  ownerPart,
int  tagListDetails,
bool  isHMIVisibleOnly,
const NXString &  dataBlockFilterList 
)

Sets instance update options.


Created in NX1847.0.0.

License requirements : nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceNameinstancename
ownerPartownerpart
tagListDetailsPLC 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
isHMIVisibleOnlyWhether only to get PLC HMI visible tags or not
dataBlockFilterListData block names for which PLC tags will be got
void NXOpen::Mechatronics::PlcSimAdvClientBuilder::SetInstanceUpdateOptions ( const char *  instanceName,
NXOpen::Part *  ownerPart,
int  tagListDetails,
bool  isHMIVisibleOnly,
const char *  dataBlockFilterList 
)

Sets instance update options.


Created in NX1847.0.0.

License requirements : nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceNameinstancename
ownerPartownerpart
tagListDetailsPLC 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
isHMIVisibleOnlyWhether only to get PLC HMI visible tags or not
dataBlockFilterListData block names for which PLC tags will be got
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
configurationNameconfigurationname
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
configurationNameconfigurationname
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
ownerPartownerpart
void NXOpen::Mechatronics::PlcSimAdvClientBuilder::UpdateInstance ( const NXString &  instanceName,
NXOpen::Part *  ownerPart 
)

Updates instance.


Created in NX1847.0.0.

License requirements : nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceNameinstancename
ownerPartownerpart
void NXOpen::Mechatronics::PlcSimAdvClientBuilder::UpdateInstance ( const char *  instanceName,
NXOpen::Part *  ownerPart 
)

Updates instance.


Created in NX1847.0.0.

License requirements : nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceNameinstancename
ownerPartownerpart
The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.