Represents base class for all Order classes. More...

Inheritance diagram for NXOpen.Assemblies.Order:

Public Types
enum	State { UnSaved, Saved }
	Represents whether an order is saved or not More...

enum	Type { UserDefinedComponent, SequentialComponent, ChronologicalComponent, AlphanumericComponent, AlphabeticComponent }
	Represents the type of an order More...

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...

Public Member Functions
unsafe bool	GetReversed ()
	Gets the reverse state of the NXOpen.Assemblies.Order More...

unsafe void	SetReversed (bool isReversed)
	Sets the reverse state of the NXOpen.Assemblies.Order More...

unsafe void	Activate ()
	Applies this order More...

unsafe void	Delete ()
	Deletes an order More...

unsafe void	Save ()
	Saves an order More...

unsafe NXOpen.Assemblies.Order	SaveAs (string newName)
	Creates a copy of the order, and gives the copy a new name. More...

unsafe void	GetChildrenOrder (NXOpen.Assemblies.Component parent, out NXOpen.Assemblies.Component[] children)
	Returns immediate children of input NXOpen.Assemblies.Component as they are ordered in this NXOpen.Assemblies.ComponentOrder More...

unsafe bool	IsActive ()
	Returns true if this order is the active order in owning NXOpen.Assemblies.ComponentAssembly > 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 NXOpen.Assemblies.Order.State	OrderState `[get]`
	Returns the state of NXOpen.Assemblies.Order . More...

unsafe NXOpen.Assemblies.Order.Type	OrderType `[get]`
	Returns the type of NXOpen.Assemblies.Order . 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...

Detailed Description

Represents base class for all Order classes.

It is an abstract class and cannot be instantiated on its own. All Order classes should inherit from this class.

This is an abstract class, and cannot be instantiated.

Created in NX9.0.0

Member Enumeration Documentation

enum NXOpen.Assemblies.Order.State

Represents whether an order is saved or not

Enumerator
UnSaved	Order is unsaved
Saved	Order is saved

enum NXOpen.Assemblies.Order.Type

Represents the type of an order

Enumerator
UserDefinedComponent	User defined component order
SequentialComponent	System defined sequential component order
ChronologicalComponent	System defined chronological component order
AlphanumericComponent	System defined alphanumeric component order
AlphabeticComponent	System defined alphabetic component order

Member Function Documentation

unsafe void NXOpen.Assemblies.Order.Activate ( )

Applies this order

Created in NX9.0.0

License requirements: None.

unsafe void NXOpen.Assemblies.Order.Delete ( )

Deletes an order

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe void NXOpen.Assemblies.Order.GetChildrenOrder	(	NXOpen.Assemblies.Component	parent,
		out NXOpen.Assemblies.Component[]	children
	)

Returns immediate children of input NXOpen.Assemblies.Component as they are ordered in this NXOpen.Assemblies.ComponentOrder

Created in NX9.0.0

Deprecated in NX10.0.0. Use NXOpen.Assemblies.ComponentOrder.AskChildrenOrder instead to get children order in this NXOpen.Assemblies.ComponentOrder .

License requirements: None.

Parameters

parent
children	Returns children in order

unsafe bool NXOpen.Assemblies.Order.GetReversed ( )

Gets the reverse state of the NXOpen.Assemblies.Order

Created in NX9.0.0

License requirements: None.

Returns: True if order is reversed else False

unsafe bool NXOpen.Assemblies.Order.IsActive ( )

Returns true if this order is the active order in owning NXOpen.Assemblies.ComponentAssembly >

Created in NX10.0.3

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: True if the current order is active

unsafe void NXOpen.Assemblies.Order.Save ( )

Saves an order

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.Assemblies.Order NXOpen.Assemblies.Order.SaveAs ( string newName )

Creates a copy of the order, and gives the copy a new name.

Each NXOpen.Assemblies.ComponentAssembly contains a set of system defined orders, which could be queried using NXOpen.Assemblies.ComponentAssembly.GetComponentOrders method. A new NXOpen.Assemblies.Order.Type.UserDefinedComponent order can only be created using this method.

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

newName

Returns: The new Order

unsafe void NXOpen.Assemblies.Order.SetReversed ( bool isReversed )

Sets the reverse state of the NXOpen.Assemblies.Order

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

isReversed

Property Documentation

unsafe NXOpen.Assemblies.Order.State NXOpen.Assemblies.Order.OrderState

get

Returns the state of NXOpen.Assemblies.Order .

An order can be in one of the NXOpen.Assemblies.Order.State .

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.Assemblies.Order.Type NXOpen.Assemblies.Order.OrderType

get

Returns the type of NXOpen.Assemblies.Order .

An order can be of NXOpen.Assemblies.Order.Type

Created in NX9.0.0

License requirements: None.

The documentation for this class was generated from the following file:

dotnet_pool/Assemblies_Order.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation