NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions
NXOpen::NXObject Class Reference

A base class providing low-level services for most NXOpen classes. More...

Inheritance diagram for NXOpen::NXObject:
NXOpen::TaggedObject NXOpen::INXObject NXOpen::Annotations::BusinessModifier NXOpen::Annotations::MasterSymbol NXOpen::Annotations::OrdinateMargin NXOpen::Annotations::PartSymbolFolder NXOpen::Annotations::Pmi NXOpen::Annotations::PmiAttributeValue NXOpen::Annotations::PmiFilter NXOpen::Annotations::SymbolFile NXOpen::Assemblies::Arrangement NXOpen::Assemblies::Assembly NXOpen::Assemblies::ComponentAssembly NXOpen::Assemblies::ComponentGroup NXOpen::Assemblies::Explosion NXOpen::Assemblies::ProductInterface::InterfaceObject NXOpen::BasePart NXOpen::CAE::AutoPairs NXOpen::CAE::BeamSection NXOpen::CAE::Bolt NXOpen::CAE::CaeGroup NXOpen::CAE::CorrelSolution NXOpen::CAE::DependentMeshListItemBuilder NXOpen::CAE::DurabilityEvent NXOpen::CAE::DurabilityExcitation NXOpen::CAE::DurabilityMetaSolution NXOpen::CAE::FEModelOccAttribute NXOpen::CAE::FTK::BaseRecord NXOpen::CAE::FTK::BaseUnit NXOpen::CAE::Function NXOpen::CAE::IFEModel NXOpen::CAE::IMeshCollector NXOpen::CAE::LaminateDrapingData NXOpen::CAE::LaminateDrapingOrientation NXOpen::CAE::LaminateExtrudeSetup NXOpen::CAE::LaminateFiberOrientationOptions NXOpen::CAE::LaminateGlobalLayup NXOpen::CAE::LaminateGraphicalReport NXOpen::CAE::LaminateLayupOffset NXOpen::CAE::LaminateMatOrientation NXOpen::CAE::LaminatePly NXOpen::CAE::LaminatePlyGroup NXOpen::CAE::LaminatePostReport NXOpen::CAE::LaminateQuickPostReport NXOpen::CAE::LaminateQuickReport NXOpen::CAE::LaminateSpreadsheetReport NXOpen::CAE::ManualSweepBetweenListItemSelection NXOpen::CAE::ModelUpdateDesignVariable NXOpen::CAE::NamedPropertyTable NXOpen::CAE::Optimization::DAOConstraint NXOpen::CAE::Optimization::DAODesignVariable NXOpen::CAE::Optimization::DAOObjective NXOpen::CAE::Optimization::DAOSolution NXOpen::CAE::Optimization::DAOStopCondition NXOpen::CAE::Optimization::TBSConstraint NXOpen::CAE::Optimization::TBSDesignArea NXOpen::CAE::Optimization::TBSDesignVariable NXOpen::CAE::Optimization::TBSOptimizationSolution NXOpen::CAE::Optimization::TBSRestrictArea NXOpen::CAE::Optimization::TBSSmooth NXOpen::CAE::PreTestDofSet NXOpen::CAE::PreTestExciterConfig NXOpen::CAE::PreTestSensorConfig NXOpen::CAE::PreTestSolution NXOpen::CAE::PropertyTable NXOpen::CAE::ResponseSimulation::EvaluationSetting NXOpen::CAE::ResponseSimulation::Excitation NXOpen::CAE::ResponseSimulation::InitialConditions NXOpen::CAE::ResponseSimulation::ModalProperties NXOpen::CAE::ResponseSimulation::ModeInitialData NXOpen::CAE::ResponseSimulation::NormalMode NXOpen::CAE::ResponseSimulation::RSDisplayObject NXOpen::CAE::ResponseSimulation::RSEvent NXOpen::CAE::ResponseSimulation::Solution NXOpen::CAE::Result NXOpen::CAE::SetManager NXOpen::CAE::SimBCBuilder NXOpen::CAE::SimGroupContainer NXOpen::CAE::SimRecipe NXOpen::CAE::SimSimulation NXOpen::CAE::SketchCurves NXOpen::CAE::SolverAppendOption NXOpen::CAE::Xyplot::BaseTemplate NXOpen::CAE::Xyplot::BaseTemplateManager NXOpen::CAE::Xyplot::Plot NXOpen::CAM::CAMAttribute NXOpen::CAM::CAMFeature NXOpen::CAM::CAMObject NXOpen::CAM::InPathEventDataBuilder NXOpen::CAM::TabPointDataBuilder NXOpen::Decal NXOpen::Die::DieAssistantFlangeProfile NXOpen::Die::DieAssistantTrimProfile NXOpen::Die::PierceItemBuilder NXOpen::Display::Camera NXOpen::Display::DynamicSection NXOpen::Display::TrueShading NXOpen::Display::TrueStudio NXOpen::DisplayableObject NXOpen::Drawings::BordersAndZones NXOpen::Drawings::DrawingSheet NXOpen::Drawings::RenderSet NXOpen::Drawings::ViewBreak NXOpen::Expression NXOpen::ExpressionCollectorSet NXOpen::ExpressionSectionSet NXOpen::ExpressionSet NXOpen::Features::Feature NXOpen::Features::GlobalShapingPointOffsetBuilder NXOpen::Features::PointSetFacePercentageBuilder NXOpen::Features::SectionEdit NXOpen::Features::SheetMetal::FlexibleCableSegment NXOpen::Features::ShipDesign::BulkHeadListItemBuilder NXOpen::Features::ShipDesign::DeckListItemBuilder NXOpen::Features::ShipDesign::ItFrameListItemBuilder NXOpen::Features::ShipDesign::PenetrationAttachment NXOpen::Features::ShipDesign::PenetrationFolder NXOpen::Features::ShipDesign::PenetrationList NXOpen::Features::ShipDesign::PenetrationRequest NXOpen::Features::ShipDesign::PenetrationSite NXOpen::Features::ShipDesign::PlanePairBuilder NXOpen::Features::ShipDesign::PointPairBuilder NXOpen::Features::ShipDesign::TransFrameListItemBuilder NXOpen::Fields::FieldDomain NXOpen::Fields::FieldManager NXOpen::Fields::FieldVariable NXOpen::Fields::FieldWrapper NXOpen::Fields::NameVariable NXOpen::Fields::ScalarFieldWrapper NXOpen::Fields::SpatialMap NXOpen::Fields::VectorFieldWrapper NXOpen::GeometricUtilities::FaceSetData NXOpen::GeometricUtilities::SecondarySectionData NXOpen::GeometricUtilities::SelectionList NXOpen::GeometricUtilities::StyledSweepDoubleOnPathDimBuilder NXOpen::GeometricUtilities::WaveLinkRepository NXOpen::Layer::Category NXOpen::Layout NXOpen::Light NXOpen::Material NXOpen::Mechatronics::CollisionMaterial NXOpen::Mechatronics::ExternalConnectionElement NXOpen::Mechatronics::FunctionObject NXOpen::Mechatronics::GanttOperationObject NXOpen::Mechatronics::MotionProfile NXOpen::Mechatronics::RuntimeBehavior NXOpen::Motion::BodyContactAdams NXOpen::Motion::BodyContactRecurdyn NXOpen::Motion::CurveContactAdams NXOpen::Motion::CurveContactRecurdyn NXOpen::Motion::JointDriver NXOpen::Motion::MotionSolution NXOpen::Motion::NormalModeProperty NXOpen::Motion::Packaging NXOpen::Motion::PlantInput NXOpen::Motion::PlantOutput NXOpen::Motion::SignalChart NXOpen::Motion::VectorForce NXOpen::Motion::VectorTorque NXOpen::NXMatrix NXOpen::PDM::PartCreationObject NXOpen::PlotColorsWidthsBuilder NXOpen::PlotSourceBuilder NXOpen::Positioning::ComponentConstraintGroup NXOpen::Positioning::Constraint NXOpen::Positioning::ConstraintReference NXOpen::Positioning::Network NXOpen::Positioning::Positioner NXOpen::PositioningDimension NXOpen::Preferences::WorkPlane NXOpen::RegionPoint NXOpen::Routing::BuiltInPath NXOpen::Routing::Corner NXOpen::Routing::CrossSection NXOpen::Routing::DesignRule NXOpen::Routing::DesignRuleOverride NXOpen::Routing::DesignRuleViolation NXOpen::Routing::DesignRuleViolationLocation NXOpen::Routing::Division NXOpen::Routing::Electrical::CablewaysLayoutView NXOpen::Routing::FittingOverstock NXOpen::Routing::OffsetPath NXOpen::Routing::OverstockApplication NXOpen::Routing::Path NXOpen::Routing::PortConnection NXOpen::Routing::RootObject NXOpen::Routing::RouteLogicalAssociation NXOpen::Routing::RoutingSystem NXOpen::Routing::Run NXOpen::Routing::SBendCorner NXOpen::Routing::Stock NXOpen::Routing::StockData NXOpen::Routing::Wire NXOpen::SIM::KinematicAxis NXOpen::SIM::KinematicComponent NXOpen::SIM::KinematicConfigurator NXOpen::SIM::KinematicJunction NXOpen::SketchConstraint NXOpen::SketchPolygon NXOpen::SymbolFont NXOpen::Unit NXOpen::Validate::ResultObject NXOpen::Validation NXOpen::View NXOpen::VisualReporting::Classifier NXOpen::VisualReporting::Condition NXOpen::VisualReporting::GroupLabel NXOpen::VisualReporting::Property NXOpen::VisualReporting::ResultCategory NXOpen::VisualReporting::Rule NXOpen::VisualReporting::UnmatchedResultCategory NXOpen::VisualReporting::VisualReport NXOpen::Weld::CharacteristicsSelectionBuilder NXOpen::Weld::CharacteristicsValueBuilder

List of all members.

Classes

struct  AttributeInformation
 Contains attribute information. More...

Public Types

enum  AttributeType {
  AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger,
  AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference,
  AttributeTypeAny = 100
}
 Specifies attribute type. More...
enum  DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
 Specifies the format of the date and time attribute. More...

Public Member Functions

void DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
 Deletes all attributes of a specific type.
void DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
 Deletes all attributes of a specific type with the option to update or not.
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
 Deletes an attribute by type and title.
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
 Deletes an attribute by type and title with the option to update or not.
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
 Deletes the first attribute encountered with the given Type, Title and Index.
void DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
 Deletes the attributes encountered with the given Type with option to update or not.
virtual NXOpen::INXObjectFindObject (const NXString &journalIdentifier)
 Finds the NXObject with the given identifier as recorded in a journal.
std::vector
< NXOpen::NXObject::AttributeInformation
GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
 Gets all the attribute titles of a specific type.
bool GetBooleanUserAttribute (const NXString &title, int index)
 Gets a boolean attribute by Title and array Index.
int GetIntegerAttribute (const NXString &title)
 Gets an integer attribute by title.
int GetIntegerUserAttribute (const NXString &title, int index)
 Gets an integer attribute by Title and array Index.
double GetRealAttribute (const NXString &title)
 Gets a real attribute by title.
double GetRealUserAttribute (const NXString &title, int index)
 Gets a real attribute by Title and array Index.
NXString GetReferenceAttribute (const NXString &title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
NXString GetStringAttribute (const NXString &title)
 Gets a string attribute value by title.
NXString GetStringUserAttribute (const NXString &title, int index)
 Gets a string attribute by Title and array Index.
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
 Gets a time attribute by title.
NXString GetTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index.
NXOpen::NXObject::AttributeInformation GetUserAttribute (const NXString &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.
NXString GetUserAttributeAsString (const NXString &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.
bool GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute.
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes ()
 Gets all the attributes that have been set on the given object.
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (bool includeUnset)
 Gets all the attributes that have been set on the given object, as well as information from attribute templates that have not been set (if 'IncludeUnset' is 'true').
std::vector< NXStringGetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object.
bool HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).
virtual bool IsOccurrence ()
 Returns whether this object is an occurrence or not.
virtual NXString JournalIdentifier ()
 Returns the identifier that would be recorded in a journal for this object.
virtual NXString Name ()
 Returns the custom name of the object.
virtual
NXOpen::Assemblies::Component
OwningComponent ()
 Returns the owning component, if this object is an occurrence.
virtual NXOpen::BasePartOwningPart ()
 Returns the owning part of this object
Created in NX3.0.0.
virtual void Print ()
 Prints a representation of this object to the system log file.
virtual NXOpen::INXObjectPrototype ()
 Returns the prototype of this object if it is an occurrence.
void SetAttribute (const NXString &title, int value)
 Creates or modifies an integer attribute.
void SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not.
void SetAttribute (const NXString &title, double value)
 Creates or modifies a real attribute.
void SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not.
void SetAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute.
void SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not.
void SetAttribute (const NXString &title)
 Creates or modifies a null attribute which is an attribute with a title and no value.
void SetAttribute (const NXString &title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not.
void SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
 Creates or modifies a boolean attribute with the option to update or not.
virtual void SetName (const NXString &name)
 Sets the custom name of the object.
void SetReferenceAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute which uses a reference string.
void SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not.
void SetTimeAttribute (const NXString &title, const NXString &value)
 Creates or modifies a time attribute.
void SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not.
void SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not.
void SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
 Creates or modifies an attribute with the option to update or not.
void SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not.
void SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not.
void SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not.
void SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not.
void SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute.

Detailed Description

A base class providing low-level services for most NXOpen classes.


For more information on NX rules for Names and Attributes, see the Properties section of the Gateway Help.

This is an abstract class, and cannot be instantiated.

Created in NX3.0.0.


Member Enumeration Documentation

Specifies attribute type.

NOTE: Attributes of type reference are also string attributes. The reference type as such is deprecated.

Enumerator:
AttributeTypeInvalid 

Invalid.

AttributeTypeNull 

Null.

AttributeTypeBoolean 

Boolean.

AttributeTypeInteger 

Integer.

AttributeTypeReal 

Real.

AttributeTypeString 

String.

AttributeTypeTime 

Time and Date.

AttributeTypeReference 

Deprecated.

Do not use in new code. Previously used to denote string attributes holding a ReferenceValue

Specifies the format of the date and time attribute.

Enumerator:
DateAndTimeFormatNumeric 

2004/04/28 22:06:15

DateAndTimeFormatTextual 

28-Apr-2004 22:06:15


Member Function Documentation

Deletes all attributes of a specific type.

This method performs an immediate update except when the object is a Features::Feature . If a candidate attribute is an array attribute, this method will delete all the array elements. NOTE: If the input specifies reference type, then this function will delete string type non-array attributes that have a reference value. The reference type is used only to single out string type non-array attributes that contain a reference value. The use of reference type in this function is deprecated. Please use string type instead.
Created in NX3.0.0.

License requirements : None

Parameters:
typetype

Deletes all attributes of a specific type with the option to update or not.

If a candidate attribute is an array attribute, this method will delete all the array elements. NOTE: If the input specifies reference type, then this function will delete string type non-array attributes that have a reference value. The reference type is used only to single out string type non-array attributes that contain a reference value. The use of reference type in this function is deprecated. Please use string type instead.
Created in NX5.0.1.

License requirements : None

Parameters:
typetype
optionoption

Deletes an attribute by type and title.

This method performs an immediate update except when the object is a Features::Feature . If a candidate attribute is an array attribute, this method will delete all the array elements. NOTE: If the input specifies reference type, then this function will delete string type attributes that have a reference value. The reference type is used only to single out string type attributes that contain a reference value. The use of reference type in this function is discouraged.
Created in NX3.0.0.

License requirements : None

Parameters:
typetype
titletitle

Deletes an attribute by type and title with the option to update or not.

If a candidate attribute is an array attribute, this method will delete all the array elements. NOTE: If the input specifies reference type, then this function will delete string type attributes that have a reference value. The reference type is used only to single out string type attributes that contain a reference value. The use of reference type in this function is discouraged.
Created in NX5.0.1.

License requirements : None

Parameters:
typetype
titletitle
optionoption
void NXOpen::NXObject::DeleteUserAttribute ( NXOpen::NXObject::AttributeType  type,
const NXString title,
bool  deleteEntireArray,
NXOpen::Update::Option  option 
)

Deletes the first attribute encountered with the given Type, Title and Index.

If a candidate attribute is not an array attribute, the DeleteEntireArray input is ignored, otherwise the last element of the array is deleted. NOTE: This method does not support the use of NXObject::AttributeTypeReference .
Created in NX8.0.0.

License requirements : None

Parameters:
typetype
titletitle
deleteEntireArraydelete entire array
optionoption

Deletes the attributes encountered with the given Type with option to update or not.

NOTE: This method does not support the use of NXObject::AttributeTypeReference .
Created in NX8.0.0.

License requirements : None

Parameters:
typetype
optionoption
virtual NXOpen::INXObject* NXOpen::NXObject::FindObject ( const NXString journalIdentifier) [virtual]

Finds the NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns:

Created in NX3.0.0.

License requirements : None
Parameters:
journalIdentifierJournal identifier of the object

Implements NXOpen::INXObject.

Gets all the attribute titles of a specific type.

Only Title and Type are set in the returned struct. No values are returned. Array attributes are supported. The Title returned is the array title, with no index appended. Only one title is returned per array. This function does not return the titles of unset attributes. NOTE: If the input specifies reference type, then this function will get string type attributes that have a reference value. The reference type is used only to single out string type attributes that contain a reference value. The use of reference type in this function is deprecated. Please use string type instead.

Returns:

Created in NX3.0.0.

License requirements : None
Parameters:
typetype
bool NXOpen::NXObject::GetBooleanUserAttribute ( const NXString title,
int  index 
)

Gets a boolean attribute by Title and array Index.

If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXObject::GetUserAttributes .

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
titletitle
indexindex

Gets an integer attribute by title.

This method does not support array attributes.

Returns:

Created in NX3.0.0.

License requirements : None
Parameters:
titletitle
int NXOpen::NXObject::GetIntegerUserAttribute ( const NXString title,
int  index 
)

Gets an integer attribute by Title and array Index.

If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXObject::GetUserAttributes .

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
titletitle
indexindex
double NXOpen::NXObject::GetRealAttribute ( const NXString title)

Gets a real attribute by title.

This method does not support array attributes.

Returns:

Created in NX3.0.0.

License requirements : None
Parameters:
titletitle
double NXOpen::NXObject::GetRealUserAttribute ( const NXString title,
int  index 
)

Gets a real attribute by Title and array Index.

If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXObject::GetUserAttributes .

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
titletitle
indexindex

Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

Get the attribute by title. For the calculated value, please use NXObject::GetUserAttribute This method does not support array attributes.

Returns:

Created in NX3.0.0.

License requirements : None
Parameters:
titletitle

Gets a string attribute value by title.

For string attributes that use reference strings, this function returns the calculated value, not the reference string. This method does not support array attributes.

Returns:

Created in NX3.0.0.

License requirements : None
Parameters:
titletitle
NXString NXOpen::NXObject::GetStringUserAttribute ( const NXString title,
int  index 
)

Gets a string attribute by Title and array Index.

For reference type string attributes, the calculated StringValue is returned. If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXObject::GetUserAttributes . Gets a string attribute value by title.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
titletitle
indexindex

Gets a time attribute by title.

The time returned will be in the current time zone of the machine running the program. This method does not support array attributes. This method is deprecated.

Returns:

Created in NX3.0.0.

License requirements : None
Parameters:
formatformat
titletitle
NXString NXOpen::NXObject::GetTimeUserAttribute ( const NXString title,
int  index 
)

Gets a time attribute by Title and array Index.

The date format set by the Customer Defaults is used. If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXObject::GetUserAttributes . Gets a time attribute by title.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
titletitle
indexindex

Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.

If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXObject::GetUserAttributes . The date format set by the Customer Defaults is used for attributes of type time. NOTE: This method does not support the use of NXObject::AttributeTypeReference . Instead, use NXObject::AttributeTypeString . For reference type string attributes, both the ReferenceValue and the calculated StringValue are returned.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
titletitle
typetype
indexindex

Gets the first attribute encountered on the object, if any, with a given title, type and array index.

The value of the attribute is converted to and returned as a string. If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXObject::GetUserAttributesAsStrings . The date format set by the Customer Defaults is used for attributes of type time. NOTE: This method does not support the use of NXObject::AttributeTypeReference . Instead, use NXObject::AttributeTypeString . For reference type string attributes, the calculated StringValue is returned.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
titletitle
typetype
indexindex

Determine the lock of the given attribute.

For array attributes, the Title should be set to the array title, without the appended index. Individual array elements cannot be separately locked

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
titletitle
typetype

Gets all the attributes that have been set on the given object.

The elements of array attributes are returned individually in order of increasing indices. The returned Title of an array element is the array title (without index). The Index data member holds the index. The date format set by the Customer Defaults is used. Reference type attributes are returned as being of type NXObject::AttributeTypeString , and both the ReferenceValue and the calculated StringValue are returned.

Returns:

Created in NX8.0.0.

License requirements : None

Gets all the attributes that have been set on the given object, as well as information from attribute templates that have not been set (if 'IncludeUnset' is 'true').

The elements of array attributes are returned individually in order of increasing indices. The returned Title of an array element is the array title (without index). The Index data member holds the index. The date format set by the Customer Defaults is used. Reference type attributes are returnes as being of type NXObject::AttributeTypeString , and both the ReferenceValue and the calculated StringValue are returned.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
includeUnsetincludeunset

Gets all the attributes that have been set on the given object.

The values are returned as strings. The elements of array attributes are returned individually in order of increasing indices. The returned Title of an array element is the array title (without index). The Index data member holds the index. This method does not support the use of NXObject::AttributeTypeReference . Reference type attributes return the calculated StringValue. The date format set by the Customer Defaults is used.

Returns:

Created in NX8.0.0.

License requirements : None
bool NXOpen::NXObject::HasUserAttribute ( const NXString title,
NXOpen::NXObject::AttributeType  type,
int  index 
)

Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

The first element of an array has Index 0 (zero). NOTE: This method does not support the use of NXObject::AttributeTypeReference . Instead, use NXObject::AttributeTypeString .

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
titletitle
typetype
indexindex
virtual bool NXOpen::NXObject::IsOccurrence ( ) [virtual]

Returns whether this object is an occurrence or not.


Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.
Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

virtual NXString NXOpen::NXObject::Name ( ) [virtual]

Returns the owning component, if this object is an occurrence.


Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

Returns the owning part of this object
Created in NX3.0.0.



License requirements : None

Implements NXOpen::INXObject.

virtual void NXOpen::NXObject::Print ( ) [virtual]

Prints a representation of this object to the system log file.


Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

Returns the prototype of this object if it is an occurrence.


Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

void NXOpen::NXObject::SetAttribute ( const NXString title,
int  value 
)

Creates or modifies an integer attribute.

This method performs an immediate update except when the object is a Features::Feature . This method does not support array attributes.
Created in NX3.0.0.

License requirements : None

Parameters:
titletitle
valuevalue
void NXOpen::NXObject::SetAttribute ( const NXString title,
int  value,
NXOpen::Update::Option  option 
)

Creates or modifies an integer attribute with the option to update or not.

This method does not support array attributes.
Created in NX5.0.1.

License requirements : None

Parameters:
titletitle
valuevalue
optionoption
void NXOpen::NXObject::SetAttribute ( const NXString title,
double  value 
)

Creates or modifies a real attribute.

This method performs an immediate update except when the object is a Features::Feature . This method does not support array attributes.
Created in NX3.0.0.

License requirements : None

Parameters:
titletitle
valuevalue
void NXOpen::NXObject::SetAttribute ( const NXString title,
double  value,
NXOpen::Update::Option  option 
)

Creates or modifies a real attribute with the option to update or not.

This method does not support array attributes.
Created in NX5.0.1.

License requirements : None

Parameters:
titletitle
valuevalue
optionoption
void NXOpen::NXObject::SetAttribute ( const NXString title,
const NXString value 
)

Creates or modifies a string attribute.

This method performs an immediate update except when the object is a Features::Feature . This method does not support array attributes.
Created in NX3.0.0.

License requirements : None

Parameters:
titletitle
valuevalue
void NXOpen::NXObject::SetAttribute ( const NXString title,
const NXString value,
NXOpen::Update::Option  option 
)

Creates or modifies a string attribute with the option to update or not.

This method does not support array attributes.
Created in NX5.0.1.

License requirements : None

Parameters:
titletitle
valuevalue
optionoption
void NXOpen::NXObject::SetAttribute ( const NXString title)

Creates or modifies a null attribute which is an attribute with a title and no value.

This method performs an immediate update except when the object is a Features::Feature . This method does not support array attributes.
Created in NX3.0.0.

License requirements : None

Parameters:
titletitle
void NXOpen::NXObject::SetAttribute ( const NXString title,
NXOpen::Update::Option  option 
)

Creates or modifies a null attribute with the option to update or not.

This method does not support array attributes.
Created in NX5.0.1.

License requirements : None

Parameters:
titletitle
optionoption
void NXOpen::NXObject::SetBooleanUserAttribute ( const NXString title,
int  index,
bool  value,
NXOpen::Update::Option  option 
)

Creates or modifies a boolean attribute with the option to update or not.

To set a non-array attribute, set the index = -1. Arrays can be extended only one element at a time
Created in NX8.0.0.

License requirements : None

Parameters:
titletitle
indexindex
valuevalue
optionoption
virtual void NXOpen::NXObject::SetName ( const NXString name) [virtual]
void NXOpen::NXObject::SetReferenceAttribute ( const NXString title,
const NXString value 
)

Creates or modifies a string attribute which uses a reference string.

This method performs an immediate update except when the object is a Features::Feature . NOTE: The input value must be a valid reference string. This method does not support array attributes.
Created in NX3.0.0.

License requirements : None

Parameters:
titletitle
valuevalue
void NXOpen::NXObject::SetReferenceAttribute ( const NXString title,
const NXString value,
NXOpen::Update::Option  option 
)

Creates or modifies a string attribute which uses a reference string, with the option to update or not.

NOTE: The input value must be a valid reference string. This method does not support array attributes.
Created in NX5.0.1.

License requirements : None

Parameters:
titletitle
valuevalue
optionoption
void NXOpen::NXObject::SetTimeAttribute ( const NXString title,
const NXString value 
)

Creates or modifies a time attribute.

This method performs an immediate update except when the object is a Features::Feature . The time value is assumed to be in the current time zone of the machine running the program. NX will store the value in UTC. This method does not support array attributes.
Created in NX3.0.0.

License requirements : None

Parameters:
titletitle
valueThe current date and time is used if the value is NULL. See NXObject::DateAndTimeFormat for valid formats.
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::NXObject::SetTimeAttribute ( const NXString title,
const NXString value,
NXOpen::Update::Option  option 
)

Creates or modifies a time attribute with the option to update or not.

The time value is assumed to be in the current time zone of the machine running the program. NX will store the value in UTC. This method does not support array attributes.
Created in NX5.0.1.

License requirements : None

Parameters:
titletitle
valueThe current date and time is used if the value is NULL. See NXObject::DateAndTimeFormat for valid formats.
NOTE: The full Unicode character set is not supported for this parameter.
optionoption
void NXOpen::NXObject::SetTimeUserAttribute ( const NXString title,
int  index,
const NXString value,
NXOpen::Update::Option  option 
)

Creates or modifies a time attribute with the option to update or not.

The time value is assumed to be in the current time zone of the machine running the program. NX will store the value in UTC. To set a non-array attribute, set the index = -1. Arrays can be extended only one element at a time
Created in NX8.0.0.

License requirements : None

Parameters:
titletitle
indexindex
valueThe current date and time is used if the value is NULL. See NXObject::DateAndTimeFormat for valid formats.
NOTE: The full Unicode character set is not supported for this parameter.
optionoption

Creates or modifies an attribute with the option to update or not.

NOTE: This method does not support the use of NXObject::AttributeTypeReference . Instead, set the type to NXObject::AttributeTypeString and specify a ReferenceValue.

The following data members of the Info structure are ignored by this method: Alias Inherited Required Unset Locked OwnedBySystem

The following data members of an attribute cannot be edited once the attribute is set: Type Title TitleAlias Array ArrayElementIndex The dimensionality of the Unit specification (cannot change from mm to microA, but from mm to cm is fine)

The following data members can be set and modified only if the attribute is not associated with a template: Category

The following data of an attribute can be set if and only if the attribute is not associated with a template. It cannot be modified once set. Array
Created in NX8.0.0.

License requirements : None

Parameters:
infoinfo
optionoption
void NXOpen::NXObject::SetUserAttribute ( const NXString title,
int  index,
int  value,
NXOpen::Update::Option  option 
)

Creates or modifies an integer attribute with the option to update or not.

To set a non-array attribute, set the index = -1. Arrays can be extended only one element at a time
Created in NX8.0.0.

License requirements : None

Parameters:
titletitle
indexindex
valuevalue
optionoption
void NXOpen::NXObject::SetUserAttribute ( const NXString title,
int  index,
double  value,
NXOpen::Update::Option  option 
)

Creates or modifies a real attribute with the option to update or not.

To set a non-array attribute, set the index = -1. Arrays can be extended only one element at a time
Created in NX8.0.0.

License requirements : None

Parameters:
titletitle
indexindex
valuevalue
optionoption
void NXOpen::NXObject::SetUserAttribute ( const NXString title,
int  index,
const NXString value,
NXOpen::Update::Option  option 
)

Creates or modifies a string attribute with the option to update or not.

To set a non-array attribute, set the index = -1. Arrays can be extended only one element at a time
Created in NX8.0.0.

License requirements : None

Parameters:
titletitle
indexindex
valuevalue
optionoption
void NXOpen::NXObject::SetUserAttribute ( const NXString title,
int  index,
NXOpen::Update::Option  option 
)

Creates or modifies a null attribute with the option to update or not.

To set a non-array attribute, set the index = -1. Arrays can be extended only one element at a time
Created in NX8.0.0.

License requirements : None

Parameters:
titletitle
indexindex
optionoption
void NXOpen::NXObject::SetUserAttributeLock ( const NXString title,
NXOpen::NXObject::AttributeType  type,
bool  lock 
)

Lock or unlock the given attribute.

For array attributes, the Title should be set to the array title, without the appended index. Individual array elements cannot be separately locked. NOTE: Attributes that are reserved (OwnedBySystem), cannot be unlocked.
Created in NX8.0.0.

License requirements : None

Parameters:
titletitle
typetype
locklock

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