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

Represents a NXOpen::Mechatronics::FunctionObjectBuilder
To create a new instance of this class, use NXOpen::Mechatronics::FunctionObjectCollection::CreateFunctionObjectBuilder

Created in NX7.5.1. More...

Inheritance diagram for NXOpen::Mechatronics::FunctionObjectBuilder:
NXOpen::Mechatronics::SystemObjectBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Classes

struct  ParameterData
 Defined Parameter Data Structure. More...
 
struct  RequirementData
 Defined Requirement Data Structure. More...
 

Public Member Functions

NXString ExampleDesc ()
 Returns the example description
Created in NX7.5.1. More...
 
NXString FunctionItemRevisionId ()
 Returns the part id
More...
 
NXString FunctionOptionSet ()
 Returns the option set
Created in NX7.5.1. More...
 
void GetChildren (std::vector< NXOpen::NXObject * > &children)
 Gets the children
Created in NX7.5.1. More...
 
void GetOccurrences (std::vector< NXOpen::NXObject * > &occurrences)
 Gets the occurrences
Created in NX7.5.1. More...
 
void GetOperations (std::vector< NXOpen::NXObject * > &operations)
 Gets the operations
Created in NX7.5.1. More...
 
std::vector
< NXOpen::Mechatronics::FunctionObjectBuilder::ParameterData
GetParameterData ()
 Gets the parameter data. More...
 
std::vector
< NXOpen::Mechatronics::FunctionObjectBuilder::RequirementData
GetRequirementData ()
 Gets the requirement data. More...
 
NXString LetterName ()
 Returns the letter name
Created in NX7.5.1. More...
 
bool Modified ()
 Returns the modified status. More...
 
NXOpen::NXObjectNavigatorObject ()
 Returns the navigator object which holds the teamcenter attributes. More...
 
NXOpen::Mechatronics::ObjectInformationBuilderObjectInformation ()
 Returns the object information builder, used to specify the information of function object. More...
 
NXString ObjectName ()
 Returns the object name
More...
 
NXOpen::NXObjectParent ()
 Returns the parent
Created in NX7.5.1. More...
 
NXString PlmxmlFileName ()
 Returns the plmxml file name
Created in NX7.5.1. More...
 
void SetChildren (const std::vector< NXOpen::NXObject * > &children)
 Sets the children
Created in NX7.5.1. More...
 
void SetExampleDesc (const NXString &exampleDesc)
 Sets the example description
Created in NX7.5.1. More...
 
void SetExampleDesc (const char *exampleDesc)
 Sets the example description
Created in NX7.5.1. More...
 
void SetFunctionItemRevisionId (const NXString &functionItemId)
 Sets the part id
More...
 
void SetFunctionItemRevisionId (const char *functionItemId)
 Sets the part id
More...
 
void SetFunctionOptionSet (const NXString &functionOptionSet)
 Sets the option set
Created in NX7.5.1. More...
 
void SetFunctionOptionSet (const char *functionOptionSet)
 Sets the option set
Created in NX7.5.1. More...
 
void SetLetterName (const NXString &letterName)
 Sets the letter name
Created in NX7.5.1. More...
 
void SetLetterName (const char *letterName)
 Sets the letter name
Created in NX7.5.1. More...
 
void SetModified (bool modified)
 Sets the modified status. More...
 
void SetObjectName (const NXString &objectName)
 Sets the object name
More...
 
void SetObjectName (const char *objectName)
 Sets the object name
More...
 
void SetOccurrences (const std::vector< NXOpen::NXObject * > &occurrences)
 Sets the occurrences
Created in NX7.5.1. More...
 
void SetOperations (const std::vector< NXOpen::NXObject * > &operations)
 Sets the operations
Created in NX7.5.1. More...
 
void SetParameterData (const std::vector< NXOpen::Mechatronics::FunctionObjectBuilder::ParameterData > &parameterData)
 Sets the parameter data
Created in NX7.5.1. More...
 
void SetParent (NXOpen::NXObject *children)
 Sets the parent
Created in NX7.5.1. More...
 
void SetPlmxmlFileName (const NXString &plmxmlFileName)
 Sets the plmxml file name
Created in NX7.5.1. More...
 
void SetPlmxmlFileName (const char *plmxmlFileName)
 Sets the plmxml file name
Created in NX7.5.1. More...
 
void SetRequirementData (const std::vector< NXOpen::Mechatronics::FunctionObjectBuilder::RequirementData > &requirementData)
 Sets the requirement data
More...
 
void SetTypeDesc (const NXString &typeDesc)
 Sets the type description
Created in NX7.5.1. More...
 
void SetTypeDesc (const char *typeDesc)
 Sets the type description
Created in NX7.5.1. More...
 
NXString TypeDesc ()
 Returns the type description
Created in NX7.5.1. More...
 
- Public Member Functions inherited from NXOpen::Mechatronics::SystemObjectBuilder
NXString InstanceName ()
 Returns the name of instance. More...
 
void SetInstanceName (const NXString &name)
 Sets the name of instance. More...
 
void SetInstanceName (const char *name)
 Sets the name of instance. 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::FunctionObjectBuilder
To create a new instance of this class, use NXOpen::Mechatronics::FunctionObjectCollection::CreateFunctionObjectBuilder

Created in NX7.5.1.


Member Function Documentation

NXString NXOpen::Mechatronics::FunctionObjectBuilder::ExampleDesc ( )

Returns the example description
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::FunctionObjectBuilder::FunctionItemRevisionId ( )

Returns the part id

Deprecated:
Deprecated in NX8.5.0.

Please use NXOpen::Mechatronics::ObjectInformationBuilder instead.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::FunctionObjectBuilder::FunctionOptionSet ( )

Returns the option set
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::FunctionObjectBuilder::GetChildren ( std::vector< NXOpen::NXObject * > &  children)

Gets the children
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
childrenChildren object array
void NXOpen::Mechatronics::FunctionObjectBuilder::GetOccurrences ( std::vector< NXOpen::NXObject * > &  occurrences)

Gets the occurrences
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
occurrencesOccurrences object array
void NXOpen::Mechatronics::FunctionObjectBuilder::GetOperations ( std::vector< NXOpen::NXObject * > &  operations)

Gets the operations
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
operationsOperations object array
std::vector<NXOpen::Mechatronics::FunctionObjectBuilder::ParameterData> NXOpen::Mechatronics::FunctionObjectBuilder::GetParameterData ( )

Gets the parameter data.

Returns
Parameter data array
Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
std::vector<NXOpen::Mechatronics::FunctionObjectBuilder::RequirementData> NXOpen::Mechatronics::FunctionObjectBuilder::GetRequirementData ( )

Gets the requirement data.

Returns
Requirement data array
Deprecated:
Deprecated in NX8.5.0. Please use NXOpen::Mechatronics::RequirementBuilder instead.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::FunctionObjectBuilder::LetterName ( )

Returns the letter name
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

bool NXOpen::Mechatronics::FunctionObjectBuilder::Modified ( )

Returns the modified status.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::NXObject* NXOpen::Mechatronics::FunctionObjectBuilder::NavigatorObject ( )

Returns the navigator object which holds the teamcenter attributes.


Created in NX8.5.0.

License requirements : None

NXOpen::Mechatronics::ObjectInformationBuilder* NXOpen::Mechatronics::FunctionObjectBuilder::ObjectInformation ( )

Returns the object information builder, used to specify the information of function object.


Created in NX8.5.0.

License requirements : None

NXString NXOpen::Mechatronics::FunctionObjectBuilder::ObjectName ( )

Returns the object name

Deprecated:
Deprecated in NX8.5.0.

Please use NXOpen::Mechatronics::ObjectInformationBuilder instead.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::NXObject* NXOpen::Mechatronics::FunctionObjectBuilder::Parent ( )

Returns the parent
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::FunctionObjectBuilder::PlmxmlFileName ( )

Returns the plmxml file name
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::FunctionObjectBuilder::SetChildren ( const std::vector< NXOpen::NXObject * > &  children)

Sets the children
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
childrenChildren object array
void NXOpen::Mechatronics::FunctionObjectBuilder::SetExampleDesc ( const NXString exampleDesc)

Sets the example description
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
exampleDescExample description
void NXOpen::Mechatronics::FunctionObjectBuilder::SetExampleDesc ( const char *  exampleDesc)

Sets the example description
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
exampleDescExample description
void NXOpen::Mechatronics::FunctionObjectBuilder::SetFunctionItemRevisionId ( const NXString functionItemId)

Sets the part id

Deprecated:
Deprecated in NX8.5.0.

Please use NXOpen::Mechatronics::ObjectInformationBuilder instead.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
functionItemIdFunction Revision Item id
void NXOpen::Mechatronics::FunctionObjectBuilder::SetFunctionItemRevisionId ( const char *  functionItemId)

Sets the part id

Deprecated:
Deprecated in NX8.5.0.

Please use NXOpen::Mechatronics::ObjectInformationBuilder instead.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
functionItemIdFunction Revision Item id
void NXOpen::Mechatronics::FunctionObjectBuilder::SetFunctionOptionSet ( const NXString functionOptionSet)

Sets the option set
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
functionOptionSetFunction Option Set
void NXOpen::Mechatronics::FunctionObjectBuilder::SetFunctionOptionSet ( const char *  functionOptionSet)

Sets the option set
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
functionOptionSetFunction Option Set
void NXOpen::Mechatronics::FunctionObjectBuilder::SetLetterName ( const NXString letterName)

Sets the letter name
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
letterNameLetter name
void NXOpen::Mechatronics::FunctionObjectBuilder::SetLetterName ( const char *  letterName)

Sets the letter name
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
letterNameLetter name
void NXOpen::Mechatronics::FunctionObjectBuilder::SetModified ( bool  modified)

Sets the modified status.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
modifiedmodified
void NXOpen::Mechatronics::FunctionObjectBuilder::SetObjectName ( const NXString objectName)

Sets the object name

Deprecated:
Deprecated in NX8.5.0.

Please use NXOpen::Mechatronics::ObjectInformationBuilder instead.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
objectNameObject name
void NXOpen::Mechatronics::FunctionObjectBuilder::SetObjectName ( const char *  objectName)

Sets the object name

Deprecated:
Deprecated in NX8.5.0.

Please use NXOpen::Mechatronics::ObjectInformationBuilder instead.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
objectNameObject name
void NXOpen::Mechatronics::FunctionObjectBuilder::SetOccurrences ( const std::vector< NXOpen::NXObject * > &  occurrences)

Sets the occurrences
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
occurrencesOccurrences object array
void NXOpen::Mechatronics::FunctionObjectBuilder::SetOperations ( const std::vector< NXOpen::NXObject * > &  operations)

Sets the operations
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
operationsOperations object array
void NXOpen::Mechatronics::FunctionObjectBuilder::SetParameterData ( const std::vector< NXOpen::Mechatronics::FunctionObjectBuilder::ParameterData > &  parameterData)

Sets the parameter data
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
parameterDataParameter data array
void NXOpen::Mechatronics::FunctionObjectBuilder::SetParent ( NXOpen::NXObject children)

Sets the parent
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
childrenParent function object
void NXOpen::Mechatronics::FunctionObjectBuilder::SetPlmxmlFileName ( const NXString plmxmlFileName)

Sets the plmxml file name
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
plmxmlFileNamePLMXML file name
void NXOpen::Mechatronics::FunctionObjectBuilder::SetPlmxmlFileName ( const char *  plmxmlFileName)

Sets the plmxml file name
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
plmxmlFileNamePLMXML file name
void NXOpen::Mechatronics::FunctionObjectBuilder::SetRequirementData ( const std::vector< NXOpen::Mechatronics::FunctionObjectBuilder::RequirementData > &  requirementData)

Sets the requirement data

Deprecated:
Deprecated in NX8.5.0.

Please use NXOpen::Mechatronics::RequirementBuilder instead.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
requirementDataRequirement data array
void NXOpen::Mechatronics::FunctionObjectBuilder::SetTypeDesc ( const NXString typeDesc)

Sets the type description
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
typeDescType description
void NXOpen::Mechatronics::FunctionObjectBuilder::SetTypeDesc ( const char *  typeDesc)

Sets the type description
Created in NX7.5.1.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
typeDescType description
NXString NXOpen::Mechatronics::FunctionObjectBuilder::TypeDesc ( )

Returns the type description
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.