NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.AutomaticTraceline Class Reference

Represents an automatic traceline. More...

Inheritance diagram for NXOpen.AutomaticTraceline:
NXOpen.Traceline NXOpen.DisplayableObject NXOpen.NXObject NXOpen.IFitTo NXOpen.INXObject NXOpen.INXObject

Public Types

enum  ModeOption { Evaluate, Orientation, Infer }
 Controls the mode used when evaluating an automatic traceline More...
 

Public Member Functions

unsafe void GetSegmentConstraints (out int[] segmentIndices, out double[] segmentLengths)
 Gets the segment constraints of the traceline More...
 
unsafe void SetSegmentConstraints (int[] segmentIndices, double[] segmentLengths)
 Sets the segment constraints of the traceline More...
 
unsafe void RemoveSegmentConstraint (int segmentIndex)
 Removes the segment constraint from the traceline More...
 
- Public Member Functions inherited from NXOpen.Traceline
unsafe NXOpen.Curve AskShape ()
 Returns the object used to represent the shape of the traceline More...
 
unsafe NXOpen.Assemblies.Explosion AskExplosion ()
 Returns the explosion that the traceline has been created in More...
 
- Public Member Functions inherited from NXOpen.DisplayableObject
unsafe void Blank ()
 Blanks the object. More...
 
unsafe void Unblank ()
 Unblanks the object. More...
 
unsafe void Highlight ()
 Highlights the object. More...
 
unsafe void Unhighlight ()
 Unhighlights the object. More...
 
unsafe void SetNameLocation (NXOpen.Point3d location)
 Sets the location of the object's name. More...
 
unsafe void RedisplayObject ()
 Redisplays the object in all views. More...
 
unsafe void RemoveViewDependency ()
 Remove dependency on all views from an object. 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.Direction EndDirection [get, set]
 Returns or sets the end direction of the traceline More...
 
unsafe double EndOffset [get, set]
 Returns or sets the end offset of the traceline More...
 
unsafe NXOpen.Point EndPoint [get, set]
 Returns or sets the end point of the traceline More...
 
unsafe
NXOpen.AutomaticTraceline.ModeOption 
Mode [get, set]
 Returns or sets the mode of the traceline More...
 
unsafe NXOpen.Matrix3x3 Orientation [get, set]
 Returns or sets the orientation of the traceline More...
 
unsafe int Solution [get, set]
 Returns or sets the solution used in the traceline More...
 
unsafe NXOpen.Direction StartDirection [get, set]
 Returns or sets the start direction of the traceline More...
 
unsafe double StartOffset [get, set]
 Returns or sets the start offset of the traceline More...
 
unsafe NXOpen.Point StartPoint [get, set]
 Returns or sets the start point of the traceline More...
 

Detailed Description

Represents an automatic traceline.

This type of traceline has its shape automatically derived from its defining properties.

No creator defined due to apiwrap problems

Created in NX4.0.0

Member Enumeration Documentation

Controls the mode used when evaluating an automatic traceline

Enumerator
Evaluate 

Evaluate which mode to use

Orientation 

Align with orientation

Infer 

Infer orientation from start and end directions

Member Function Documentation

unsafe void NXOpen.AutomaticTraceline.GetSegmentConstraints ( out int[]  segmentIndices,
out double[]  segmentLengths 
)

Gets the segment constraints of the traceline

Created in NX4.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters
segmentIndicesSegment indices
segmentLengthsSegment lengths
unsafe void NXOpen.AutomaticTraceline.RemoveSegmentConstraint ( int  segmentIndex)

Removes the segment constraint from the traceline

Created in NX4.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters
segmentIndexSegment index
unsafe void NXOpen.AutomaticTraceline.SetSegmentConstraints ( int[]  segmentIndices,
double[]  segmentLengths 
)

Sets the segment constraints of the traceline

Created in NX4.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters
segmentIndicesSegment indices
segmentLengthsSegment lengths

Property Documentation

unsafe NXOpen.Direction NXOpen.AutomaticTraceline.EndDirection
getset

Returns or sets the end direction of the traceline

Created in NX4.0.0

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

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

unsafe double NXOpen.AutomaticTraceline.EndOffset
getset

Returns or sets the end offset of the traceline

Created in NX4.0.0

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

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

unsafe NXOpen.Point NXOpen.AutomaticTraceline.EndPoint
getset

Returns or sets the end point of the traceline

Created in NX4.0.0

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

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

unsafe NXOpen.AutomaticTraceline.ModeOption NXOpen.AutomaticTraceline.Mode
getset

Returns or sets the mode of the traceline

Created in NX4.0.0

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

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

unsafe NXOpen.Matrix3x3 NXOpen.AutomaticTraceline.Orientation
getset

Returns or sets the orientation of the traceline

Created in NX4.0.0

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

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

unsafe int NXOpen.AutomaticTraceline.Solution
getset

Returns or sets the solution used in the traceline

Created in NX4.0.0

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

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

unsafe NXOpen.Direction NXOpen.AutomaticTraceline.StartDirection
getset

Returns or sets the start direction of the traceline

Created in NX4.0.0

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

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

unsafe double NXOpen.AutomaticTraceline.StartOffset
getset

Returns or sets the start offset of the traceline

Created in NX4.0.0

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

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

unsafe NXOpen.Point NXOpen.AutomaticTraceline.StartPoint
getset

Returns or sets the start point of the traceline

Created in NX4.0.0

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

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


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