NXOpen .NET Reference  12.0.0
Public Member Functions | Properties | List of all members
NXOpen.Assemblies.Arrangement Class Reference

Manages the suppression of NXOpen.Assemblies.Component s within a NXOpen.Assemblies.ComponentAssembly . More...

Inheritance diagram for NXOpen.Assemblies.Arrangement:
NXOpen.NXObject NXOpen.INXObject

Public Member Functions

unsafe void Delete (bool forgetPositioning)
 Delete the given NXOpen.Assemblies.Arrangement . More...
 
unsafe bool GetMaintainsConstraints ()
 Get whether this NXOpen.Assemblies.Arrangement is currently used in the session. More...
 
unsafe bool GetHasPostponedConstraints ()
 Get whether this NXOpen.Assemblies.Arrangement has postponed its solve. More...
 
unsafe void SolvePostponedConstraints ()
 Forces a postponed NXOpen.Assemblies.Arrangement , that is not currently used in the session, to solve its constraints. More...
 
unsafe bool IsIsolated ()
 Get whether this NXOpen.Assemblies.Arrangement is isolated. More...
 
- Public Member Functions inherited from NXOpen.NXObject
unsafe void SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
unsafe NXOpen.AttributeIterator CreateAttributeIterator ()
 Create an attribute iterator More...
 
unsafe bool HasUserAttribute (NXOpen.AttributeIterator iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator More...
 
unsafe bool HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
 Gets the count of attributes on the object, if any, of the given type. More...
 
unsafe int GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
unsafe bool GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation 
GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
unsafe bool GetBooleanUserAttribute (string title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
unsafe int GetIntegerUserAttribute (string title, int index)
 Gets an integer attribute by Title and array Index. More...
 
unsafe double GetRealUserAttribute (string title, int index)
 Gets a real attribute by Title and array Index. More...
 
unsafe string GetStringUserAttribute (string title, int index)
 Gets a string attribute by Title and array Index. More...
 
unsafe string GetTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.ComputationalTime 
GetComputationalTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (NXOpen.AttributeIterator iterator)
 Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
unsafe string GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
unsafe void DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator More...
 
unsafe void DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
unsafe void DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
unsafe void SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
 Lock or unlock the given attribute. More...
 
unsafe bool GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
 Determine the lock of the given attribute. More...
 
unsafe NXOpen.NXObject[] GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
unsafe void SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
unsafe string GetPdmReferenceAttributeValue (string attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
 Deletes all attributes of a specific type. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes all attributes of a specific type with the option to update or not. More...
 
unsafe void SetAttribute (string title, int value)
 Creates or modifies an integer attribute. More...
 
unsafe void SetAttribute (string title, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, double value)
 Creates or modifies a real attribute. More...
 
unsafe void SetAttribute (string title, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, string value)
 Creates or modifies a string attribute. More...
 
unsafe void SetAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
unsafe void SetAttribute (string title, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetTimeAttribute (string title, string value)
 Creates or modifies a time attribute. More...
 
unsafe void SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe int GetIntegerAttribute (string title)
 Gets an integer attribute by title. More...
 
unsafe double GetRealAttribute (string title)
 Gets a real attribute by title. More...
 
unsafe string GetStringAttribute (string title)
 Gets a string attribute value by title. More...
 
unsafe string GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
 Gets a time attribute by title. More...
 
unsafe string GetReferenceAttribute (string title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
 Deletes an attribute by type and title. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
unsafe void SetReferenceAttribute (string title, string value)
 Creates or modifies a string attribute which uses a reference string. More...
 
unsafe void SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
unsafe string[] GetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe NXOpen.INXObject FindObject (string journalIdentifier)
 Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...
 
unsafe void Print ()
 Prints a representation of this object to the system log file. More...
 
unsafe void SetName (string name)
 Sets the custom name of the object. More...
 

Properties

unsafe bool IgnoringConstraints [get, set]
 Returns or sets the flag indicating whether this NXOpen.Assemblies.Arrangement is ignoring constraints. More...
 
unsafe
NXOpen.Assemblies.ComponentAssembly 
Owner [get]
 Returns the NXOpen.Assemblies.ComponentAssembly which owns this arrangement More...
 
- Properties inherited from NXOpen.NXObject
unsafe bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
unsafe string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
unsafe string Name [get]
 Returns the custom name of the object. More...
 
unsafe NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
unsafe NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
unsafe NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 
- Properties inherited from NXOpen.INXObject
bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
string Name [get]
 Returns the custom name of the object. More...
 
NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen.NXObject
enum  AttributeType {
  Invalid, Null, Boolean, Integer,
  Real, String, Time, Reference,
  Any = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { Numeric, Textual }
 Specifies the format of the date and time attribute. More...
 

Detailed Description

Manages the suppression of NXOpen.Assemblies.Component s within a NXOpen.Assemblies.ComponentAssembly .

Currently, an Arrangement simply acts as a context within which a Component can be suppressed, unsuppressed, or positioned.

To create an NXOpen.Assemblies.Arrangement , use the NXOpen.Assemblies.ArrangementCollection class.

An isolated NXOpen.Assemblies.Arrangement is an NXOpen.Assemblies.Arrangement that is capable of supporting isolated positions and isolated position overrides.

A standard NXOpen.Assemblies.Arrangement is an NXOpen.Assemblies.Arrangement that does not support isolated position or isolated position overrides. All NXOpen.Assemblies.Arrangement s created in NX 8.5 or earlier are standard NXOpen.Assemblies.Arrangement s.

Created in NX3.0.0

Member Function Documentation

unsafe void NXOpen.Assemblies.Arrangement.Delete ( bool  forgetPositioning)

Delete the given NXOpen.Assemblies.Arrangement .

If the forget_positioning flag is set to TRUE then components will not maintain their positions, otherwise variable component positioning will be created to maintain the components current positions. If the part containing the NXOpen.Assemblies.Arrangement is not already fully loaded this method will cause it to be.

Created in NX7.5.2

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters
forgetPositioningIf TRUE then components will not maintain their position.
unsafe bool NXOpen.Assemblies.Arrangement.GetHasPostponedConstraints ( )

Get whether this NXOpen.Assemblies.Arrangement has postponed its solve.

The solving of constraints is postponed in an NXOpen.Assemblies.Arrangement that is not currently used in the session. The constraints will solve when the component positions in the NXOpen.Assemblies.Arrangement are needed.

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns
Whether this NXOpen.Assemblies.Arrangement has postponed solving its constraints.
unsafe bool NXOpen.Assemblies.Arrangement.GetMaintainsConstraints ( )

Get whether this NXOpen.Assemblies.Arrangement is currently used in the session.

If it is, it will be kept up to date.

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns
Whether this NXOpen.Assemblies.Arrangement is currently used in the session.
unsafe bool NXOpen.Assemblies.Arrangement.IsIsolated ( )

Get whether this NXOpen.Assemblies.Arrangement is isolated.

An isolated NXOpen.Assemblies.Arrangement is an NXOpen.Assemblies.Arrangement that is capable of supporting isolated positions and isolated position overrides.

Created in NX9.0.1

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns
Whether this NXOpen.Assemblies.Arrangement is isolated.
unsafe void NXOpen.Assemblies.Arrangement.SolvePostponedConstraints ( )

Forces a postponed NXOpen.Assemblies.Arrangement , that is not currently used in the session, to solve its constraints.

This could lead to updating the model if required.

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Property Documentation

unsafe bool NXOpen.Assemblies.Arrangement.IgnoringConstraints
getset

Returns or sets the flag indicating whether this NXOpen.Assemblies.Arrangement is ignoring constraints.

Created in NX9.0.0

License requirements to get this property: assemblies ("ASSEMBLIES MODULE")

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.Assemblies.ComponentAssembly NXOpen.Assemblies.Arrangement.Owner
get

Returns the NXOpen.Assemblies.ComponentAssembly which owns this arrangement

Created in NX3.0.0

License requirements: None.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.