NXOpen .NET Reference Guide
1899
|
Represents the System Object. More...
Public Types | |
enum | RelationType { Ecad = 1 } |
Relation type. More... | |
enum | ReorderType { Before = 1, After } |
Reorder object type to specify the relative position. 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 void | AddComponent (NXOpen.Assemblies.Component[] comps) |
Adds Assemblies.Component . More... | |
unsafe void | AddOperation (NXOpen.NXObject[] opers) |
Adds operation object. More... | |
unsafe void | AddPhysicsObjects (NXOpen.NXObject[] objects) |
Adds behavioral physics objects. More... | |
unsafe void | AddSignalAdapters (NXOpen.NXObject[] adapters) |
Adds signal adapter objects. More... | |
unsafe void | ApplyNamingRule () |
Perform naming rule check and update the designation. More... | |
unsafe void | AssociateItem (NXOpen.Mechatronics.SystemObject.RelationType type, string itemMFKID, string revisionID) |
Associate a specified item to this system object. More... | |
unsafe void | CreateTraceLink (NXOpen.Mechatronics.SystemObject pComplying) |
Creates the trace link for system objects. More... | |
unsafe void | DissociateItem (string itemMFKID, string revisionID) |
Dissociate a specified item from this system object. More... | |
unsafe void | GetAssociateItem (NXOpen.Mechatronics.SystemObject.RelationType type, out string itemMFKID, out string revisionID) |
Query the associated item with a specified type. More... | |
unsafe void | GetPhysicsObjects (out NXOpen.NXObject[] objects) |
Gets behavioral physics objects. More... | |
unsafe string | GetSingleDesignation () |
Get the single designation including aspect, letter code and index. More... | |
unsafe void | RemoveComponent (NXOpen.Assemblies.Component[] comps) |
Removes Assemblies.Component . More... | |
unsafe void | RemoveOperation (NXOpen.NXObject[] opers) |
Removes operation object. More... | |
unsafe void | RemovePhysicsObjects (NXOpen.NXObject[] objects) |
Removes behavioral physics objects. More... | |
unsafe void | RemoveSignalAdapters (NXOpen.NXObject[] adapters) |
Removes signal adapter objects. More... | |
unsafe void | RemoveTraceLink (NXOpen.Mechatronics.SystemObject pComplying) |
Removes the trace link for system objects. More... | |
unsafe void | RenameInstance (string name) |
Renames system object instance. More... | |
unsafe void | ReorderObject (NXOpen.Mechatronics.SystemObject pDestination, NXOpen.Mechatronics.SystemObject.ReorderType beforeOrAfter) |
Reorders system objects. More... | |
unsafe void | RestructureObject (NXOpen.Mechatronics.SystemObject pDestination) |
Restructure system object. More... | |
unsafe void | SetSingleDesignation (string designation) |
Set the single designation including aspect, letter code and index. More... | |
Public Member Functions inherited from NXOpen.NXObject | |
unsafe NXOpen.AttributeIterator | CreateAttributeIterator () |
Create an attribute iterator 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 | 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 | 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.AttributeIterator iterator, NXOpen.Update.Option option) |
Deletes the attributes on the object, if any, that satisfy the given iterator 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 NXOpen.INXObject | FindObject (string journalIdentifier) |
Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type) |
Gets all the attribute titles of a specific type. More... | |
unsafe bool | GetBooleanUserAttribute (string title, int index) |
Gets a boolean 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 int | GetIntegerAttribute (string title) |
Gets an integer attribute by title. More... | |
unsafe int | GetIntegerUserAttribute (string title, int index) |
Gets an integer attribute by Title and array Index. 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 string | GetPdmReferenceAttributeValue (string attributeTitle) |
Gets the value of PDM Reference attribute for given object. More... | |
unsafe double | GetRealAttribute (string title) |
Gets a real attribute by title. More... | |
unsafe double | GetRealUserAttribute (string title, int index) |
Gets a real attribute by Title and array Index. 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 string | GetStringAttribute (string title) |
Gets a string attribute value by title. More... | |
unsafe string | GetStringUserAttribute (string title, int index) |
Gets a string attribute by Title and array Index. More... | |
unsafe string | GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title) |
Gets a time attribute by title. More... | |
unsafe string | GetTimeUserAttribute (string title, int index) |
Gets a time attribute by Title and array Index. 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 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 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 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 bool | GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type) |
Determine the lock of the given attribute. 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 NXOpen.NXObject.AttributeInformation[] | GetUserAttributes (bool includeUnset, bool addStringValues) |
Gets all the attributes of the given object. More... | |
unsafe string[] | GetUserAttributesAsStrings () |
Gets all the attributes that have been set on the given object. 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 NXOpen.NXObject[] | GetUserAttributeSourceObjects () |
Returns an array of objects from which this object presents attributes. 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 void | Print () |
Prints a representation of this object to the system log file. 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 | 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 void | SetName (string name) |
Sets the custom name of the object. More... | |
unsafe void | SetPdmReferenceAttribute (string attributeTitle, string attributeValue) |
Sets the value of PDM Reference attribute on the object. 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 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 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 | 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 | SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock) |
Lock or unlock the given attribute. More... | |
Public Member Functions inherited from NXOpen.TaggedObject | |
void | PrintTestData (String variableName) |
<exclude> More... | |
void | PrintTestData (String variableName, int lineNumber) |
<exclude> More... | |
override string | ToString () |
Returns a String that represents the current Object. More... | |
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject | |
IMessageCtrl | AsyncProcessMessage (IMessage msg, IMessageSink replySink) |
Asynchronously processes the given message. More... | |
IMessage | SyncProcessMessage (IMessage msg) |
Synchronously processes the given message. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from NXOpen.TaggedObject | |
new void | initialize () |
<exclude> 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... | |
Represents the System Object.
System Object is the entity displaying in System Navigator.
This is an abstract class and cannot be created.
Created in NX8.5.0
|
inline |
Adds Assemblies.Component .
Created in NX8.5.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
comps |
|
inline |
Adds operation object.
Created in NX8.5.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
opers |
|
inline |
Adds behavioral physics objects.
Created in NX9.0.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
objects |
|
inline |
Adds signal adapter objects.
Created in NX8.5.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
adapters |
|
inline |
Perform naming rule check and update the designation.
Created in NX10.0.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
|
inline |
Associate a specified item to this system object.
This method only makes sense in NX Manager mode.
Created in NX10.0.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
type | The relation type. |
itemMFKID | The item MFK ID of association item. |
revisionID | The revision ID of association item. |
|
inline |
Creates the trace link for system objects.
This method only makes sense in NX Manager mode.
Created in NX9.0.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
pComplying |
|
inline |
Dissociate a specified item from this system object.
This method only makes sense in NX Manager mode.
Created in NX10.0.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
itemMFKID | The item MFK ID of dissociation item. |
revisionID | The revision ID of dissociation item. |
|
inline |
Query the associated item with a specified type.
This method only makes sense in NX Manager mode.
Created in NX10.0.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
type | The relation type. |
itemMFKID | The item MFK ID of association item. |
revisionID | The revision ID of association item. |
|
inline |
Gets behavioral physics objects.
Created in NX9.0.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
objects |
|
inline |
Get the single designation including aspect, letter code and index.
Created in NX10.0.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
|
inline |
Removes Assemblies.Component .
Created in NX8.5.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
comps |
|
inline |
Removes operation object.
Created in NX8.5.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
opers |
|
inline |
Removes behavioral physics objects.
Created in NX9.0.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
objects |
|
inline |
Removes signal adapter objects.
Created in NX8.5.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
adapters |
|
inline |
Removes the trace link for system objects.
This method only makes sense in NX Manager mode.
Created in NX9.0.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
pComplying |
|
inline |
Renames system object instance.
Created in NX9.0.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
name |
|
inline |
Reorders system objects.
The method will reorder the objects in the same level of the structure. The source object will be moved to the destination and the sibling will update the order accordingly.
Created in NX9.0.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
pDestination | |
beforeOrAfter | Reorder Before/After |
|
inline |
Restructure system object.
Created in NX8.5.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
pDestination |
|
inline |
Set the single designation including aspect, letter code and index.
The aspect, letter code and index are joined together and comply with the rules defined in the configuration file.
Created in NX10.0.0
License requirements: nx_mcd_core ("Mechatronics Concept Designer")
designation |