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

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

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

Public Types

enum  DeleteSourceType { DeleteSourceTypeAnycopiedobjects, DeleteSourceTypeSelectedsources }
 the delete option. More...
 

Public Member Functions

NXOpen::Mechatronics::SelectCollisionSensorListCollisionSensor ()
 Returns the object select. More...
 
NXOpen::Mechatronics::ObjectSinkBuilder::DeleteSourceType DeleteSource ()
 Returns the option to delete source. More...
 
NXString Name ()
 Returns the name. More...
 
void SetCollisionSensor (const std::vector< NXOpen::Mechatronics::CollisionSensor * > &objects)
 Sets the collision sensor object. More...
 
void SetDeleteSource (NXOpen::Mechatronics::ObjectSinkBuilder::DeleteSourceType deleteSource)
 Sets the option to delete source. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. More...
 
void SetSource (const std::vector< NXOpen::NXObject * > &objects)
 Sets the source. More...
 
NXOpen::SelectNXObjectListSource ()
 Returns the source select. 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::ObjectSink builder.


To create a new instance of this class, use NXOpen::Mechatronics::ObjectSinkCollection::CreateObjectSinkBuilder

Created in NX7.5.1.

Member Enumeration Documentation

the delete option.

Enumerator
DeleteSourceTypeAnycopiedobjects 

Any copied objects.

DeleteSourceTypeSelectedsources 

Selected sources.

Member Function Documentation

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

Returns the object select.

This can be a NXOpen::Mechatronics::CollisionSensor .
Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::ObjectSinkBuilder::DeleteSourceType NXOpen::Mechatronics::ObjectSinkBuilder::DeleteSource ( )

Returns the option to delete source.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::ObjectSinkBuilder::Name ( )

Returns the name.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::ObjectSinkBuilder::SetCollisionSensor ( const std::vector< NXOpen::Mechatronics::CollisionSensor * > &  objects)

Sets the collision sensor object.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
objectsCollision Sensor objects
void NXOpen::Mechatronics::ObjectSinkBuilder::SetDeleteSource ( NXOpen::Mechatronics::ObjectSinkBuilder::DeleteSourceType  deleteSource)

Sets the option to delete source.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
deleteSourcedeletesource
void NXOpen::Mechatronics::ObjectSinkBuilder::SetName ( const NXString name)

Sets the name.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
namename
void NXOpen::Mechatronics::ObjectSinkBuilder::SetName ( const char *  name)

Sets the name.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
namename
void NXOpen::Mechatronics::ObjectSinkBuilder::SetSource ( const std::vector< NXOpen::NXObject * > &  objects)

Sets the source.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
objectsSource objects
NXOpen::SelectNXObjectList* NXOpen::Mechatronics::ObjectSinkBuilder::Source ( )

Returns the source select.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")


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