NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Properties | List of all members
NXOpen.ShipDesign.NavigatorNode Class Reference

Represents the interface for navigator view classes More...

Inheritance diagram for NXOpen.ShipDesign.NavigatorNode:
NXOpen.NXObject NXOpen.TaggedObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe
NXOpen.ShipDesign.NavigatorNode 
AddChild (string name, NXOpen.TaggedObject[] nodeObjects, bool createPersistentData)
 Adds a child node. More...
 
unsafe
NXOpen.ShipDesign.NavigatorNode[] 
GetChildren ()
 Gets children nodes. More...
 
unsafe
NXOpen.ShipDesign.NavigatorNode 
GetNextNode ()
 Get next node. More...
 
unsafe
NXOpen.ShipDesign.NavigatorNode 
GetNextSiblingNode ()
 Gets next sibling node. More...
 
unsafe NXOpen.TaggedObject[] GetNodeObjects ()
 Gets the objects represented by the node. More...
 
unsafe
NXOpen.ShipDesign.NavigatorNode 
GetParent ()
 Gets parent node. More...
 
unsafe
NXOpen.ShipDesign.NavigatorNode 
GetPreviousNode ()
 Get previous node. More...
 
unsafe
NXOpen.ShipDesign.NavigatorNode 
GetPreviousSiblingNode ()
 Gets previous sibling node. More...
 
unsafe string GetProperty (string propertyName)
 Gets the node property. More...
 
unsafe void RemoveChild (NXOpen.ShipDesign.NavigatorNode childNode)
 Removes a child node. More...
 
unsafe void SetDraggable (bool draggable)
 Sets the node draggable attribute. More...
 
unsafe void SetIcon (string icon)
 Sets the node icon. More...
 
unsafe void SetNodeObjects (NXOpen.TaggedObject[] nodeObjects)
 Sets the objects represented by the node. More...
 
unsafe void UpdateProperty (string propertyName, string propertyValue)
 Sets the node property. 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...
 

Properties

unsafe bool CheckStatus [get, set]
 Returns or sets the node check status. More...
 
unsafe bool Modifiable [get, set]
 Returns or sets the node modifiable property. More...
 
unsafe string Title [get, set]
 Returns or sets the node title. 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.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. 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...
 
- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents the interface for navigator view classes

Use the NXOpen.ShipDesign.NavigatorView class to create a navigator node

Created in NX11.0.1

Member Function Documentation

unsafe NXOpen.ShipDesign.NavigatorNode NXOpen.ShipDesign.NavigatorNode.AddChild ( string  name,
NXOpen.TaggedObject[]  nodeObjects,
bool  createPersistentData 
)
inline

Adds a child node.

Created in NX11.0.1

License requirements: nx_ship_basic ("Ship Basic Design")

Parameters
name
nodeObjects
createPersistentData
Returns
unsafe NXOpen.ShipDesign.NavigatorNode [] NXOpen.ShipDesign.NavigatorNode.GetChildren ( )
inline

Gets children nodes.

Created in NX11.0.1

License requirements: nx_ship_basic ("Ship Basic Design")

Returns
unsafe NXOpen.ShipDesign.NavigatorNode NXOpen.ShipDesign.NavigatorNode.GetNextNode ( )
inline

Get next node.

If this node has some child nodes, the next node is the first child. Otherwise return next sibling of this node, or its parent node, or its grandparent node...

Created in NX11.0.1

License requirements: nx_ship_basic ("Ship Basic Design")

Returns
unsafe NXOpen.ShipDesign.NavigatorNode NXOpen.ShipDesign.NavigatorNode.GetNextSiblingNode ( )
inline

Gets next sibling node.

Created in NX11.0.1

License requirements: nx_ship_basic ("Ship Basic Design")

Returns
unsafe NXOpen.TaggedObject [] NXOpen.ShipDesign.NavigatorNode.GetNodeObjects ( )
inline

Gets the objects represented by the node.

Created in NX11.0.1

License requirements: nx_ship_basic ("Ship Basic Design")

Returns
unsafe NXOpen.ShipDesign.NavigatorNode NXOpen.ShipDesign.NavigatorNode.GetParent ( )
inline

Gets parent node.

Created in NX11.0.1

License requirements: nx_ship_basic ("Ship Basic Design")

Returns
unsafe NXOpen.ShipDesign.NavigatorNode NXOpen.ShipDesign.NavigatorNode.GetPreviousNode ( )
inline

Get previous node.

If this node has no prior siblings, the previous node is its parent node if it has. If this node has a prior sibling, the previous node is the last descendant node of this previous sibling.

Created in NX11.0.1

License requirements: nx_ship_basic ("Ship Basic Design")

Returns
unsafe NXOpen.ShipDesign.NavigatorNode NXOpen.ShipDesign.NavigatorNode.GetPreviousSiblingNode ( )
inline

Gets previous sibling node.

Created in NX11.0.1

License requirements: nx_ship_basic ("Ship Basic Design")

Returns
unsafe string NXOpen.ShipDesign.NavigatorNode.GetProperty ( string  propertyName)
inline

Gets the node property.

Created in NX11.0.1

License requirements: nx_ship_basic ("Ship Basic Design")

Parameters
propertyName
Returns
unsafe void NXOpen.ShipDesign.NavigatorNode.RemoveChild ( NXOpen.ShipDesign.NavigatorNode  childNode)
inline

Removes a child node.

Created in NX11.0.1

License requirements: nx_ship_basic ("Ship Basic Design")

Parameters
childNode
unsafe void NXOpen.ShipDesign.NavigatorNode.SetDraggable ( bool  draggable)
inline

Sets the node draggable attribute.

Created in NX11.0.1

License requirements: nx_ship_basic ("Ship Basic Design")

Parameters
draggable
unsafe void NXOpen.ShipDesign.NavigatorNode.SetIcon ( string  icon)
inline

Sets the node icon.

Created in NX11.0.1

License requirements: nx_ship_basic ("Ship Basic Design")

Parameters
icon
unsafe void NXOpen.ShipDesign.NavigatorNode.SetNodeObjects ( NXOpen.TaggedObject[]  nodeObjects)
inline

Sets the objects represented by the node.

Created in NX11.0.1

License requirements: nx_ship_basic ("Ship Basic Design")

Parameters
nodeObjects
unsafe void NXOpen.ShipDesign.NavigatorNode.UpdateProperty ( string  propertyName,
string  propertyValue 
)
inline

Sets the node property.

Created in NX11.0.1

License requirements: nx_ship_basic ("Ship Basic Design")

Parameters
propertyName
propertyValue

Property Documentation

unsafe bool NXOpen.ShipDesign.NavigatorNode.CheckStatus
getset

Returns or sets the node check status.

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design")

unsafe bool NXOpen.ShipDesign.NavigatorNode.Modifiable
getset

Returns or sets the node modifiable property.

Created in NX11.0.2

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design")

unsafe string NXOpen.ShipDesign.NavigatorNode.Title
getset

Returns or sets the node title.

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design")


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