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

Represents a NXOpen::Mechatronics::ProxyObjectBuilder . More...

Inheritance diagram for NXOpen::Mechatronics::ProxyObjectBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::Mechatronics::AdapterSignalBuilder

Public Types

enum  Type { TypeRuntimeParameters, TypeProxyObject }
 the Builder types. More...
 

Public Member Functions

NXOpen::Mechatronics::ProxyObjectBuilder::Type BuilderType ()
 Returns the use type of this builder. More...
 
NXOpen::BasePartContext ()
 Returns the context part of the proxy object
Created in NX8.5.0. More...
 
int MaxParamId ()
 Returns the maximum parameter id used in the proxy object
Created in NX8.5.0. More...
 
NXOpen::Mechatronics::ProxyObjectParameterBuilderListParameterList ()
 Returns the parameter data
Created in NX8.5.0. More...
 
NXString ProxyObjectName ()
 Returns the name of the proxy object
Created in NX8.5.0. More...
 
NXOpen::SelectNXObjectListSelectGeomObject ()
 Returns the select geometry object that describes the proxy object
Created in NX8.5.0. More...
 
NXOpen::SelectNXObjectListSelectPhysicsObject ()
 Returns the select physics objects that are encapsulated in the proxy object
Created in NX8.5.0. More...
 
void SetBuilderType (NXOpen::Mechatronics::ProxyObjectBuilder::Type useType)
 Sets the use type of this builder. More...
 
void SetContext (NXOpen::BasePart *context)
 Sets the context part of the proxy object
Created in NX8.5.0. More...
 
void SetMaxParamId (int paramId)
 Sets the maximum parameter id used in the proxy object
Created in NX8.5.0. More...
 
void SetProxyObjectName (const NXString &proxyObjectName)
 Sets the name of the proxy object
Created in NX8.5.0. More...
 
void SetProxyObjectName (const char *proxyObjectName)
 Sets the name of the proxy object
Created in NX8.5.0. More...
 
void SetUseType (int useType)
 Sets the use type used in the proxy object. More...
 
int UseType ()
 Returns the use type used in the proxy object. 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::ProxyObjectBuilder .


To create a new instance of this class, use NXOpen::Mechatronics::ProxyObjectCollection::CreateProxyObjectBuilder

Created in NX8.5.0.

Member Enumeration Documentation

the Builder types.

Enumerator
TypeRuntimeParameters 

Runtime Parameters.

TypeProxyObject 

Proxy Object.

Member Function Documentation

NXOpen::Mechatronics::ProxyObjectBuilder::Type NXOpen::Mechatronics::ProxyObjectBuilder::BuilderType ( )

Returns the use type of this builder.


Created in NX9.0.2.

License requirements : None

NXOpen::BasePart* NXOpen::Mechatronics::ProxyObjectBuilder::Context ( )

Returns the context part of the proxy object
Created in NX8.5.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

int NXOpen::Mechatronics::ProxyObjectBuilder::MaxParamId ( )

Returns the maximum parameter id used in the proxy object
Created in NX8.5.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::ProxyObjectParameterBuilderList* NXOpen::Mechatronics::ProxyObjectBuilder::ParameterList ( )

Returns the parameter data
Created in NX8.5.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::ProxyObjectBuilder::ProxyObjectName ( )

Returns the name of the proxy object
Created in NX8.5.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::SelectNXObjectList* NXOpen::Mechatronics::ProxyObjectBuilder::SelectGeomObject ( )

Returns the select geometry object that describes the proxy object
Created in NX8.5.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::SelectNXObjectList* NXOpen::Mechatronics::ProxyObjectBuilder::SelectPhysicsObject ( )

Returns the select physics objects that are encapsulated in the proxy object
Created in NX8.5.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::ProxyObjectBuilder::SetBuilderType ( NXOpen::Mechatronics::ProxyObjectBuilder::Type  useType)

Sets the use type of this builder.


Created in NX9.0.2.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
useTypeusetype
void NXOpen::Mechatronics::ProxyObjectBuilder::SetContext ( NXOpen::BasePart context)

Sets the context part of the proxy object
Created in NX8.5.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
contextcontext
void NXOpen::Mechatronics::ProxyObjectBuilder::SetMaxParamId ( int  paramId)

Sets the maximum parameter id used in the proxy object
Created in NX8.5.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
paramIdparamid
void NXOpen::Mechatronics::ProxyObjectBuilder::SetProxyObjectName ( const NXString proxyObjectName)

Sets the name of the proxy object
Created in NX8.5.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
proxyObjectNameproxyobjectname
void NXOpen::Mechatronics::ProxyObjectBuilder::SetProxyObjectName ( const char *  proxyObjectName)

Sets the name of the proxy object
Created in NX8.5.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
proxyObjectNameproxyobjectname
void NXOpen::Mechatronics::ProxyObjectBuilder::SetUseType ( int  useType)

Sets the use type used in the proxy object.

Use NXOpen::Mechatronics::ProxyObjectBuilder::BuilderType and NXOpen::Mechatronics::ProxyObjectBuilder::SetBuilderType instead.
Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
useTypeusetype
int NXOpen::Mechatronics::ProxyObjectBuilder::UseType ( )

Returns the use type used in the proxy object.

Use NXOpen::Mechatronics::ProxyObjectBuilder::BuilderType and NXOpen::Mechatronics::ProxyObjectBuilder::SetBuilderType instead.
Created in NX8.5.0.

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.