NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::INXObject Class Referenceabstract

Represents an interface from which most NXOpen classes inherit
Created in NX3.0.0. More...

Inheritance diagram for NXOpen::INXObject:
NXOpen::Annotations::IAngularTolerance NXOpen::Annotations::IAppendedText NXOpen::Annotations::IArbitraryTarget NXOpen::Annotations::ICircularTarget NXOpen::Annotations::IContainer NXOpen::Annotations::IDatum NXOpen::Annotations::IDatumTarget NXOpen::Annotations::IFcf NXOpen::Annotations::ILinearTolerance NXOpen::Annotations::ILineTarget NXOpen::Annotations::IPmi NXOpen::Annotations::IPointTarget NXOpen::Annotations::IRectangularTarget NXOpen::Annotations::ISlotDimension NXOpen::CAE::IFolder NXOpen::CAE::IHierarchicalFEModel NXOpen::Features::IContainerFeature NXOpen::Features::IIsolateToolBodyOperation NXOpen::GeometricUtilities::DegreesAndSegmentsOrPatchesBuilder NXOpen::GeometricUtilities::OnPathDimWithValueBuilder NXOpen::GeometricUtilities::RotationSetBuilder NXOpen::IBaseCurve NXOpen::IBasePlane NXOpen::IBody NXOpen::IFitTo NXOpen::ILocation NXOpen::IOrientation NXOpen::IParameterizedSurface NXOpen::IProfile NXOpen::IReferenceAxis NXOpen::ISketchHelpedConstraint NXOpen::ISurface NXOpen::NXObject NXOpen::Routing::ICharacteristic NXOpen::Routing::IPath

Public Member Functions

virtual NXOpen::INXObject * FindObject (const NXString &journalIdentifier)=0
 Finds the NXObject with the given identifier as recorded in a journal.
 
NXOpen::INXObject * FindObject (const char *journalIdentifier)
 Finds the NXObject with the given identifier as recorded in a journal.
 
virtual bool IsOccurrence ()=0
 Returns whether this object is an occurrence or not.
 
virtual NXString JournalIdentifier ()=0
 Returns the identifier that would be recorded in a journal for this object.
 
virtual NXString Name ()=0
 Returns the custom name of the object.
 
virtual
NXOpen::Assemblies::Component * 		OwningComponent ()=0
 Returns the owning component, if this object is an occurrence.
 
virtual NXOpen::BasePart * OwningPart ()=0
 Returns the owning part of this object
Created in NX3.0.0.
 
virtual void Print ()=0
 Prints a representation of this object to the system log file.
 
virtual NXOpen::INXObject * Prototype ()=0
 Returns the prototype of this object if it is an occurrence.
 
virtual void SetName (const NXString &name)=0
 Sets the custom name of the object.
 
void SetName (const char *name)
 Sets the custom name of the object.
 

Detailed Description

Represents an interface from which most NXOpen classes inherit
Created in NX3.0.0.


Member Function Documentation

virtual NXOpen::INXObject* NXOpen::INXObject::FindObject ( const NXString &  journalIdentifier)
pure 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

Implemented in NXOpen::NXObject, NXOpen::GeometricUtilities::DegreesAndSegmentsOrPatchesBuilder, NXOpen::CAE::FEElement, NXOpen::CAE::FENode, NXOpen::GeometricUtilities::OnPathDimWithValueBuilder, and NXOpen::GeometricUtilities::RotationSetBuilder.

NXOpen::INXObject* NXOpen::INXObject::FindObject ( const char *  journalIdentifier)

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
virtual bool NXOpen::INXObject::IsOccurrence ( )
pure virtual

Returns whether this object is an occurrence or not.


Created in NX3.0.0.

License requirements : None

Implemented in NXOpen::NXObject, NXOpen::GeometricUtilities::DegreesAndSegmentsOrPatchesBuilder, NXOpen::CAE::FEElement, NXOpen::CAE::FENode, NXOpen::GeometricUtilities::OnPathDimWithValueBuilder, and NXOpen::GeometricUtilities::RotationSetBuilder.

virtual NXString NXOpen::INXObject::JournalIdentifier ( )
pure virtual

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

Implemented in NXOpen::NXObject, NXOpen::GeometricUtilities::DegreesAndSegmentsOrPatchesBuilder, NXOpen::CAE::FEElement, NXOpen::CAE::FENode, NXOpen::GeometricUtilities::OnPathDimWithValueBuilder, and NXOpen::GeometricUtilities::RotationSetBuilder.

virtual NXString NXOpen::INXObject::Name ( )
pure virtual

Returns the custom name of the object.


Created in NX3.0.0.

License requirements : None

Implemented in NXOpen::NXObject, NXOpen::GeometricUtilities::DegreesAndSegmentsOrPatchesBuilder, NXOpen::CAE::FEElement, NXOpen::CAE::FENode, NXOpen::GeometricUtilities::OnPathDimWithValueBuilder, NXOpen::GeometricUtilities::RotationSetBuilder, NXOpen::CoordinateSystem, NXOpen::CAE::Optimization::DAOSolution, NXOpen::Validate::ResultObject, NXOpen::CAE::LaminateGlobalLayup, NXOpen::PartFamily::FamilyAttribute, NXOpen::CAM::CAMFeature, NXOpen::CAE::LaminateLayupOffset, NXOpen::CAE::LaminateMatOrientation, NXOpen::CAE::PreTestSolution, NXOpen::CAE::LaminatePlyGroup, NXOpen::CAM::FeatureGeometryGroup, NXOpen::CAE::LaminatePostReport, NXOpen::CAM::CAMAttribute, NXOpen::CAE::PreTestSensorConfig, NXOpen::CAE::PreTestExciterConfig, NXOpen::Unit, and NXOpen::Fields::NameVariable.

virtual NXOpen::Assemblies::Component* NXOpen::INXObject::OwningComponent ( )
pure virtual

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


Created in NX3.0.0.

License requirements : None

Implemented in NXOpen::NXObject, NXOpen::GeometricUtilities::DegreesAndSegmentsOrPatchesBuilder, NXOpen::CAE::FEElement, NXOpen::CAE::FENode, NXOpen::GeometricUtilities::OnPathDimWithValueBuilder, and NXOpen::GeometricUtilities::RotationSetBuilder.

virtual NXOpen::BasePart* NXOpen::INXObject::OwningPart ( )
pure virtual

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



License requirements : None

Implemented in NXOpen::NXObject, NXOpen::GeometricUtilities::DegreesAndSegmentsOrPatchesBuilder, NXOpen::CAE::FEElement, NXOpen::CAE::FENode, NXOpen::GeometricUtilities::OnPathDimWithValueBuilder, and NXOpen::GeometricUtilities::RotationSetBuilder.

virtual void NXOpen::INXObject::Print ( )
pure virtual

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


Created in NX3.0.0.

License requirements : None

Implemented in NXOpen::NXObject, NXOpen::GeometricUtilities::DegreesAndSegmentsOrPatchesBuilder, NXOpen::CAE::FEElement, NXOpen::CAE::FENode, NXOpen::GeometricUtilities::OnPathDimWithValueBuilder, and NXOpen::GeometricUtilities::RotationSetBuilder.

virtual NXOpen::INXObject* NXOpen::INXObject::Prototype ( )
pure virtual

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


Created in NX3.0.0.

License requirements : None

Implemented in NXOpen::NXObject, NXOpen::GeometricUtilities::DegreesAndSegmentsOrPatchesBuilder, NXOpen::CAE::FEElement, NXOpen::CAE::FENode, NXOpen::GeometricUtilities::OnPathDimWithValueBuilder, and NXOpen::GeometricUtilities::RotationSetBuilder.

virtual void NXOpen::INXObject::SetName ( const NXString &  name)
pure virtual

Sets the custom name of the object. 

   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.


Created in NX3.0.0.

License requirements : None

Parameters
namename

Implemented in NXOpen::NXObject, NXOpen::GeometricUtilities::DegreesAndSegmentsOrPatchesBuilder, NXOpen::CAE::FEElement, NXOpen::CAE::FENode, NXOpen::GeometricUtilities::OnPathDimWithValueBuilder, NXOpen::GeometricUtilities::RotationSetBuilder, NXOpen::SIM::KinematicConfigurator, NXOpen::CoordinateSystem, NXOpen::CAE::Optimization::DAOSolution, NXOpen::Validate::ResultObject, NXOpen::CAE::LaminateGlobalLayup, NXOpen::CAM::CAMFeature, NXOpen::CAE::LaminateLayupOffset, NXOpen::CAE::LaminateMatOrientation, NXOpen::CAE::PreTestSolution, NXOpen::CAE::LaminatePlyGroup, NXOpen::CAM::FeatureGeometryGroup, NXOpen::CAE::LaminatePostReport, NXOpen::CAE::PreTestExciterConfig, NXOpen::CAE::PreTestSensorConfig, and NXOpen::CAE::CaeGroup.

void NXOpen::INXObject::SetName ( const char *  name)

Sets the custom name of the object. 

   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.


Created in NX3.0.0.

License requirements : None

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