NX Open C++ Reference Guide
|
A property within either a VisualReporting::Rule or a VisualReporting::Condition , or used as referenced property information for the report. More...
Public Member Functions | |
NXString | BitmapName () |
Returns the bitmap name of this property. | |
NXString | CustomMessage () |
Returns the custom message of this property. | |
NXOpen::VisualReporting::Property::TypeOption | PropertyType () |
Returns the VisualReporting::Property::TypeOption of this VisualReporting::Property . | |
void | SetBitmapName (const NXString &bitmapName) |
Sets the bitmap name of this property. | |
void | SetBitmapName (const char *bitmapName) |
Sets the bitmap name of this property. | |
void | SetCustomMessage (const NXString &customMessage) |
Sets the custom message of this property. | |
void | SetCustomMessage (const char *customMessage) |
Sets the custom message of this property. | |
NXOpen::VisualReporting::Property::DatatypeOption | SystemDatatype () |
Returns the preferred VisualReporting::Property::DatatypeOption that should be used for the owning VisualReporting::Condition or VisualReporting::Classifier . | |
![]() | |
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 char *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 | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *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 | DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *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::INXObject * | FindObject (const NXString &journalIdentifier) |
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. | |
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. | |
bool | GetBooleanUserAttribute (const char *title, int index) |
Gets a boolean attribute by Title and array Index. | |
NXOpen::NXObject::ComputationalTime | GetComputationalTimeUserAttribute (const NXString &title, int index) |
Gets a time attribute by Title and array Index. | |
NXOpen::NXObject::ComputationalTime | GetComputationalTimeUserAttribute (const char *title, int index) |
Gets a time attribute by Title and array Index. | |
int | GetIntegerAttribute (const NXString &title) |
Gets an integer attribute by title. | |
int | GetIntegerAttribute (const char *title) |
Gets an integer attribute by title. | |
int | GetIntegerUserAttribute (const NXString &title, int index) |
Gets an integer attribute by Title and array Index. | |
int | GetIntegerUserAttribute (const char *title, int index) |
Gets an integer attribute by Title and array Index. | |
double | GetRealAttribute (const NXString &title) |
Gets a real attribute by title. | |
double | GetRealAttribute (const char *title) |
Gets a real attribute by title. | |
double | GetRealUserAttribute (const NXString &title, int index) |
Gets a real attribute by Title and array Index. | |
double | GetRealUserAttribute (const char *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 | GetReferenceAttribute (const char *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 | GetStringAttribute (const char *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 | GetStringUserAttribute (const char *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 | GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title) |
Gets a time attribute by title. | |
NXString | GetTimeUserAttribute (const NXString &title, int index) |
Gets a time attribute by Title and array Index. | |
NXString | GetTimeUserAttribute (const char *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. | |
NXOpen::NXObject::AttributeInformation | GetUserAttribute (const char *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. | |
NXString | GetUserAttributeAsString (const char *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. | |
bool | GetUserAttributeLock (const char *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. | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes (bool includeUnset, bool addStringValues) |
Gets all the attributes that have been set on the given object. | |
std::vector< NXString > | GetUserAttributesAsStrings () |
Gets all the attributes that have been set on the given object. | |
std::vector< NXOpen::NXObject * > | GetUserAttributeSourceObjects () |
Returns an array of objects from which this object presents attributes. | |
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). | |
bool | HasUserAttribute (const char *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::BasePart * | OwningPart () |
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::INXObject * | Prototype () |
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 char *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 char *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 char *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 char *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 char *title, const char *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 char *title, const char *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 char *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 | SetAttribute (const char *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. | |
void | SetBooleanUserAttribute (const char *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 | SetName (const char *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 char *title, const char *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 | SetReferenceAttribute (const char *title, const char *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 char *title, const char *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 | SetTimeAttribute (const char *title, const char *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 | SetTimeUserAttribute (const char *title, int index, const char *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 NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option) |
Creates or modifies a time attribute with the option to update or not. | |
void | SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &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 char *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 char *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 char *title, int index, const char *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 | SetUserAttribute (const char *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. | |
void | SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock) |
Lock or unlock the given attribute. | |
![]() | |
tag_t | GetTag () const |
<b>Deprecated</b>:<br> Use Tag instead. | |
tag_t | Tag () const |
Returns the tag of this object. | |
![]() | |
NXOpen::INXObject * | FindObject (const char *journalIdentifier) |
Finds the NXObject with the given identifier as recorded in a journal. | |
void | SetName (const char *name) |
Sets the custom name of the object. | |
A property within either a VisualReporting::Rule or a VisualReporting::Condition , or used as referenced property information for the report.
Created in NX7.0.0.
Represents the possible VisualReporting::Property::SystemDatatype options for a property.
Represents the possible VisualReporting::Property::PropertyType options for a property.
TypeOptionArrangementSpecificPositionProperty |
Arrengement specific positioning. |
TypeOptionAttributeProperty |
Part attribute property. |
TypeOptionComponentGroupProperty |
Component group name. |
TypeOptionComponentNameProperty |
Component name. |
TypeOptionDescriptivePartNameProperty |
Descriptive part name. |
TypeOptionLoadStateProperty |
The load-state of the component. |
TypeOptionMassKgProperty |
The mass of the component in pounds. |
TypeOptionMassLbProperty |
The mass of the component in kilograms. |
TypeOptionModifiedProperty |
Whether the component is modified. |
TypeOptionMultiCadProperty |
Parts mastered in a CAD system other than NX. |
TypeOptionPartNameProperty |
Part name. |
TypeOptionPartUnitsProperty |
Part units. |
TypeOptionPiecePartProperty |
Piece part. |
TypeOptionPositionProperty |
The position of the component. |
TypeOptionPositionControlProperty |
The position control of the component. |
TypeOptionReadOnlyProperty |
Whether the component is read-only. |
TypeOptionReferenceSetProperty |
The reference-set used by the component. |
TypeOptionRootPartProperty |
Root part occurrence. |
TypeOptionSuppressionControlProperty |
The suppression control of the component. |
TypeOptionWeightStatusProperty |
The weight status of the component. |
TypeOptionTeamcenterProperty |
Teamcenter property. |
TypeOptionServerProperty |
Server Property defined in server side report. |
TypeOptionDegreesOfFreedomProperty |
The freedom degree of the component. |
TypeOptionRuleEvaluationResultProperty |
Rule Evaluation for results in part. |
TypeOptionCheckMateResultProperty |
Check-Mate result. |
TypeOptionLastModifiedDateProperty |
last modify date property |
TypeOptionRequirementsValidationStatusProperty |
Requirement validate result. |
TypeOptionRepresentationProperty |
Representation Status. |
TypeOptionLastModifiedUserProperty |
last modify user property |
TypeOptionComponentProperty |
Assembly Navigator column property. |
TypeOptionMassGmProperty |
The mass of the component in grams. |
TypeOptionPartFamilyMemberProperty |
Part family member. |
TypeOptionLinkedPartProperty |
Linked part. |
TypeOptionProductTemplateProperty |
Product Template. |
TypeOptionBodyDensityProperty |
Body density property. |
TypeOptionBodyMassProperty |
Body mass property. |
TypeOptionBodyRadiusGyrationProperty |
Body radius gyration property. |
TypeOptionBodySurfaceAreaProperty |
Body surface area property. |
TypeOptionBodyTypeProperty |
Body type property. |
TypeOptionBodyVolumeProperty |
Body volume property. |
TypeOptionBodyWeightProperty |
Body weight property. |
TypeOptionFaceAreaProperty |
Face area property. |
TypeOptionFaceTypeProperty |
Face type property. |
TypeOptionFaceMinRadiusProperty |
Face minimum radius property. |
TypeOptionFacePerimeterProperty |
Face perimeter property. |
TypeOptionFacePMIFCFProperty |
Face PMI FCF property. |
TypeOptionFacePMIFCFCharacteristicsProperty |
Face PMI FCF characteristics property. |
TypeOptionFacePMIFCFCharFormTolProperty |
Face PMI FCF form characteristics property. |
TypeOptionFacePMIFCFCharLocationTolProperty |
Face PMI FCF location characteristics property. |
TypeOptionFacePMIFCFCharOrientationTolProperty |
Face PMI FCF orientation characteristics property. |
TypeOptionFacePMIFCFCharProfileTolProperty |
Face PMI FCF profile characteristics property. |
TypeOptionFacePMIFCFCharRunoutTolProperty |
Face PMI FCF runout characteristics property. |
TypeOptionFacePMIDatumFeatureProperty |
Face PMI datum feature property. |
TypeOptionFacePMIDatumTargetProperty |
Face PMI datum target property. |
TypeOptionObjectAttributeProperty |
Sub-part object attribute property. |
TypeOptionObjectCreatedByUserProperty |
Sub-part object created by user property. |
TypeOptionObjectCreatedDateProperty |
Sub-part object created date property. |
TypeOptionObjectCreatedVersionProperty |
Sub-part object created version property. |
TypeOptionObjectRefByWaveLinkProperty |
Sub-part object referenced by Wave link property. |
TypeOptionObjectWaveLinkedProperty |
Sub-part object Wave linked property. |
TypeOptionObjectModifiedByUserProperty |
Sub-part object modified by user property. |
TypeOptionObjectModifiedDateProperty |
Sub-part object modified date property. |
TypeOptionObjectModifiedVersionProperty |
Sub-part object modified version property. |
TypeOptionPartitionMembershipProperty |
Partition Membership property. |
TypeOptionComponentAddedDateProperty |
Component Added Date. |
TypeOptionTeamcenterObjectProperty |
Teamcenter Object property. |
NXString NXOpen::VisualReporting::Property::BitmapName | ( | ) |
Returns the bitmap name of this property.
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
NXString NXOpen::VisualReporting::Property::CustomMessage | ( | ) |
Returns the custom message of this property.
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
NXOpen::VisualReporting::Property::TypeOption NXOpen::VisualReporting::Property::PropertyType | ( | ) |
Returns the VisualReporting::Property::TypeOption of this VisualReporting::Property .
Note that this @link VisualReporting::Property::PropertyType VisualReporting::Property::PropertyType@endlink cannot be modified. Instead it is specified when creating this @link VisualReporting::Property VisualReporting::Property@endlink by using the appropriate function: - @link VisualReporting::VisualReportBuilder::CreateProperty VisualReporting::VisualReportBuilder::CreateProperty@endlink
Created in NX7.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
void NXOpen::VisualReporting::Property::SetBitmapName | ( | const NXString & | bitmapName | ) |
Sets the bitmap name of this property.
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
bitmapName | bitmapname |
void NXOpen::VisualReporting::Property::SetBitmapName | ( | const char * | bitmapName | ) |
Sets the bitmap name of this property.
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
bitmapName | bitmapname |
void NXOpen::VisualReporting::Property::SetCustomMessage | ( | const NXString & | customMessage | ) |
Sets the custom message of this property.
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
customMessage | custommessage |
void NXOpen::VisualReporting::Property::SetCustomMessage | ( | const char * | customMessage | ) |
Sets the custom message of this property.
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
customMessage | custommessage |
NXOpen::VisualReporting::Property::DatatypeOption NXOpen::VisualReporting::Property::SystemDatatype | ( | ) |
Returns the preferred VisualReporting::Property::DatatypeOption that should be used for the owning VisualReporting::Condition or VisualReporting::Classifier .
This function will return a data type of @link VisualReporting::Property::DatatypeOptionUnknown VisualReporting::Property::DatatypeOptionUnknown@endlink for properies whose @link VisualReporting::Property::PropertyType VisualReporting::Property::PropertyType@endlink is @link VisualReporting::Property::TypeOptionTeamcenterProperty VisualReporting::Property::TypeOptionTeamcenterProperty@endlink , @link VisualReporting::Property::TypeOptionServerProperty VisualReporting::Property::TypeOptionServerProperty@endlink , or @link VisualReporting::Property::TypeOptionAttributeProperty VisualReporting::Property::TypeOptionAttributeProperty@endlink where the preferred datatype cannot be determined. Note that this @link VisualReporting::Property::SystemDatatype VisualReporting::Property::SystemDatatype@endlink cannot be modified. Instead it is determined when creating this @link VisualReporting::Property VisualReporting::Property@endlink by using the appropriate function: - @link VisualReporting::VisualReportBuilder::CreateProperty VisualReporting::VisualReportBuilder::CreateProperty@endlink
Created in NX7.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")