NXOpen C++ Reference Guide
|
Represents an abstract command argument. More...
Public Types | |
enum | Type { TypeInteger, TypeDouble, TypeString, TypeEnumeration } |
Represents the argument type. More... | |
Public Member Functions | |
NXString | DisplayName () |
Returns the argument display name Created in NX11.0.0. More... | |
virtual NXOpen::INXObject * | FindObject (const NXString &journalIdentifier) |
Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More... | |
virtual NXOpen::INXObject * | FindObject (const char *journalIdentifier) |
Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More... | |
NXString | Hint () |
Returns the argument hint. More... | |
virtual bool | IsOccurrence () |
Returns whether this object is an occurrence or not. More... | |
virtual NXString | JournalIdentifier () |
Returns the identifier that would be recorded in a journal for this object. More... | |
virtual NXString | Name () |
Returns the custom name of the object. More... | |
bool | Optional () |
Returns. More... | |
virtual NXOpen::Assemblies::Component * | OwningComponent () |
Returns the owning component, if this object is an occurrence. More... | |
virtual NXOpen::BasePart * | OwningPart () |
Returns the owning part of this object Created in NX3.0.0. More... | |
virtual void | Print () |
Prints a representation of this object to the system log file. More... | |
virtual NXOpen::INXObject * | Prototype () |
Returns the prototype of this object if it is an occurrence. More... | |
void | SetDisplayName (const NXString &displayName) |
Sets the argument display name Created in NX11.0.0. More... | |
void | SetDisplayName (const char *displayName) |
Sets the argument display name Created in NX11.0.0. More... | |
void | SetHint (const NXString &argumentHint) |
Sets the argument hint. More... | |
void | SetHint (const char *argumentHint) |
Sets the argument hint. More... | |
virtual void | SetName (const NXString &name) |
Sets the custom name of the object. More... | |
virtual void | SetName (const char *name) |
Sets the custom name of the object. More... | |
void | SetOptional (bool isOptional) |
Sets. More... | |
Public Member Functions inherited from NXOpen::TaggedObject | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
Represents an abstract command argument.
Not support KF.
Created in NX11.0.0.
NXString NXOpen::Report::BaseArgument::DisplayName | ( | ) |
Returns the argument display name
Created in NX11.0.0.
License requirements : None
|
virtual |
Finds the NXOpen::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.
journalIdentifier | Journal identifier of the object |
Implements NXOpen::INXObject.
|
virtual |
Finds the NXOpen::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.
journalIdentifier | Journal identifier of the object |
Implements NXOpen::INXObject.
NXString NXOpen::Report::BaseArgument::Hint | ( | ) |
Returns the argument hint.
Created in NX11.0.0.
License requirements : None
|
virtual |
Returns whether this object is an occurrence or not.
Created in NX3.0.0.
License requirements : None
Implements NXOpen::INXObject.
|
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
Implements NXOpen::INXObject.
|
virtual |
Returns the custom name of the object.
Created in NX3.0.0.
License requirements : None
Implements NXOpen::INXObject.
bool NXOpen::Report::BaseArgument::Optional | ( | ) |
Returns.
a value that indicates whether this argument is optional or not.
Created in NX11.0.0.
License requirements : None
|
virtual |
Returns the owning component, if this object is an occurrence.
Created in NX3.0.0.
License requirements : None
Implements NXOpen::INXObject.
|
virtual |
Returns the owning part of this object
Created in NX3.0.0.
License requirements : None
Implements NXOpen::INXObject.
|
virtual |
Prints a representation of this object to the system log file.
Created in NX3.0.0.
License requirements : None
Implements NXOpen::INXObject.
|
virtual |
Returns the prototype of this object if it is an occurrence.
Created in NX3.0.0.
License requirements : None
Implements NXOpen::INXObject.
void NXOpen::Report::BaseArgument::SetDisplayName | ( | const NXString & | displayName | ) |
Sets the argument display name
Created in NX11.0.0.
License requirements : None
displayName | displayname |
void NXOpen::Report::BaseArgument::SetDisplayName | ( | const char * | displayName | ) |
Sets the argument display name
Created in NX11.0.0.
License requirements : None
displayName | displayname |
void NXOpen::Report::BaseArgument::SetHint | ( | const NXString & | argumentHint | ) |
Sets the argument hint.
Created in NX11.0.0.
License requirements : None
argumentHint | argumenthint |
void NXOpen::Report::BaseArgument::SetHint | ( | const char * | argumentHint | ) |
Sets the argument hint.
Created in NX11.0.0.
License requirements : None
argumentHint | argumenthint |
|
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
name | name |
Implements NXOpen::INXObject.
|
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
name | name |
Implements NXOpen::INXObject.
void NXOpen::Report::BaseArgument::SetOptional | ( | bool | isOptional | ) |
Sets.
a value that indicates whether this argument is optional or not.
Created in NX11.0.0.
License requirements : None
isOptional | isoptional |