FunctionObjectBuilder Class

class NXOpen.Mechatronics.FunctionObjectBuilder

Bases: NXOpen.Mechatronics.SystemObjectBuilder

Represents a NXOpen.Mechatronics.FunctionObjectBuilder

To create a new instance of this class, use NXOpen.Mechatronics.FunctionObjectCollection.CreateFunctionObjectBuilder()

New in version NX7.5.1.

Properties

Property	Description
ExampleDesc	Returns or sets the example description
FunctionItemRevisionId	Returns or sets the part id
FunctionOptionSet	Returns or sets the option set
InstanceName	Returns or sets the name of instance.
LetterName	Returns or sets the letter name
Modified	Returns or sets the modified status.
NavigatorObject	Returns the navigator object which holds the teamcenter attributes.
ObjectInformation	Returns the object information builder, used to specify the information of function object.
ObjectName	Returns or sets the object name
Parent	Returns or sets the parent
PlmxmlFileName	Returns or sets the plmxml file name
Tag	Returns the Tag for this object.
TypeDesc	Returns or sets the type description

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetChildren	Gets the children
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
GetOccurrences	Gets the occurrences
GetOperations	Gets the operations
GetParameterData	Gets the parameter data
GetRequirementData	Gets the requirement data
SetChildren	Sets the children
SetOccurrences	Sets the occurrences
SetOperations	Sets the operations
SetParameterData	Sets the parameter data
SetRequirementData	Sets the requirement data
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Structs

FunctionObjectBuilderParameterData_Struct Struct	Defined Parameter Data Structure
FunctionObjectBuilderRequirementData_Struct Struct	Defined Requirement Data Structure

Property Detail

ExampleDesc

FunctionObjectBuilder.ExampleDesc

Returns or sets the example description

-------------------------------------

Getter Method

Signature ExampleDesc

Returns:Example description Return type:str

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature ExampleDesc

Parameters:exampleDesc (str) – Example description

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

FunctionItemRevisionId

FunctionObjectBuilder.FunctionItemRevisionId

Returns or sets the part id

-------------------------------------

Getter Method

Signature FunctionItemRevisionId

Returns:Function Revision Item id Return type:str

New in version NX7.5.1.

Deprecated since version NX8.5.0: Please use NXOpen.Mechatronics.ObjectInformationBuilder instead.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature FunctionItemRevisionId

Parameters:functionItemId (str) – Function Revision Item id

New in version NX7.5.1.

Deprecated since version NX8.5.0: Please use NXOpen.Mechatronics.ObjectInformationBuilder instead.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

FunctionOptionSet

FunctionObjectBuilder.FunctionOptionSet

Returns or sets the option set

-------------------------------------

Getter Method

Signature FunctionOptionSet

Returns:Function Option Set Return type:str

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature FunctionOptionSet

Parameters:functionOptionSet (str) – Function Option Set

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

LetterName

FunctionObjectBuilder.LetterName

Returns or sets the letter name

-------------------------------------

Getter Method

Signature LetterName

Returns:Letter name Return type:str

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature LetterName

Parameters:letterName (str) – Letter name

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Modified

FunctionObjectBuilder.Modified

Returns or sets the modified status.

-------------------------------------

Getter Method

Signature Modified

Returns: Return type:bool

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature Modified

Parameters:modified (bool) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

NavigatorObject

FunctionObjectBuilder.NavigatorObject

Returns the navigator object which holds the teamcenter attributes.

-------------------------------------

Getter Method

Signature NavigatorObject

Returns: Return type:NXOpen.NXObject

New in version NX8.5.0.

License requirements: None.

ObjectInformation

FunctionObjectBuilder.ObjectInformation

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

-------------------------------------

Getter Method

Signature ObjectInformation

Returns:object information Builder Return type:NXOpen.Mechatronics.ObjectInformationBuilder

New in version NX8.5.0.

License requirements: None.

ObjectName

FunctionObjectBuilder.ObjectName

Returns or sets the object name

-------------------------------------

Getter Method

Signature ObjectName

Returns:Object name Return type:str

New in version NX7.5.1.

Deprecated since version NX8.5.0: Please use NXOpen.Mechatronics.ObjectInformationBuilder instead.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature ObjectName

Parameters:objectName (str) – Object name

New in version NX7.5.1.

Deprecated since version NX8.5.0: Please use NXOpen.Mechatronics.ObjectInformationBuilder instead.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Parent

FunctionObjectBuilder.Parent

Returns or sets the parent

-------------------------------------

Getter Method

Signature Parent

Returns:Parent function object Return type:NXOpen.NXObject

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature Parent

Parameters:children (NXOpen.NXObject) – Parent function object

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

PlmxmlFileName

FunctionObjectBuilder.PlmxmlFileName

Returns or sets the plmxml file name

-------------------------------------

Getter Method

Signature PlmxmlFileName

Returns:PLMXML file name Return type:str

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature PlmxmlFileName

Parameters:plmxmlFileName (str) – PLMXML file name

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

TypeDesc

FunctionObjectBuilder.TypeDesc

Returns or sets the type description

-------------------------------------

Getter Method

Signature TypeDesc

Returns:Type description Return type:str

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature TypeDesc

Parameters:typeDesc (str) – Type description

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

GetChildren

FunctionObjectBuilder.GetChildren

Gets the children

Signature GetChildren()

Returns:Children object array Return type:list of NXOpen.NXObject

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetOccurrences

FunctionObjectBuilder.GetOccurrences

Gets the occurrences

Signature GetOccurrences()

Returns:Occurrences object array Return type:list of NXOpen.NXObject

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetOperations

FunctionObjectBuilder.GetOperations

Gets the operations

Signature GetOperations()

Returns:Operations object array Return type:list of NXOpen.NXObject

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetParameterData

FunctionObjectBuilder.GetParameterData

Gets the parameter data

Signature GetParameterData()

Returns:Parameter data array Return type:list of NXOpen.Mechatronics.FunctionObjectBuilderParameterData_Struct

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetRequirementData

FunctionObjectBuilder.GetRequirementData

Gets the requirement data

Signature GetRequirementData()

Returns:Requirement data array Return type:list of NXOpen.Mechatronics.FunctionObjectBuilderRequirementData_Struct

New in version NX7.5.1.

Deprecated since version NX8.5.0: Please use NXOpen.Mechatronics.RequirementBuilder instead.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetChildren

FunctionObjectBuilder.SetChildren

Sets the children

Signature SetChildren(children)

Parameters:children (list of NXOpen.NXObject) – Children object array

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetOccurrences

FunctionObjectBuilder.SetOccurrences

Sets the occurrences

Signature SetOccurrences(occurrences)

Parameters:occurrences (list of NXOpen.NXObject) – Occurrences object array

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetOperations

FunctionObjectBuilder.SetOperations

Sets the operations

Signature SetOperations(operations)

Parameters:operations (list of NXOpen.NXObject) – Operations object array

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetParameterData

FunctionObjectBuilder.SetParameterData

Sets the parameter data

Signature SetParameterData(parameterData)

Parameters:parameterData (list of NXOpen.Mechatronics.FunctionObjectBuilderParameterData_Struct) – Parameter data array

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetRequirementData

FunctionObjectBuilder.SetRequirementData

Sets the requirement data

Signature SetRequirementData(requirementData)

Parameters:requirementData (list of NXOpen.Mechatronics.FunctionObjectBuilderRequirementData_Struct) – Requirement data array

New in version NX7.5.1.

Deprecated since version NX8.5.0: Please use NXOpen.Mechatronics.RequirementBuilder instead.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Validate

FunctionObjectBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.