SolverAppendOption Class

class NXOpen.CAE.SolverAppendOption

Bases: NXOpen.NXObject

This class provides access to the append option setting for importing solver specific data into existing Fem/Sim

Not support KF.

New in version NX7.5.2.

Properties

Property	Description
CoordinateSystemOffset	Returns or sets the coordinate system offset
DoAppendMerge	Returns or sets the append merge option
ElementOffset	Returns or sets the element offset
ImportBehavior	Returns or sets the import behavior choice
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
MaterialMergeOption	Returns or sets the material merge choice
Name	Returns the custom name of the object.
NodeMergeOption	Returns or sets the node merge choice
NodeOffset	Returns or sets the node offset
OthersOffset	Returns or sets the offset for all other entities
OwningComponent	Returns the owning component, if this object is an occurrence.
OwningPart	Returns the owning part of this object
PhysicalPropertyOffset	Returns or sets the physical property offset
PptMergeOption	Returns or sets the physical property merge choice
Prototype	Returns the prototype of this object if it is an occurrence.
SolutionMergeOption	Returns or sets the solution merge choice
SolverName	Returns or sets the solver name
Tag	Returns the Tag for this object.

Methods

Method	Description
CreateAttributeIterator	Create an attribute iterator
DeleteAllAttributesByType	Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle	Deletes an attribute by type and title.
DeleteUserAttribute	Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes	Deletes the attributes on the object, if any, that satisfy the given iterator
FindObject	Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAttributeTitlesByType	Gets all the attribute titles of a specific type.
GetBooleanUserAttribute	Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute	Gets a time attribute by Title and array Index.
GetHighestCoordinateSystemLabel	Gets the highest coordinate system label from the work Fem/Sim
GetHighestElementLabel	Gets the highest element label from the work Fem/Sim
GetHighestNodeLabel	Gets the highest node label from the work Fem/Sim
GetHighestOthersLabel	Gets the highest label for all other entities from the work Fem/Sim
GetHighestPhysicalPropertyLabel	Gets the highest physical property label from the work Fem/Sim
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue	Gets the value of PDM Reference attribute for given object.
GetRealAttribute	Gets a real attribute by title.
GetRealUserAttribute	Gets a real attribute by Title and array Index.
GetReferenceAttribute	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetStringAttribute	Gets a string attribute value by title.
GetStringUserAttribute	Gets a string attribute by Title and array Index.
GetTimeAttribute	Gets a time attribute by title.
GetTimeUserAttribute	Gets a time attribute by Title and array Index.
GetUserAttribute	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString	Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount	Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock	Determine the lock of the given attribute.
GetUserAttributeSize	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects	Returns an array of objects from which this object presents attributes.
GetUserAttributes	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings	Gets all the attributes that have been set on the given object.
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator
Print	Prints a representation of this object to the system log file.
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
SetName	Sets the custom name of the object.
SetPdmReferenceAttribute	Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute	Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute	Creates or modifies a time attribute.
SetTimeUserAttribute	Creates or modifies a time attribute with the option to update or not.
SetUserAttribute	Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock	Lock or unlock the given attribute.

Enumerations

SolverAppendOptionImportBehaviorOption Enumeration	Options to control how the imported input file is to be combined with the existing model
SolverAppendOptionMergeOption Enumeration	Options to control how entities are merge with existing model
SolverAppendOptionSolutionOption Enumeration	Options to control if a solution is created during merge

Property Detail

CoordinateSystemOffset

SolverAppendOption.CoordinateSystemOffset

Returns or sets the coordinate system offset

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

Getter Method

Signature CoordinateSystemOffset

Returns:the coordinate system offset Return type:int

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

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

Setter Method

Signature CoordinateSystemOffset

Parameters:csOffset (int) – the coordinate system offset

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

DoAppendMerge

SolverAppendOption.DoAppendMerge

Returns or sets the append merge option

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

Getter Method

Signature DoAppendMerge

Returns:flag indicating if new entities should be merged with existing model Return type:bool

New in version NX8.5.0.

Deprecated since version NX9.0.0: Use NXOpen.CAE.SolverAppendOption.ImportBehavior() instead.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

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

Setter Method

Signature DoAppendMerge

Parameters:doMerge (bool) – true if new entities should be merged with existing model

New in version NX8.5.0.

Deprecated since version NX9.0.0: Use NXOpen.CAE.SolverAppendOption.SetImportBehavior() instead.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

ElementOffset

SolverAppendOption.ElementOffset

Returns or sets the element offset

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

Getter Method

Signature ElementOffset

Returns:the element offset Return type:int

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

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

Setter Method

Signature ElementOffset

Parameters:elemOffset (int) – the element offset

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

ImportBehavior

SolverAppendOption.ImportBehavior

Returns or sets the import behavior choice

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

Getter Method

Signature ImportBehavior

Returns:how the input file should be imported Return type:NXOpen.CAE.SolverAppendOptionImportBehaviorOption

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

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

Setter Method

Signature ImportBehavior

Parameters:behaviorOption (NXOpen.CAE.SolverAppendOptionImportBehaviorOption) – how the input file should be imported

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

IsOccurrence

SolverAppendOption.IsOccurrence

Returns whether this object is an occurrence or not.

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

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence Return type:bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier

SolverAppendOption.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

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

Getter Method

Signature JournalIdentifier

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

MaterialMergeOption

SolverAppendOption.MaterialMergeOption

Returns or sets the material merge choice

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

Getter Method

Signature MaterialMergeOption

Returns:type of merging to perform for materials Return type:NXOpen.CAE.SolverAppendOptionMergeOption

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

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

Setter Method

Signature MaterialMergeOption

Parameters:mergeChoice (NXOpen.CAE.SolverAppendOptionMergeOption) – type of merging to perform for materials

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

Name

SolverAppendOption.Name

Returns the custom name of the object.

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

Getter Method

Signature Name

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

NodeMergeOption

SolverAppendOption.NodeMergeOption

Returns or sets the node merge choice

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

Getter Method

Signature NodeMergeOption

Returns:type of merging to perform for nodes Return type:NXOpen.CAE.SolverAppendOptionMergeOption

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

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

Setter Method

Signature NodeMergeOption

Parameters:mergeChoice (NXOpen.CAE.SolverAppendOptionMergeOption) – type of merging to perform for nodes

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

NodeOffset

SolverAppendOption.NodeOffset

Returns or sets the node offset

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

Getter Method

Signature NodeOffset

Returns:the node offset Return type:int

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

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

Setter Method

Signature NodeOffset

Parameters:nodeOffset (int) – the node offset

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

OthersOffset

SolverAppendOption.OthersOffset

Returns or sets the offset for all other entities

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

Getter Method

Signature OthersOffset

Returns:the offset for all other entities Return type:int

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

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

Setter Method

Signature OthersOffset

Parameters:othersOffset (int) – the offset for all other entities

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

OwningComponent

SolverAppendOption.OwningComponent

Returns the owning component, if this object is an occurrence.

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

Getter Method

Signature OwningComponent

Returns: Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

SolverAppendOption.OwningPart

Returns the owning part of this object

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

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

PhysicalPropertyOffset

SolverAppendOption.PhysicalPropertyOffset

Returns or sets the physical property offset

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

Getter Method

Signature PhysicalPropertyOffset

Returns:the physical property offset Return type:int

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

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

Setter Method

Signature PhysicalPropertyOffset

Parameters:physicalPropertyOffset (int) – the physical property offset

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

PptMergeOption

SolverAppendOption.PptMergeOption

Returns or sets the physical property merge choice

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

Getter Method

Signature PptMergeOption

Returns:type of merging to perform for ppts Return type:NXOpen.CAE.SolverAppendOptionMergeOption

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

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

Setter Method

Signature PptMergeOption

Parameters:mergeChoice (NXOpen.CAE.SolverAppendOptionMergeOption) – type of merging to perform for ppts

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

Prototype

SolverAppendOption.Prototype

Returns the prototype of this object if it is an occurrence.

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

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

SolutionMergeOption

SolverAppendOption.SolutionMergeOption

Returns or sets the solution merge choice

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

Getter Method

Signature SolutionMergeOption

Returns:type of merging to perform for solutions Return type:NXOpen.CAE.SolverAppendOptionSolutionOption

New in version NX9.0.0.

Deprecated since version NX10.0.0: Functionality moved to the solver language DLLs.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

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

Setter Method

Signature SolutionMergeOption

Parameters:mergeChoice (NXOpen.CAE.SolverAppendOptionSolutionOption) – type of merging to perform for solutions

New in version NX9.0.0.

Deprecated since version NX10.0.0: Functionality moved to the solver language DLLs.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

SolverName

SolverAppendOption.SolverName

Returns or sets the solver name

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

Getter Method

Signature SolverName

Returns:the solver name to indicate what type of data is being imported Return type:str

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

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

Setter Method

Signature SolverName

Parameters:solverName (str) – the solver name to indicate what type of data is being imported

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

Method Detail

FindObject

SolverAppendOption.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object Returns: Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

GetHighestCoordinateSystemLabel

SolverAppendOption.GetHighestCoordinateSystemLabel

Gets the highest coordinate system label from the work Fem/Sim

Signature GetHighestCoordinateSystemLabel()

Returns:the highest coordinate system label Return type:int

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

GetHighestElementLabel

SolverAppendOption.GetHighestElementLabel

Gets the highest element label from the work Fem/Sim

Signature GetHighestElementLabel()

Returns:the highest element label Return type:int

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

GetHighestNodeLabel

SolverAppendOption.GetHighestNodeLabel

Gets the highest node label from the work Fem/Sim

Signature GetHighestNodeLabel()

Returns:the highest node label Return type:int

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

GetHighestOthersLabel

SolverAppendOption.GetHighestOthersLabel

Gets the highest label for all other entities from the work Fem/Sim

Signature GetHighestOthersLabel()

Returns:the highest label for all other entities Return type:int

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

GetHighestPhysicalPropertyLabel

SolverAppendOption.GetHighestPhysicalPropertyLabel

Gets the highest physical property label from the work Fem/Sim

Signature GetHighestPhysicalPropertyLabel()

Returns:the highest physical property label Return type:int

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

Print

SolverAppendOption.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

SolverAppendOption.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.