NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.CAE.FEModelOccAttribute Class Reference

This class represents an Interface to the Finite Element Model Attributes. More...

Inheritance diagram for NXOpen.CAE.FEModelOccAttribute:
NXOpen.NXObject NXOpen.TaggedObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink NXOpen.CAE.ModifiableFEModelOccAttribute

Public Types

enum  AltRepDisplayStyle { None, Approx, Symbol, Simplified }
 Represents the display style when in alt rep More...
 
enum  AltRepLengthUnitType {
  Km = 1, M, Cm, Mm,
  Micron, Nm, An, Mi,
  Ft, Inch
}
 Represents the length units types when in alt rep More...
 
enum  AltRepMassUnitType {
  G = 1, Kg, Mg, T,
  Lbm, Slug, Inchlbfsec2In, Mmkgfsec2M,
  Kgfsec2Cm, Kgfsec2Mm
}
 Represents the mass units types when in alt rep More...
 
enum  RepType { BaseFem, SuperElement }
 Represents the FemOcc representation type 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.NXColor GetAltRepDisplayColor ()
 Get the alternate representation display color More...
 
unsafe
NXOpen.DisplayableObject.ObjectFont 
GetAltRepDisplayFont ()
 Get the alternate representation display font More...
 
unsafe
NXOpen.CAE.FEModelOccAttribute.AltRepDisplayStyle 
GetAltRepDisplayStyle ()
 Get the alternate representation display style More...
 
unsafe int GetAltRepDisplayTranslucency ()
 Get the alternate representation display translucency More...
 
unsafe
NXOpen.DisplayableObject.ObjectWidth 
GetAltRepDisplayWidth ()
 Get the alternate representation display width More...
 
unsafe int GetLabel ()
 Get the super element ID More...
 
unsafe
NXOpen.CAE.FEModelOccAttribute.RepType 
GetRepType ()
 Get the representation type on the attribute (base_fem or super element) More...
 
unsafe string GetSuperElementFile ()
 Get the super element file name More...
 
unsafe void SetAltRepDisplayColor (NXOpen.NXColor color)
 Set the alternate representation display color More...
 
unsafe void SetAltRepDisplayFont (NXOpen.DisplayableObject.ObjectFont lineFont)
 Set the alternate representation display font More...
 
unsafe void SetAltRepDisplayStyle (NXOpen.CAE.FEModelOccAttribute.AltRepDisplayStyle dispStyle)
 Set the alternate representation display style More...
 
unsafe void SetAltRepDisplayTranslucency (int translucency)
 Set the alternate representation display translucency More...
 
unsafe void SetAltRepDisplayWidth (NXOpen.DisplayableObject.ObjectWidth width)
 Set the alternate representation display width 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 NXOpen.CAE.PropertyTable AltRepPropertyTable [get]
 Returns the property table associated with the alternate rep 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

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

This class represents an Interface to the Finite Element Model Attributes.

Created in NX8.0.0

Member Enumeration Documentation

Represents the display style when in alt rep

Enumerator
None 

No graphics when in alt rep

Approx 

Display approximation of base fem when in alt rep

Symbol 

Display alternate rep symbol when when in alt rep

Simplified 

Display simplified graphic defined by superelement file

Represents the length units types when in alt rep

Enumerator
Km 

Length unit of kilometer

M 

Length unit of meter

Cm 

Length unit of centimeter

Mm 

Length unit of millimeter

Micron 

Length unit of micrometer

Nm 

Length unit of nanometer

An 

Length unit of angstrom

Mi 

Length unit of miles

Ft 

Length unit of foot

Inch 

Length unit of inch

Represents the mass units types when in alt rep

Enumerator
G 

Mass unit of gram

Kg 

Mass unit of kilogram

Mg 

Mass unit of megagram

T 

Mass unit of tonnes

Lbm 

Mass unit of pound-mass

Slug 

Mass unit of slug or (LBF-SEC^2)/FT

Inchlbfsec2In 

Mass unit of (LBF-SEC^2)/IN

Mmkgfsec2M 

Mass unit of (KGF-SEC^2)/M

Kgfsec2Cm 

Mass unit of (KGF-SEC^2)/CM

Kgfsec2Mm 

Mass unit of (KGF-SEC^2)/MM

Represents the FemOcc representation type

Enumerator
BaseFem 

No alternate rep.

Use prototype FEM as representation

SuperElement 

Alternate rep is a superelement

Member Function Documentation

unsafe NXOpen.NXColor NXOpen.CAE.FEModelOccAttribute.GetAltRepDisplayColor ( )
inline

Get the alternate representation display color

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Returns
unsafe NXOpen.DisplayableObject.ObjectFont NXOpen.CAE.FEModelOccAttribute.GetAltRepDisplayFont ( )
inline

Get the alternate representation display font

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Returns
unsafe NXOpen.CAE.FEModelOccAttribute.AltRepDisplayStyle NXOpen.CAE.FEModelOccAttribute.GetAltRepDisplayStyle ( )
inline

Get the alternate representation display style

Created in NX8.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Returns
unsafe int NXOpen.CAE.FEModelOccAttribute.GetAltRepDisplayTranslucency ( )
inline

Get the alternate representation display translucency

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Returns
unsafe NXOpen.DisplayableObject.ObjectWidth NXOpen.CAE.FEModelOccAttribute.GetAltRepDisplayWidth ( )
inline

Get the alternate representation display width

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Returns
unsafe int NXOpen.CAE.FEModelOccAttribute.GetLabel ( )
inline

Get the super element ID

Created in NX8.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Returns
unsafe NXOpen.CAE.FEModelOccAttribute.RepType NXOpen.CAE.FEModelOccAttribute.GetRepType ( )
inline

Get the representation type on the attribute (base_fem or super element)

Created in NX8.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Returns
unsafe string NXOpen.CAE.FEModelOccAttribute.GetSuperElementFile ( )
inline

Get the super element file name

Created in NX8.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Returns
unsafe void NXOpen.CAE.FEModelOccAttribute.SetAltRepDisplayColor ( NXOpen.NXColor  color)
inline

Set the alternate representation display color

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
color
unsafe void NXOpen.CAE.FEModelOccAttribute.SetAltRepDisplayFont ( NXOpen.DisplayableObject.ObjectFont  lineFont)
inline

Set the alternate representation display font

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
lineFont
unsafe void NXOpen.CAE.FEModelOccAttribute.SetAltRepDisplayStyle ( NXOpen.CAE.FEModelOccAttribute.AltRepDisplayStyle  dispStyle)
inline

Set the alternate representation display style

Created in NX8.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
dispStyle
unsafe void NXOpen.CAE.FEModelOccAttribute.SetAltRepDisplayTranslucency ( int  translucency)
inline

Set the alternate representation display translucency

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
translucency
unsafe void NXOpen.CAE.FEModelOccAttribute.SetAltRepDisplayWidth ( NXOpen.DisplayableObject.ObjectWidth  width)
inline

Set the alternate representation display width

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
width

Property Documentation

unsafe NXOpen.CAE.PropertyTable NXOpen.CAE.FEModelOccAttribute.AltRepPropertyTable
get

Returns the property table associated with the alternate rep

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")


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