NX Open C++ Reference Guide
|
Represents an interface class that is used to populate a list of identification properties for an object. More...
Public Types | |
enum | BooleanValueOption { BooleanValueOptionFalse, BooleanValueOptionTrue, BooleanValueOptionUnassigned } |
The value choices for an identification property of type ObjectIdentificationBuilder::DataTypeOptionBoolean. More... | |
enum | DataTypeOption { DataTypeOptionNull, DataTypeOptionBoolean, DataTypeOptionInteger, DataTypeOptionDouble, DataTypeOptionString, DataTypeOptionDate } |
Represents the data type of an identification property that is populated by the ObjectIdentificationBuilder. More... | |
Public Member Functions | |
void | AutoAssign () |
Auto assigns value of an identification property Created in NX8.0.0. | |
bool | AutoAssignable () |
Returns the auto assignable state of an identification property Created in NX8.0.0. | |
NXOpen::ObjectIdentificationBuilder::BooleanValueOption | IdentificationPropertyBooleanValue () |
Returns the boolean value of an identification property Created in NX8.0.0. | |
NXOpen::ObjectIdentificationBuilder::DataTypeOption | IdentificationPropertyDataType () |
Returns the data type for an identification property Created in NX8.0.0. | |
NXString | IdentificationPropertyDateValue () |
Returns the date and time value of an identification property Created in NX8.0.0. | |
double | IdentificationPropertyDoubleValue () |
Returns the double or floating value of an identification property Created in NX8.0.0. | |
int | IdentificationPropertyIntegerValue () |
Returns the integer value of an identification property Created in NX8.0.0. | |
NXString | IdentificationPropertyName () |
Returns the identification property name Created in NX8.0.0. | |
NXString | IdentificationPropertyStringValue () |
Returns the string value of an identification property Created in NX8.0.0. | |
NXString | ObjectDisplayName () |
Returns the objects display name Created in NX8.0.0. | |
NXString | ObjectIdentifierString () |
Returns the unique string identifier of an object whose identification properties are queried Created in NX8.0.0. | |
void | PopulateIdentificationProperties () |
Populates a list of identification properties for an object Created in NX8.0.0. | |
void | SetIdentificationPropertyBooleanValue (NXOpen::ObjectIdentificationBuilder::BooleanValueOption identificationPropertyBooleanValue) |
Sets the boolean value of an identification property Created in NX8.0.0. | |
void | SetIdentificationPropertyDateValue (const NXString &identificationPropertyDateValue) |
Sets the date and time value of an identification property Created in NX8.0.0. | |
void | SetIdentificationPropertyDoubleValue (double identificationPropertyDoubleValue) |
Sets the double or floating value of an identification property Created in NX8.0.0. | |
void | SetIdentificationPropertyIntegerValue (int identificationPropertyIntegerValue) |
Sets the integer value of an identification property Created in NX8.0.0. | |
void | SetIdentificationPropertyName (const NXString &identificationPropertyName) |
Sets the identification property name Created in NX8.0.0. | |
void | SetIdentificationPropertyStringValue (const NXString &identificationPropertyStringValue) |
Sets the string value of an identification property Created in NX8.0.0. | |
void | SetObjectDisplayName (const NXString &objectDisplayName) |
Sets the objects display name Created in NX8.0.0. | |
void | SetObjectIdentifierString (const NXString &objectIdentifierString) |
Sets the unique string identifier of an object whose identification properties are queried Created in NX8.0.0. | |
virtual bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. |
Represents an interface class that is used to populate a list of identification properties for an object.
The object is identified by a unique string identifier. Each identification property for an object has a name and a value (of a particular data type). The property value can be auto assigned.
Created in NX8.0.0.
The value choices for an identification property of type ObjectIdentificationBuilder::DataTypeOptionBoolean.
Represents the data type of an identification property that is populated by the ObjectIdentificationBuilder.
DataTypeOptionNull |
Null, the property has no data type. |
DataTypeOptionBoolean |
Boolean, the value is ObjectIdentificationBuilder::BooleanValueOption. |
DataTypeOptionInteger |
Integer, the value is a whole number. |
DataTypeOptionDouble |
Double, the value is a floating point number. |
DataTypeOptionString |
String, the value is a textual string. |
DataTypeOptionDate |
Date, the value is a date and time. |
Auto assigns value of an identification property
Created in NX8.0.0.
License requirements : None
Returns the auto assignable state of an identification property
Created in NX8.0.0.
License requirements : None
NXOpen::ObjectIdentificationBuilder::BooleanValueOption NXOpen::ObjectIdentificationBuilder::IdentificationPropertyBooleanValue | ( | ) |
Returns the boolean value of an identification property
Created in NX8.0.0.
License requirements : None
NXOpen::ObjectIdentificationBuilder::DataTypeOption NXOpen::ObjectIdentificationBuilder::IdentificationPropertyDataType | ( | ) |
Returns the data type for an identification property
Created in NX8.0.0.
License requirements : None
Returns the date and time value of an identification property
Created in NX8.0.0.
License requirements : None
Returns the double or floating value of an identification property
Created in NX8.0.0.
License requirements : None
Returns the integer value of an identification property
Created in NX8.0.0.
License requirements : None
Returns the identification property name
Created in NX8.0.0.
License requirements : None
Returns the string value of an identification property
Created in NX8.0.0.
License requirements : None
Returns the objects display name
Created in NX8.0.0.
License requirements : None
Returns the unique string identifier of an object whose identification properties are queried
Created in NX8.0.0.
License requirements : None
Populates a list of identification properties for an object
Created in NX8.0.0.
License requirements : None
void NXOpen::ObjectIdentificationBuilder::SetIdentificationPropertyBooleanValue | ( | NXOpen::ObjectIdentificationBuilder::BooleanValueOption | identificationPropertyBooleanValue | ) |
Sets the boolean value of an identification property
Created in NX8.0.0.
License requirements : None
identificationPropertyBooleanValue | identificationpropertybooleanvalue |
void NXOpen::ObjectIdentificationBuilder::SetIdentificationPropertyDateValue | ( | const NXString & | identificationPropertyDateValue | ) |
Sets the date and time value of an identification property
Created in NX8.0.0.
License requirements : None
identificationPropertyDateValue | identificationpropertydatevalue |
void NXOpen::ObjectIdentificationBuilder::SetIdentificationPropertyDoubleValue | ( | double | identificationPropertyDoubleValue | ) |
Sets the double or floating value of an identification property
Created in NX8.0.0.
License requirements : None
identificationPropertyDoubleValue | identificationpropertydoublevalue |
void NXOpen::ObjectIdentificationBuilder::SetIdentificationPropertyIntegerValue | ( | int | identificationPropertyIntegerValue | ) |
Sets the integer value of an identification property
Created in NX8.0.0.
License requirements : None
identificationPropertyIntegerValue | identificationpropertyintegervalue |
void NXOpen::ObjectIdentificationBuilder::SetIdentificationPropertyName | ( | const NXString & | identificationPropertyName | ) |
Sets the identification property name
Created in NX8.0.0.
License requirements : None
identificationPropertyName | identificationpropertyname |
void NXOpen::ObjectIdentificationBuilder::SetIdentificationPropertyStringValue | ( | const NXString & | identificationPropertyStringValue | ) |
Sets the string value of an identification property
Created in NX8.0.0.
License requirements : None
identificationPropertyStringValue | identificationpropertystringvalue |
void NXOpen::ObjectIdentificationBuilder::SetObjectDisplayName | ( | const NXString & | objectDisplayName | ) |
Sets the objects display name
Created in NX8.0.0.
License requirements : None
objectDisplayName | objectdisplayname |
void NXOpen::ObjectIdentificationBuilder::SetObjectIdentifierString | ( | const NXString & | objectIdentifierString | ) |
Sets the unique string identifier of an object whose identification properties are queried
Created in NX8.0.0.
License requirements : None
objectIdentifierString | objectidentifierstring |
virtual bool NXOpen::ObjectIdentificationBuilder::Validate | ( | ) | [virtual] |
Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.
Implements NXOpen::GeometricUtilities::IComponentBuilder.