NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::VisualReporting::Property Class Reference

A property within either a VisualReporting::Rule or a VisualReporting::Condition , or used as referenced property information for the report. More...

Inheritance diagram for NXOpen::VisualReporting::Property:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Public Types

enum  DatatypeOption {
  DatatypeOptionString, DatatypeOptionInteger, DatatypeOptionReal, DatatypeOptionBoolean,
  DatatypeOptionUnknown, DatatypeOptionNull, DatatypeOptionDate
}
 Represents the possible VisualReporting::Property::SystemDatatype options for a property. More...
enum  TypeOption {
  TypeOptionArrangementSpecificPositionProperty, TypeOptionAttributeProperty, TypeOptionComponentGroupProperty, TypeOptionComponentNameProperty,
  TypeOptionDescriptivePartNameProperty, TypeOptionLoadStateProperty, TypeOptionMassKgProperty, TypeOptionMassLbProperty,
  TypeOptionModifiedProperty, TypeOptionMultiCadProperty, TypeOptionPartNameProperty, TypeOptionPartUnitsProperty,
  TypeOptionPiecePartProperty, TypeOptionPositionProperty, TypeOptionPositionControlProperty, TypeOptionReadOnlyProperty,
  TypeOptionReferenceSetProperty, TypeOptionRootPartProperty, TypeOptionSuppressionControlProperty, TypeOptionWeightStatusProperty,
  TypeOptionTeamcenterProperty, TypeOptionServerProperty, TypeOptionDegreesOfFreedomProperty, TypeOptionRuleEvaluationResultProperty,
  TypeOptionCheckMateResultProperty, TypeOptionLastModifiedDateProperty, TypeOptionRequirementsValidationStatusProperty, TypeOptionRepresentationProperty,
  TypeOptionLastModifiedUserProperty
}
 Represents the possible VisualReporting::Property::PropertyType options for a property. 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 SetCustomMessage (const NXString &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 .

Detailed Description

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.


Member Enumeration Documentation

Represents the possible VisualReporting::Property::SystemDatatype options for a property.

Enumerator:
DatatypeOptionString 

String datatype.

DatatypeOptionInteger 

Integer datatype.

DatatypeOptionReal 

Floating-point datatype.

DatatypeOptionBoolean 

Boolean datatype.

DatatypeOptionUnknown 

The datatype is unknown.

DatatypeOptionNull 

Null data type.

DatatypeOptionDate 

Date datatype.

Represents the possible VisualReporting::Property::PropertyType options for a property.

Enumerator:
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


Member Function Documentation

Returns the bitmap name of this property.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns the custom message of this property.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns the VisualReporting::Property::TypeOption of this VisualReporting::Property .

Note that this VisualReporting::Property::PropertyType cannot be modified. Instead it is specified when creating this VisualReporting::Property by using the appropriate function:


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Sets the bitmap name of this property.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
bitmapNamebitmapname

Sets the custom message of this property.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
customMessagecustommessage

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 VisualReporting::Property::DatatypeOptionUnknown for properies whose VisualReporting::Property::PropertyType is VisualReporting::Property::TypeOptionTeamcenterProperty , VisualReporting::Property::TypeOptionServerProperty , or VisualReporting::Property::TypeOptionAttributeProperty where the preferred datatype cannot be determined.

Note that this VisualReporting::Property::SystemDatatype cannot be modified. Instead it is determined when creating this VisualReporting::Property by using the appropriate function:


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")


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