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

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

Inheritance diagram for NXOpen::Mechatronics::TransmitterEntryBuilder:
NXOpen::Mechatronics::PhysicsConstraintBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  TransmitterEntryCandidateType { TransmitterEntryCandidateTypeAnyObject, TransmitterEntryCandidateTypeOnlySelected }
 represents the candidate option. More...
 

Public Member Functions

NXOpen::SelectNXObjectListCandidate ()
 Returns. More...
 
NXOpen::Mechatronics::TransmitterEntryBuilder::TransmitterEntryCandidateType CandidateType ()
 Returns. More...
 
NXOpen::Mechatronics::SelectCollisionSensorListCollisionSensor ()
 Returns. More...
 
bool ExecuteOnce ()
 Returns. More...
 
int Port ()
 Returns. More...
 
void SetCandidateType (NXOpen::Mechatronics::TransmitterEntryBuilder::TransmitterEntryCandidateType candType)
 Sets. More...
 
void SetExecuteOnce (bool executeOnce)
 Sets. More...
 
void SetPort (int port)
 Sets. More...
 
- Public Member Functions inherited from NXOpen::Mechatronics::PhysicsConstraintBuilder
NXString Name ()
 Returns the name. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. 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 NXOpen::Mechatronics::TransmitterEntry builder.


To create a new instance of this class, use NXOpen::Mechatronics::TransmitterEntryCollection::CreateTransmitterEntryBuilder

Created in NX12.0.0.

Member Enumeration Documentation

represents the candidate option.

Enumerator
TransmitterEntryCandidateTypeAnyObject 

Any rigid objects.

TransmitterEntryCandidateTypeOnlySelected 

Selected sources.

Member Function Documentation

NXOpen::SelectNXObjectList* NXOpen::Mechatronics::TransmitterEntryBuilder::Candidate ( )

Returns.

the source selection. This can be a NXOpen::Mechatronics::RigidBody , NXOpen::Mechatronics::ObjectTransformer or NXOpen::Mechatronics::ObjectSource .


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::TransmitterEntryBuilder::TransmitterEntryCandidateType NXOpen::Mechatronics::TransmitterEntryBuilder::CandidateType ( )

Returns.

the type of candidate.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::SelectCollisionSensorList* NXOpen::Mechatronics::TransmitterEntryBuilder::CollisionSensor ( )

Returns.

the detector.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

bool NXOpen::Mechatronics::TransmitterEntryBuilder::ExecuteOnce ( )

Returns.

the execute once per activation. If this is true, the transmission will only happen once.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

int NXOpen::Mechatronics::TransmitterEntryBuilder::Port ( )

Returns.

the port of the sender.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::TransmitterEntryBuilder::SetCandidateType ( NXOpen::Mechatronics::TransmitterEntryBuilder::TransmitterEntryCandidateType  candType)

Sets.

the type of candidate.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
candTypecandtype
void NXOpen::Mechatronics::TransmitterEntryBuilder::SetExecuteOnce ( bool  executeOnce)

Sets.

the execute once per activation. If this is true, the transmission will only happen once.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
executeOnceexecuteonce
void NXOpen::Mechatronics::TransmitterEntryBuilder::SetPort ( int  port)

Sets.

the port of the sender.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
portport

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