NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions | List of all members
NXOpen::Mechatronics::UDPSignalServerBuilder Class Reference

Represents a Mechatronics::UDPSignalServerBuilder builder. More...

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

Classes

struct  Signal
 Represents the data type. More...
 

Public Types

enum  CastMode { CastModeUnicast, CastModeMulticast, CastModeBroadcast }
 Represents the casting mode of udp. More...
 
enum  Protocol { ProtocolTcpserver, ProtocolTcpclient, ProtocolUdpserver, ProtocolUdpclient }
 Represents the IP protocol. More...
 

Public Member Functions

void GetConnectionInformation (const NXString &connectionName, int *castMode, NXString *remoteIP, int *remotePort, NXString *localIP, int *localPort, NXString *groupIP, int *rcvBufSize, int *sendBufSize, double *updateTime, std::vector< NXOpen::Mechatronics::UDPSignalServerBuilder::Signal > &signals)
 Gets UDP connection information. More...
 
void GetConnectionInformation (const char *connectionName, int *castMode, NXString *remoteIP, int *remotePort, NXString *localIP, int *localPort, NXString *groupIP, int *rcvBufSize, int *sendBufSize, double *updateTime, std::vector< NXOpen::Mechatronics::UDPSignalServerBuilder::Signal > &signals)
 Gets UDP connection information. More...
 
std::vector< NXStringGetInstanceNames ()
 Gets UDP instance names. More...
 
NXString SelectedConfigurationName ()
 Returns. More...
 
void SetConnectionInformation (const NXString &connectionName, int castMode, const NXString &remoteIP, int remotePort, const NXString &localIP, int localPort, const NXString &groupIP, int rcvBufSize, int sendBufSize, double updateTime, const std::vector< NXOpen::Mechatronics::UDPSignalServerBuilder::Signal > &signals)
 Sets UDP connection information. More...
 
void SetConnectionInformation (const char *connectionName, int castMode, const char *remoteIP, int remotePort, const char *localIP, int localPort, const char *groupIP, int rcvBufSize, int sendBufSize, double updateTime, const std::vector< NXOpen::Mechatronics::UDPSignalServerBuilder::Signal > &signals)
 Sets UDP connection information. More...
 
void SetConnectionNames (std::vector< NXString > &names)
 Sets UDP connection names. More...
 
void SetSelectedConfigurationName (const NXString &configurationName)
 Sets. More...
 
void SetSelectedConfigurationName (const char *configurationName)
 Sets. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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 Mechatronics::UDPSignalServerBuilder builder.


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

Created in NX12.0.0.

Member Enumeration Documentation

Represents the casting mode of udp.

Enumerator
CastModeUnicast 

unicast

CastModeMulticast 

multicast

CastModeBroadcast 

broadcast

Represents the IP protocol.

Enumerator
ProtocolTcpserver 

tcpserver

ProtocolTcpclient 

tcpclient

ProtocolUdpserver 

udpserver

ProtocolUdpclient 

udpclient

Member Function Documentation

void NXOpen::Mechatronics::UDPSignalServerBuilder::GetConnectionInformation ( const NXString connectionName,
int *  castMode,
NXString remoteIP,
int *  remotePort,
NXString localIP,
int *  localPort,
NXString groupIP,
int *  rcvBufSize,
int *  sendBufSize,
double *  updateTime,
std::vector< NXOpen::Mechatronics::UDPSignalServerBuilder::Signal > &  signals 
)

Gets UDP connection information.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
connectionNameconnectionname
castModecastmode
remoteIPremoteip
remotePortremoteport
localIPlocalip
localPortlocalport
groupIPgroupip
rcvBufSizercvbufsize
sendBufSizesendbufsize
updateTimeupdatetime
signalsArray of Signal
void NXOpen::Mechatronics::UDPSignalServerBuilder::GetConnectionInformation ( const char *  connectionName,
int *  castMode,
NXString remoteIP,
int *  remotePort,
NXString localIP,
int *  localPort,
NXString groupIP,
int *  rcvBufSize,
int *  sendBufSize,
double *  updateTime,
std::vector< NXOpen::Mechatronics::UDPSignalServerBuilder::Signal > &  signals 
)

Gets UDP connection information.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
connectionNameconnectionname
castModecastmode
remoteIPremoteip
remotePortremoteport
localIPlocalip
localPortlocalport
groupIPgroupip
rcvBufSizercvbufsize
sendBufSizesendbufsize
updateTimeupdatetime
signalsArray of Signal
std::vector<NXString> NXOpen::Mechatronics::UDPSignalServerBuilder::GetInstanceNames ( )

Gets UDP instance names.

Returns

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
NXString NXOpen::Mechatronics::UDPSignalServerBuilder::SelectedConfigurationName ( )

Returns.

the selected configuration name.


Created in NX12.0.0.

License requirements : None

void NXOpen::Mechatronics::UDPSignalServerBuilder::SetConnectionInformation ( const NXString connectionName,
int  castMode,
const NXString remoteIP,
int  remotePort,
const NXString localIP,
int  localPort,
const NXString groupIP,
int  rcvBufSize,
int  sendBufSize,
double  updateTime,
const std::vector< NXOpen::Mechatronics::UDPSignalServerBuilder::Signal > &  signals 
)

Sets UDP connection information.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
connectionNameconnectionname
castModecastmode
remoteIPremoteip
remotePortremoteport
localIPlocalip
localPortlocalport
groupIPgroupip
rcvBufSizercvbufsize
sendBufSizesendbufsize
updateTimeupdatetime
signalsArray of Signal
void NXOpen::Mechatronics::UDPSignalServerBuilder::SetConnectionInformation ( const char *  connectionName,
int  castMode,
const char *  remoteIP,
int  remotePort,
const char *  localIP,
int  localPort,
const char *  groupIP,
int  rcvBufSize,
int  sendBufSize,
double  updateTime,
const std::vector< NXOpen::Mechatronics::UDPSignalServerBuilder::Signal > &  signals 
)

Sets UDP connection information.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
connectionNameconnectionname
castModecastmode
remoteIPremoteip
remotePortremoteport
localIPlocalip
localPortlocalport
groupIPgroupip
rcvBufSizercvbufsize
sendBufSizesendbufsize
updateTimeupdatetime
signalsArray of Signal
void NXOpen::Mechatronics::UDPSignalServerBuilder::SetConnectionNames ( std::vector< NXString > &  names)

Sets UDP connection names.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
namesnames
void NXOpen::Mechatronics::UDPSignalServerBuilder::SetSelectedConfigurationName ( const NXString configurationName)

Sets.

the selected configuration name.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
configurationNameconfigurationname
void NXOpen::Mechatronics::UDPSignalServerBuilder::SetSelectedConfigurationName ( const char *  configurationName)

Sets.

the selected configuration name.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
configurationNameconfigurationname

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