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

Represents a base class that provides common methods for various model elements in a NXOpen.CollaborativeDesign . More...

Inheritance diagram for NXOpen.PDM.ModelElementRevision:
NXOpen.NXObject NXOpen.PDM.IAttributeGroupOwner NXOpen.INXObject NXOpen.PDM.DesignElementRevision NXOpen.PDM.DesignFeatureRevision NXOpen.PDM.DesignSubordinateRevision

Public Types

enum  PositioningStatus { AbsolutelyPositioned, OutOfDate, UpToDate, Unknown }
 Represents the positioning status of a design element 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
NXOpen.Assemblies.Partition[] 
GetMemberPartitions ()
 Get all the partitions of this model element revision. More...
 
unsafe NXOpen.Part GetOverridePart ()
 Get the override part of this model element revision if it has any. More...
 
unsafe bool IsExcludedFromSpatialSearch ()
 Determines whether this model element revision is excluded from spatial search. More...
 
unsafe void SetExcludeFromSpatialSearch (bool excludeFromSpatialSearch)
 Set or unset this model element revision from exclusion from spatial search. More...
 
unsafe
NXOpen.PDM.ModelElementRevision.PositioningStatus 
GetPositionStatus ()
 Gets positioning status of design element. More...
 
unsafe bool IsAbsolutelyPositioned ()
 Determine whether this design element is absolutely positioned or not. More...
 
unsafe
NXOpen.Assemblies.PositioningGroup[] 
GetPositioningGroups ()
 Gets all positioning group which are associated with this design element. More...
 
unsafe bool IsMemberOfPositioningGroup ()
 Determine whether this design element is part of positioning group or not. More...
 
unsafe NXOpen.PDM.AttributeGroup Create (NXOpen.PDM.AttributeGroupDescription attributeGroupDescription)
 Creates an attribute group for a NXOpen.PDM.IAttributeGroupOwner , based on an attribute group type. More...
 
unsafe
NXOpen.PDM.AttributeGroupReviseBuilder 
CreateAttributeGroupReviseBuilder (NXOpen.PDM.AttributeGroup[] attributeGroups)
 Creates a NXOpen.PDM.AttributeGroupReviseBuilder object. More...
 
unsafe NXOpen.PDM.AttributeGroup[] GetAttributeGroups ()
 Returns the NXOpen.PDM.AttributeGroup objects owned by this object. More...
 
unsafe
NXOpen.PDM.AttributeGroupDescription[] 
GetAttributeGroupDescriptions ()
 Returns the NXOpen.PDM.AttributeGroupDescription objects representing the attribute group types supported by this object. More...
 
unsafe
NXOpen.PDM.AttributeGroupReviseBuilder 
CreateAttributeGroupReviseBuilder (NXOpen.PDM.AttributeGroup[] attributeGroups, bool keepOriginal, NXOpen.PDM.AttributeGroupReviseBuilder.SaveAsActionType saveAsActionType)
 The builder will do a revise or save-as operation for each attribute group in the input list of existing attribute groups depending on input operation type. 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 string EffectivityFormula [get]
 Returns the formula string that represents the effectivity of this object in database. More...
 
unsafe NXOpen.CollaborativeDesign OwningCollaborativeDesign [get]
 Returns the owning NXOpen.CollaborativeDesign . 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 a base class that provides common methods for various model elements in a NXOpen.CollaborativeDesign .

Instance of this class can not be created

Created in NX9.0.0

Member Enumeration Documentation

Represents the positioning status of a design element

Enumerator
AbsolutelyPositioned 
OutOfDate 
UpToDate 
Unknown 

Member Function Documentation

unsafe NXOpen.PDM.AttributeGroup NXOpen.PDM.ModelElementRevision.Create ( NXOpen.PDM.AttributeGroupDescription  attributeGroupDescription)

Creates an attribute group for a NXOpen.PDM.IAttributeGroupOwner , based on an attribute group type.

An attribute group type is represented by an NXOpen.PDM.AttributeGroupDescription .

Created in NX9.0.0

License requirements: None.

Parameters
attributeGroupDescription
Returns
The new attribute group.

Implements NXOpen.PDM.IAttributeGroupOwner.

unsafe NXOpen.PDM.AttributeGroupReviseBuilder NXOpen.PDM.ModelElementRevision.CreateAttributeGroupReviseBuilder ( NXOpen.PDM.AttributeGroup[]  attributeGroups)

Creates a NXOpen.PDM.AttributeGroupReviseBuilder object.

The builder creates a revision for each attribute group in the input list of existing attribute groups.

Created in NX9.0.0

License requirements: None.

Parameters
attributeGroups
Returns

Implements NXOpen.PDM.IAttributeGroupOwner.

unsafe NXOpen.PDM.AttributeGroupReviseBuilder NXOpen.PDM.ModelElementRevision.CreateAttributeGroupReviseBuilder ( NXOpen.PDM.AttributeGroup[]  attributeGroups,
bool  keepOriginal,
NXOpen.PDM.AttributeGroupReviseBuilder.SaveAsActionType  saveAsActionType 
)

The builder will do a revise or save-as operation for each attribute group in the input list of existing attribute groups depending on input operation type.

Created in NX11.0.0

License requirements: None.

Parameters
attributeGroups
keepOriginal
saveAsActionType
Returns

Implements NXOpen.PDM.IAttributeGroupOwner.

unsafe NXOpen.PDM.AttributeGroupDescription [] NXOpen.PDM.ModelElementRevision.GetAttributeGroupDescriptions ( )

Returns the NXOpen.PDM.AttributeGroupDescription objects representing the attribute group types supported by this object.

Created in NX9.0.0

License requirements: None.

Returns

Implements NXOpen.PDM.IAttributeGroupOwner.

unsafe NXOpen.PDM.AttributeGroup [] NXOpen.PDM.ModelElementRevision.GetAttributeGroups ( )

Returns the NXOpen.PDM.AttributeGroup objects owned by this object.

Created in NX9.0.0

License requirements: None.

Returns

Implements NXOpen.PDM.IAttributeGroupOwner.

unsafe NXOpen.Assemblies.Partition [] NXOpen.PDM.ModelElementRevision.GetMemberPartitions ( )

Get all the partitions of this model element revision.

Created in NX9.0.0

License requirements: None.

Returns
unsafe NXOpen.Part NXOpen.PDM.ModelElementRevision.GetOverridePart ( )

Get the override part of this model element revision if it has any.

Created in NX10.0.0

License requirements: None.

Returns
unsafe NXOpen.Assemblies.PositioningGroup [] NXOpen.PDM.ModelElementRevision.GetPositioningGroups ( )

Gets all positioning group which are associated with this design element.

Created in NX10.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

Returns
unsafe NXOpen.PDM.ModelElementRevision.PositioningStatus NXOpen.PDM.ModelElementRevision.GetPositionStatus ( )

Gets positioning status of design element.

It returns absolute position if design element is absolutely positioned, up-to-date if design element is in work collection of positioning task, out-of-date if design element is in context collection of positioning task and unknown if design element is not in any of the above. Return status will be one of NXOpen.PDM.ModelElementRevision.PositioningStatus .

Created in NX10.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

Returns
unsafe bool NXOpen.PDM.ModelElementRevision.IsAbsolutelyPositioned ( )

Determine whether this design element is absolutely positioned or not.

Created in NX10.0.0

License requirements: None.

Returns
unsafe bool NXOpen.PDM.ModelElementRevision.IsExcludedFromSpatialSearch ( )

Determines whether this model element revision is excluded from spatial search.

Created in NX10.0.0

License requirements: None.

Returns
unsafe bool NXOpen.PDM.ModelElementRevision.IsMemberOfPositioningGroup ( )

Determine whether this design element is part of positioning group or not.

Created in NX10.0.0

License requirements: None.

Returns
unsafe void NXOpen.PDM.ModelElementRevision.SetExcludeFromSpatialSearch ( bool  excludeFromSpatialSearch)

Set or unset this model element revision from exclusion from spatial search.

Created in NX10.0.0

License requirements: None.

Parameters
excludeFromSpatialSearch

Property Documentation

unsafe string NXOpen.PDM.ModelElementRevision.EffectivityFormula
get

Returns the formula string that represents the effectivity of this object in database.

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.CollaborativeDesign NXOpen.PDM.ModelElementRevision.OwningCollaborativeDesign
get

Returns the owning NXOpen.CollaborativeDesign .

Created in NX9.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.