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

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

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

Public Types

enum  CopyEventTriggerOption { CopyEventTriggerOptionTimeBased, CopyEventTriggerOptionOncePerActivation }
 Trigger Option in copy event. More...
 

Public Member Functions

NXOpen::Mechatronics::ObjectSourceBuilder::CopyEventTriggerOption CopyEventTrigger ()
 Returns the event option. More...
 
NXString Name ()
 Returns the name. More...
 
NXOpen::SelectNXObjectListObjectToCopy ()
 Returns the object select. More...
 
void SetCopyEventTrigger (NXOpen::Mechatronics::ObjectSourceBuilder::CopyEventTriggerOption copyEventTrigger)
 Sets the event option. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. More...
 
void SetObjectsToCopy (const std::vector< NXOpen::NXObject * > &objects)
 Sets the objects to be copied. More...
 
NXOpen::ExpressionStartOffset ()
 Returns the start offset. More...
 
NXOpen::ExpressionTimeInterval ()
 Returns the time interval. 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::ObjectSource builder.


To create a new instance of this class, use NXOpen::Mechatronics::ObjectSourceCollection::CreateObjectSourceBuilder

Created in NX7.5.1.

Member Enumeration Documentation

Trigger Option in copy event.

Enumerator
CopyEventTriggerOptionTimeBased 

TimeBased.

CopyEventTriggerOptionOncePerActivation 

OncePerActivation.

Member Function Documentation

NXOpen::Mechatronics::ObjectSourceBuilder::CopyEventTriggerOption NXOpen::Mechatronics::ObjectSourceBuilder::CopyEventTrigger ( )

Returns the event option.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::ObjectSourceBuilder::Name ( )

Returns the name.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::SelectNXObjectList* NXOpen::Mechatronics::ObjectSourceBuilder::ObjectToCopy ( )

Returns the object select.

This can be a NXOpen::Mechatronics::RigidBody or NXOpen::Assemblies::ComponentAssembly .
Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::ObjectSourceBuilder::SetCopyEventTrigger ( NXOpen::Mechatronics::ObjectSourceBuilder::CopyEventTriggerOption  copyEventTrigger)

Sets the event option.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
copyEventTriggercopyeventtrigger
void NXOpen::Mechatronics::ObjectSourceBuilder::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::ObjectSourceBuilder::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::ObjectSourceBuilder::SetObjectsToCopy ( const std::vector< NXOpen::NXObject * > &  objects)

Sets the objects to be copied.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
objectsObjects to be copied
NXOpen::Expression* NXOpen::Mechatronics::ObjectSourceBuilder::StartOffset ( )

Returns the start offset.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::ObjectSourceBuilder::TimeInterval ( )

Returns the time interval.


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.