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

Represents a property table. More...

Inheritance diagram for NXOpen::BasePropertyTable:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::CAE::PropertyTable

Public Types

enum  BasePropertyType {
  BasePropertyTypeUnknown, BasePropertyTypeString, BasePropertyTypeBoolean, BasePropertyTypeInteger,
  BasePropertyTypeDouble, BasePropertyTypeFieldWrapper, BasePropertyTypeScalarFieldWrapper, BasePropertyTypeCoordinateSystem,
  BasePropertyTypeDoubleArray, BasePropertyTypeIntegerArray, BasePropertyTypePhysicalMaterial, BasePropertyTypeMatrix,
  BasePropertyTypeScalarTable, BasePropertyTypeScalarFieldTableWrapper, BasePropertyTypeComplexScalarFieldWrapper, BasePropertyTypeComplexVectorFieldWrapper
}
 Property Types. More...
 
- Public Types inherited from NXOpen::NXObject
enum  AttributeType {
  AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger,
  AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference,
  AttributeTypeAny = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
 Specifies the format of the date and time attribute. More...
 

Public Member Functions

void AddRowScalarFieldTable (const NXString &propertyName)
 Add row operation for scalar field table
Created in NX11.0.0. More...
 
void AddRowScalarFieldTable (const char *propertyName)
 Add row operation for scalar field table
Created in NX11.0.0. More...
 
void ClearTablePropertyOverride (const NXString &propertyName)
 Clear property override flag. More...
 
void ClearTablePropertyOverride (const char *propertyName)
 Clear property override flag. More...
 
void CopyProperties (NXOpen::BasePropertyTable *sourceTable)
 Copies the values from the input table into this table, the table descriptor neutral names must match
Created in NX9.0.0. More...
 
void CopyProperty (const NXString &propertyName, NXOpen::BasePropertyTable *sourcePropertyTable)
 Copy the value of one property from the source table into this table
Created in NX10.0.0. More...
 
void CopyProperty (const char *propertyName, NXOpen::BasePropertyTable *sourcePropertyTable)
 Copy the value of one property from the source table into this table
Created in NX10.0.0. More...
 
void DeleteRowScalarFieldTable (const NXString &propertyName)
 Delete row operation for scalar field table
Created in NX11.0.0. More...
 
void DeleteRowScalarFieldTable (const char *propertyName)
 Delete row operation for scalar field table
Created in NX11.0.0. More...
 
NXString DescriptorNeutralName ()
 Returns the neutral name of the property table's descriptor
Created in NX8.5.0. More...
 
NXString DescriptorSpecificName ()
 Returns the language specific name of the property table's descriptor
Created in NX8.5.0. More...
 
NXOpen::BasePropertyTable::BasePropertyType GetBasePropertyType (const NXString &propertyName)
 Returns the type of the property. More...
 
NXOpen::BasePropertyTable::BasePropertyType GetBasePropertyType (const char *propertyName)
 Returns the type of the property. More...
 
NXOpen::Fields::FieldExpressionGetBaseScalarFieldPropertyValue (const NXString &propertyName)
 Returns the field expression NXOpen::Fields::FieldExpression value of the property. More...
 
NXOpen::Fields::FieldExpressionGetBaseScalarFieldPropertyValue (const char *propertyName)
 Returns the field expression NXOpen::Fields::FieldExpression value of the property. More...
 
void GetBaseScalarWithDataPropertyValue (const NXString &propertyName, double *propertyValue, NXOpen::Unit **unitType)
 Returns the double value of the property with units. More...
 
void GetBaseScalarWithDataPropertyValue (const char *propertyName, double *propertyValue, NXOpen::Unit **unitType)
 Returns the double value of the property with units. More...
 
bool GetBooleanPropertyValue (const NXString &propertyName)
 Returns the boolean value of the property. More...
 
bool GetBooleanPropertyValue (const char *propertyName)
 Returns the boolean value of the property. More...
 
NXOpen::Fields::ComplexScalarFieldWrapperGetComplexScalarFieldWrapperPropertyValue (const NXString &propertyName)
 Returns the complex scalar field wrapper NXOpen::Fields::ComplexScalarFieldWrapper. More...
 
NXOpen::Fields::ComplexScalarFieldWrapperGetComplexScalarFieldWrapperPropertyValue (const char *propertyName)
 Returns the complex scalar field wrapper NXOpen::Fields::ComplexScalarFieldWrapper. More...
 
NXOpen::Fields::ComplexVectorFieldWrapperGetComplexVectorFieldWrapperPropertyValue (const NXString &propertyName)
 Returns the complex vector field wrapper NXOpen::Fields::ComplexScalarFieldWrapper. More...
 
NXOpen::Fields::ComplexVectorFieldWrapperGetComplexVectorFieldWrapperPropertyValue (const char *propertyName)
 Returns the complex vector field wrapper NXOpen::Fields::ComplexScalarFieldWrapper. More...
 
NXOpen::CoordinateSystemGetCoordinateSystemPropertyValue (const NXString &propertyName)
 Returns the coordinate system NXOpen::CoordinateSystem. More...
 
NXOpen::CoordinateSystemGetCoordinateSystemPropertyValue (const char *propertyName)
 Returns the coordinate system NXOpen::CoordinateSystem. More...
 
double GetDoublePropertyValue (const NXString &propertyName)
 Returns the double value of the property. More...
 
double GetDoublePropertyValue (const char *propertyName)
 Returns the double value of the property. More...
 
NXOpen::Fields::FieldWrapperGetFieldWrapperPropertyValue (const NXString &propertyName)
 Returns the field wrapper NXOpen::Fields::FieldWrapper. More...
 
NXOpen::Fields::FieldWrapperGetFieldWrapperPropertyValue (const char *propertyName)
 Returns the field wrapper NXOpen::Fields::FieldWrapper. More...
 
NXString GetFileReferencePropertyValue (const NXString &propertyName)
 Returns the file reference value of the property. More...
 
NXString GetFileReferencePropertyValue (const char *propertyName)
 Returns the file reference value of the property. More...
 
std::vector< int > GetIntegerArrayPropertyValue (const NXString &propertyName)
 Returns the integer array value of the property. More...
 
std::vector< int > GetIntegerArrayPropertyValue (const char *propertyName)
 Returns the integer array value of the property. More...
 
int GetIntegerPropertyValue (const NXString &propertyName)
 Returns the integer value of the property. More...
 
int GetIntegerPropertyValue (const char *propertyName)
 Returns the integer value of the property. More...
 
void GetMaterialPropertyValue (const NXString &propertyName, bool *materialInherited, NXOpen::PhysicalMaterial **material)
 Gets the material value. More...
 
void GetMaterialPropertyValue (const char *propertyName, bool *materialInherited, NXOpen::PhysicalMaterial **material)
 Gets the material value. More...
 
NXOpen::ScalarMatrixValueGetMatrixPropertyValue (const NXString &propertyName)
 Returns a matrix cell value from the matrix value of the property. More...
 
NXOpen::ScalarMatrixValueGetMatrixPropertyValue (const char *propertyName)
 Returns a matrix cell value from the matrix value of the property. More...
 
int GetPropertyCount ()
 The count of properties in the table. More...
 
NXString GetPropertyNameByIndex (int index)
 Returns the name of the property. More...
 
std::vector< double > GetScalarArrayPropertyValue (const NXString &propertyName)
 Returns the scalar array value of the property. More...
 
std::vector< double > GetScalarArrayPropertyValue (const char *propertyName)
 Returns the scalar array value of the property. More...
 
void GetScalarArrayWithUnitsPropertyValue (const NXString &propertyName, std::vector< double > &propertyValue, NXOpen::Unit **unitType)
 Returns the scalar array and unit value of the property. More...
 
void GetScalarArrayWithUnitsPropertyValue (const char *propertyName, std::vector< double > &propertyValue, NXOpen::Unit **unitType)
 Returns the scalar array and unit value of the property. More...
 
void GetScalarFieldTableRowCol (const NXString &propertyName, int *nRows, int *nCols)
 Sets the scalar field wrapper NXOpen::Fields::ScalarFieldWrapper. More...
 
void GetScalarFieldTableRowCol (const char *propertyName, int *nRows, int *nCols)
 Sets the scalar field wrapper NXOpen::Fields::ScalarFieldWrapper. More...
 
NXOpen::Fields::ScalarFieldWrapperGetScalarFieldWrapperByIndex (int iRow, int iCol, const NXString &propertyName)
 Returns the scalar field wrapper NXOpen::Fields::FieldWrapper. More...
 
NXOpen::Fields::ScalarFieldWrapperGetScalarFieldWrapperByIndex (int iRow, int iCol, const char *propertyName)
 Returns the scalar field wrapper NXOpen::Fields::FieldWrapper. More...
 
NXOpen::Fields::ScalarFieldWrapperGetScalarFieldWrapperPropertyValue (const NXString &propertyName)
 Returns the scalar field wrapper NXOpen::Fields::ScalarFieldWrapper. More...
 
NXOpen::Fields::ScalarFieldWrapperGetScalarFieldWrapperPropertyValue (const char *propertyName)
 Returns the scalar field wrapper NXOpen::Fields::ScalarFieldWrapper. More...
 
NXOpen::ExpressionGetScalarPropertyValue (const NXString &propertyName)
 Returns the expression NXOpen::Expression value of the property Use NXOpen::BasePropertyTable::SetBaseScalarWithDataPropertyValue for a constant value when an expression NXOpen::Expression is not needed. More...
 
NXOpen::ExpressionGetScalarPropertyValue (const char *propertyName)
 Returns the expression NXOpen::Expression value of the property Use NXOpen::BasePropertyTable::SetBaseScalarWithDataPropertyValue for a constant value when an expression NXOpen::Expression is not needed. More...
 
NXOpen::ScalarTableValueGetScalarTablePropertyValue (const NXString &propertyName)
 Returns a scalar table value value from the scalar table value of the property. More...
 
NXOpen::ScalarTableValueGetScalarTablePropertyValue (const char *propertyName)
 Returns a scalar table value value from the scalar table value of the property. More...
 
NXString GetStringPropertyValue (const NXString &propertyName)
 Returns the string value of the property. More...
 
NXString GetStringPropertyValue (const char *propertyName)
 Returns the string value of the property. More...
 
void SetBaseScalarFieldPropertyValue (const NXString &propertyName, NXOpen::Fields::FieldExpression *propertyValue)
 Sets the field expression NXOpen::Fields::FieldExpression value of the property. More...
 
void SetBaseScalarFieldPropertyValue (const char *propertyName, NXOpen::Fields::FieldExpression *propertyValue)
 Sets the field expression NXOpen::Fields::FieldExpression value of the property. More...
 
void SetBaseScalarWithDataPropertyValue (const NXString &propertyName, double propertyValue, NXOpen::Unit *unitType)
 Sets the the Scalar property as a constant double value with units. More...
 
void SetBaseScalarWithDataPropertyValue (const char *propertyName, double propertyValue, NXOpen::Unit *unitType)
 Sets the the Scalar property as a constant double value with units. More...
 
void SetBaseScalarWithDataPropertyValue (const NXString &propertyName, const NXString &propertyValue, NXOpen::Unit *unitType)
 Sets the the Scalar property as a string value with units. More...
 
void SetBaseScalarWithDataPropertyValue (const char *propertyName, const char *propertyValue, NXOpen::Unit *unitType)
 Sets the the Scalar property as a string value with units. More...
 
void SetBooleanPropertyValue (const NXString &propertyName, bool propertyValue)
 Sets the boolean value of the property. More...
 
void SetBooleanPropertyValue (const char *propertyName, bool propertyValue)
 Sets the boolean value of the property. More...
 
void SetComplexScalarFieldWrapperPropertyValue (const NXString &propertyName, NXOpen::Fields::ComplexScalarFieldWrapper *propertyValue)
 Sets the complex scalar field wrapper NXOpen::Fields::ComplexScalarFieldWrapper. More...
 
void SetComplexScalarFieldWrapperPropertyValue (const char *propertyName, NXOpen::Fields::ComplexScalarFieldWrapper *propertyValue)
 Sets the complex scalar field wrapper NXOpen::Fields::ComplexScalarFieldWrapper. More...
 
void SetComplexVectorFieldWrapperPropertyValue (const NXString &propertyName, NXOpen::Fields::ComplexVectorFieldWrapper *propertyValue)
 Sets the complex vector field wrapper NXOpen::Fields::ComplexVectorFieldWrapper. More...
 
void SetComplexVectorFieldWrapperPropertyValue (const char *propertyName, NXOpen::Fields::ComplexVectorFieldWrapper *propertyValue)
 Sets the complex vector field wrapper NXOpen::Fields::ComplexVectorFieldWrapper. More...
 
void SetCoordinateSystemPropertyValue (const NXString &propertyName, NXOpen::CoordinateSystem *propertyValue)
 Sets the coordinate system NXOpen::CoordinateSystem. More...
 
void SetCoordinateSystemPropertyValue (const char *propertyName, NXOpen::CoordinateSystem *propertyValue)
 Sets the coordinate system NXOpen::CoordinateSystem. More...
 
void SetDoublePropertyValue (const NXString &propertyName, double propertyValue)
 Sets the double value of the property. More...
 
void SetDoublePropertyValue (const char *propertyName, double propertyValue)
 Sets the double value of the property. More...
 
void SetFieldWrapperPropertyValue (const NXString &propertyName, NXOpen::Fields::FieldWrapper *propertyValue)
 Sets the field wrapper NXOpen::Fields::FieldWrapper. More...
 
void SetFieldWrapperPropertyValue (const char *propertyName, NXOpen::Fields::FieldWrapper *propertyValue)
 Sets the field wrapper NXOpen::Fields::FieldWrapper. More...
 
void SetFileReferencePropertyValue (const NXString &propertyName, const NXString &propertyValue)
 Sets the file reference value of the property. More...
 
void SetFileReferencePropertyValue (const char *propertyName, const char *propertyValue)
 Sets the file reference value of the property. More...
 
void SetIntegerArrayPropertyValue (const NXString &propertyName, const std::vector< int > &propertyValue)
 Sets the integer array value of the property. More...
 
void SetIntegerArrayPropertyValue (const char *propertyName, const std::vector< int > &propertyValue)
 Sets the integer array value of the property. More...
 
void SetIntegerPropertyValue (const NXString &propertyName, int propertyValue)
 Sets the integer value of the property. More...
 
void SetIntegerPropertyValue (const char *propertyName, int propertyValue)
 Sets the integer value of the property. More...
 
void SetMaterialPropertyValue (const NXString &propertyName, bool materialInherited, NXOpen::PhysicalMaterial *material)
 Sets the material value. More...
 
void SetMaterialPropertyValue (const char *propertyName, bool materialInherited, NXOpen::PhysicalMaterial *material)
 Sets the material value. More...
 
void SetMatrixPropertyValue (const NXString &propertyName, NXOpen::ScalarMatrixValue *matrix)
 Set a matrix cell value from the matrix value of the property. More...
 
void SetMatrixPropertyValue (const char *propertyName, NXOpen::ScalarMatrixValue *matrix)
 Set a matrix cell value from the matrix value of the property. More...
 
void SetScalarArrayPropertyValue (const NXString &propertyName, const std::vector< double > &propertyValue)
 Sets the scalar array value of the property. More...
 
void SetScalarArrayPropertyValue (const char *propertyName, const std::vector< double > &propertyValue)
 Sets the scalar array value of the property. More...
 
void SetScalarArrayWithUnitsPropertyValue (const NXString &propertyName, const std::vector< double > &propertyValue, NXOpen::Unit *unitType)
 Sets the scalar array and unit value of the property. More...
 
void SetScalarArrayWithUnitsPropertyValue (const char *propertyName, const std::vector< double > &propertyValue, NXOpen::Unit *unitType)
 Sets the scalar array and unit value of the property. More...
 
void SetScalarFieldWrapperByIndex (int iRow, int iCol, const NXString &propertyName, NXOpen::Fields::ScalarFieldWrapper *propertyValue)
 Sets the scalar field wrapper NXOpen::Fields::ScalarFieldWrapper. More...
 
void SetScalarFieldWrapperByIndex (int iRow, int iCol, const char *propertyName, NXOpen::Fields::ScalarFieldWrapper *propertyValue)
 Sets the scalar field wrapper NXOpen::Fields::ScalarFieldWrapper. More...
 
void SetScalarFieldWrapperPropertyValue (const NXString &propertyName, NXOpen::Fields::ScalarFieldWrapper *propertyValue)
 Sets the scalar field wrapper NXOpen::Fields::ScalarFieldWrapper. More...
 
void SetScalarFieldWrapperPropertyValue (const char *propertyName, NXOpen::Fields::ScalarFieldWrapper *propertyValue)
 Sets the scalar field wrapper NXOpen::Fields::ScalarFieldWrapper. More...
 
void SetScalarPropertyValue (const NXString &propertyName, NXOpen::Expression *propertyValue)
 Sets the expression NXOpen::Expression value of the property Use NXOpen::BasePropertyTable::SetBaseScalarWithDataPropertyValue for a constant value when an expression NXOpen::Expression is not needed. More...
 
void SetScalarPropertyValue (const char *propertyName, NXOpen::Expression *propertyValue)
 Sets the expression NXOpen::Expression value of the property Use NXOpen::BasePropertyTable::SetBaseScalarWithDataPropertyValue for a constant value when an expression NXOpen::Expression is not needed. More...
 
void SetScalarTablePropertyValue (const NXString &propertyName, NXOpen::ScalarTableValue *table)
 Set a scalar table value from the scalar table value of the property. More...
 
void SetScalarTablePropertyValue (const char *propertyName, NXOpen::ScalarTableValue *table)
 Set a scalar table value from the scalar table value of the property. More...
 
void SetStringPropertyValue (const NXString &propertyName, const NXString &propertyValue)
 Sets the string value of the property. More...
 
void SetStringPropertyValue (const char *propertyName, const char *propertyValue)
 Sets the string value of the property. More...
 
void SetTablePropertyOverride (const NXString &propertyName)
 Set property override flag. More...
 
void SetTablePropertyOverride (const char *propertyName)
 Set property override flag. More...
 
void SetTablePropertyWithoutValue (const NXString &propertyName)
 Unset a property. More...
 
void SetTablePropertyWithoutValue (const char *propertyName)
 Unset a property. More...
 
- Public Member Functions inherited from NXOpen::NXObject
NXOpen::AttributeIteratorCreateAttributeIterator ()
 Create an attribute iterator. More...
 
void DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
 Deletes all attributes of a specific type. More...
 
void DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
 Deletes all attributes of a specific type with the option to update or not. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
 Deletes an attribute by type and title. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
 Deletes an attribute by type and title. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
void DeleteUserAttributes (NXOpen::AttributeIterator *iterator, NXOpen::Update::Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator
Created in NX8.0.0. More...
 
void DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
virtual NXOpen::INXObjectFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual NXOpen::INXObjectFindObject (const char *journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
bool GetBooleanUserAttribute (const NXString &title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
bool GetBooleanUserAttribute (const char *title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index. More...
 
int GetIntegerAttribute (const NXString &title)
 Gets an integer attribute by title. More...
 
int GetIntegerAttribute (const char *title)
 Gets an integer attribute by title. More...
 
int GetIntegerUserAttribute (const NXString &title, int index)
 Gets an integer attribute by Title and array Index. More...
 
int GetIntegerUserAttribute (const char *title, int index)
 Gets an integer attribute by Title and array Index. More...
 
bool GetNextUserAttribute (NXOpen::AttributeIterator *iterator, NXOpen::NXObject::AttributeInformation *info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
NXString GetPdmReferenceAttributeValue (const NXString &attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
NXString GetPdmReferenceAttributeValue (const char *attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
double GetRealAttribute (const NXString &title)
 Gets a real attribute by title. More...
 
double GetRealAttribute (const char *title)
 Gets a real attribute by title. More...
 
double GetRealUserAttribute (const NXString &title, int index)
 Gets a real attribute by Title and array Index. More...
 
double GetRealUserAttribute (const char *title, int index)
 Gets a real attribute by Title and array Index. More...
 
NXString GetReferenceAttribute (const NXString &title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
NXString GetReferenceAttribute (const char *title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
NXString GetStringAttribute (const NXString &title)
 Gets a string attribute value by title. More...
 
NXString GetStringAttribute (const char *title)
 Gets a string attribute value by title. More...
 
NXString GetStringUserAttribute (const NXString &title, int index)
 Gets a string attribute by Title and array Index. More...
 
NXString GetStringUserAttribute (const char *title, int index)
 Gets a string attribute by Title and array Index. More...
 
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
 Gets a time attribute by title. More...
 
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
 Gets a time attribute by title. More...
 
NXString GetTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXString GetTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index. More...
 
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. More...
 
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. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttribute (const NXString &title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
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. More...
 
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. More...
 
int GetUserAttributeCount (NXOpen::AttributeIterator *iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
int GetUserAttributeCount (NXOpen::AttributeIterator *iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
int GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
int GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
 Gets the count of attributes on the object, if any, of the given type. More...
 
bool GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute. More...
 
bool GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (NXOpen::AttributeIterator *iterator)
 Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
std::vector< NXStringGetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
int GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
int GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
std::vector< NXOpen::NXObject * > GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
bool HasUserAttribute (NXOpen::AttributeIterator *iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator. More...
 
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 Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
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 Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. 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...
 
virtual
NXOpen::Assemblies::Component
OwningComponent ()
 Returns the owning component, if this object is an occurrence. More...
 
virtual NXOpen::BasePartOwningPart ()
 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::INXObjectPrototype ()
 Returns the prototype of this object if it is an occurrence. More...
 
void SetAttribute (const NXString &title, int value)
 Creates or modifies an integer attribute. More...
 
void SetAttribute (const char *title, int value)
 Creates or modifies an integer attribute. More...
 
void SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetAttribute (const char *title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title, double value)
 Creates or modifies a real attribute. More...
 
void SetAttribute (const char *title, double value)
 Creates or modifies a real attribute. More...
 
void SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetAttribute (const char *title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute. More...
 
void SetAttribute (const char *title, const char *value)
 Creates or modifies a string attribute. More...
 
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. More...
 
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. More...
 
void SetAttribute (const NXString &title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
void SetAttribute (const char *title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
void SetAttribute (const NXString &title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetAttribute (const char *title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
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. More...
 
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. 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 SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
void SetPdmReferenceAttribute (const char *attributeTitle, const char *attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
void SetReferenceAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute which uses a reference string. More...
 
void SetReferenceAttribute (const char *title, const char *value)
 Creates or modifies a string attribute which uses a reference string. More...
 
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. More...
 
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. More...
 
void SetTimeAttribute (const NXString &title, const NXString &value)
 Creates or modifies a time attribute. More...
 
void SetTimeAttribute (const char *title, const char *value)
 Creates or modifies a time attribute. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
void SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
void SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute. More...
 
void SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a property table.


This is a sub object

Created in NX9.0.0.

Member Enumeration Documentation

Property Types.

Enumerator
BasePropertyTypeUnknown 

unknown

BasePropertyTypeString 

string

BasePropertyTypeBoolean 

boolean

BasePropertyTypeInteger 

integer

BasePropertyTypeDouble 

double

BasePropertyTypeFieldWrapper 

field wrapper

BasePropertyTypeScalarFieldWrapper 

scalar field wrapper

BasePropertyTypeCoordinateSystem 

coordinate system

BasePropertyTypeDoubleArray 

double array

BasePropertyTypeIntegerArray 

integer array

BasePropertyTypePhysicalMaterial 

physical material

BasePropertyTypeMatrix 

matrix

BasePropertyTypeScalarTable 

scalar table

BasePropertyTypeScalarFieldTableWrapper 

scalar field table wrapper

BasePropertyTypeComplexScalarFieldWrapper 

complex scalar field wrapper

BasePropertyTypeComplexVectorFieldWrapper 

complex vector field wrapper

Member Function Documentation

void NXOpen::BasePropertyTable::AddRowScalarFieldTable ( const NXString propertyName)

Add row operation for scalar field table
Created in NX11.0.0.



License requirements : None

Parameters
propertyNamename of the property
void NXOpen::BasePropertyTable::AddRowScalarFieldTable ( const char *  propertyName)

Add row operation for scalar field table
Created in NX11.0.0.



License requirements : None

Parameters
propertyNamename of the property
void NXOpen::BasePropertyTable::ClearTablePropertyOverride ( const NXString propertyName)

Clear property override flag.


Created in NX9.0.0.

License requirements : None

Parameters
propertyNamename of the property
void NXOpen::BasePropertyTable::ClearTablePropertyOverride ( const char *  propertyName)

Clear property override flag.


Created in NX9.0.0.

License requirements : None

Parameters
propertyNamename of the property
void NXOpen::BasePropertyTable::CopyProperties ( NXOpen::BasePropertyTable sourceTable)

Copies the values from the input table into this table, the table descriptor neutral names must match
Created in NX9.0.0.



License requirements : None

Parameters
sourceTablesource table
void NXOpen::BasePropertyTable::CopyProperty ( const NXString propertyName,
NXOpen::BasePropertyTable sourcePropertyTable 
)

Copy the value of one property from the source table into this table
Created in NX10.0.0.



License requirements : None

Parameters
propertyNamename of the property
sourcePropertyTablesource property table
void NXOpen::BasePropertyTable::CopyProperty ( const char *  propertyName,
NXOpen::BasePropertyTable sourcePropertyTable 
)

Copy the value of one property from the source table into this table
Created in NX10.0.0.



License requirements : None

Parameters
propertyNamename of the property
sourcePropertyTablesource property table
void NXOpen::BasePropertyTable::DeleteRowScalarFieldTable ( const NXString propertyName)

Delete row operation for scalar field table
Created in NX11.0.0.



License requirements : None

Parameters
propertyNamename of the property
void NXOpen::BasePropertyTable::DeleteRowScalarFieldTable ( const char *  propertyName)

Delete row operation for scalar field table
Created in NX11.0.0.



License requirements : None

Parameters
propertyNamename of the property
NXString NXOpen::BasePropertyTable::DescriptorNeutralName ( )

Returns the neutral name of the property table's descriptor
Created in NX8.5.0.



License requirements : None

NXString NXOpen::BasePropertyTable::DescriptorSpecificName ( )

Returns the language specific name of the property table's descriptor
Created in NX8.5.0.



License requirements : None

NXOpen::BasePropertyTable::BasePropertyType NXOpen::BasePropertyTable::GetBasePropertyType ( const NXString propertyName)

Returns the type of the property.

Returns
type of the property
Created in NX9.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::BasePropertyTable::BasePropertyType NXOpen::BasePropertyTable::GetBasePropertyType ( const char *  propertyName)

Returns the type of the property.

Returns
type of the property
Created in NX9.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::Fields::FieldExpression* NXOpen::BasePropertyTable::GetBaseScalarFieldPropertyValue ( const NXString propertyName)

Returns the field expression NXOpen::Fields::FieldExpression value of the property.

Returns
value of the property
Created in NX9.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::Fields::FieldExpression* NXOpen::BasePropertyTable::GetBaseScalarFieldPropertyValue ( const char *  propertyName)

Returns the field expression NXOpen::Fields::FieldExpression value of the property.

Returns
value of the property
Created in NX9.0.0.

License requirements : None
Parameters
propertyNamename of the property
void NXOpen::BasePropertyTable::GetBaseScalarWithDataPropertyValue ( const NXString propertyName,
double *  propertyValue,
NXOpen::Unit **  unitType 
)

Returns the double value of the property with units.


Created in NX9.0.0.

License requirements : None

Parameters
propertyNamename of the Scalar
propertyValueThe current double value of the Scalar
unitTypeUnit type for the Scalar NULL if the Scalar has no units
void NXOpen::BasePropertyTable::GetBaseScalarWithDataPropertyValue ( const char *  propertyName,
double *  propertyValue,
NXOpen::Unit **  unitType 
)

Returns the double value of the property with units.


Created in NX9.0.0.

License requirements : None

Parameters
propertyNamename of the Scalar
propertyValueThe current double value of the Scalar
unitTypeUnit type for the Scalar NULL if the Scalar has no units
bool NXOpen::BasePropertyTable::GetBooleanPropertyValue ( const NXString propertyName)

Returns the boolean value of the property.

Returns
value of the property
Created in NX4.0.0.

License requirements : None
Parameters
propertyNamename of the property
bool NXOpen::BasePropertyTable::GetBooleanPropertyValue ( const char *  propertyName)

Returns the boolean value of the property.

Returns
value of the property
Created in NX4.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::Fields::ComplexScalarFieldWrapper* NXOpen::BasePropertyTable::GetComplexScalarFieldWrapperPropertyValue ( const NXString propertyName)

Returns the complex scalar field wrapper NXOpen::Fields::ComplexScalarFieldWrapper.

Returns
value of the property
Created in NX11.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::Fields::ComplexScalarFieldWrapper* NXOpen::BasePropertyTable::GetComplexScalarFieldWrapperPropertyValue ( const char *  propertyName)

Returns the complex scalar field wrapper NXOpen::Fields::ComplexScalarFieldWrapper.

Returns
value of the property
Created in NX11.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::Fields::ComplexVectorFieldWrapper* NXOpen::BasePropertyTable::GetComplexVectorFieldWrapperPropertyValue ( const NXString propertyName)

Returns the complex vector field wrapper NXOpen::Fields::ComplexScalarFieldWrapper.

Returns
value of the property
Created in NX12.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::Fields::ComplexVectorFieldWrapper* NXOpen::BasePropertyTable::GetComplexVectorFieldWrapperPropertyValue ( const char *  propertyName)

Returns the complex vector field wrapper NXOpen::Fields::ComplexScalarFieldWrapper.

Returns
value of the property
Created in NX12.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::CoordinateSystem* NXOpen::BasePropertyTable::GetCoordinateSystemPropertyValue ( const NXString propertyName)

Returns the coordinate system NXOpen::CoordinateSystem.

Returns
value of the property
Created in NX4.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::CoordinateSystem* NXOpen::BasePropertyTable::GetCoordinateSystemPropertyValue ( const char *  propertyName)

Returns the coordinate system NXOpen::CoordinateSystem.

Returns
value of the property
Created in NX4.0.0.

License requirements : None
Parameters
propertyNamename of the property
double NXOpen::BasePropertyTable::GetDoublePropertyValue ( const NXString propertyName)

Returns the double value of the property.

Returns
value of the property
Created in NX4.0.0.

License requirements : None
Parameters
propertyNamename of the property
double NXOpen::BasePropertyTable::GetDoublePropertyValue ( const char *  propertyName)

Returns the double value of the property.

Returns
value of the property
Created in NX4.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::Fields::FieldWrapper* NXOpen::BasePropertyTable::GetFieldWrapperPropertyValue ( const NXString propertyName)

Returns the field wrapper NXOpen::Fields::FieldWrapper.

Returns
value of the property
Created in NX6.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::Fields::FieldWrapper* NXOpen::BasePropertyTable::GetFieldWrapperPropertyValue ( const char *  propertyName)

Returns the field wrapper NXOpen::Fields::FieldWrapper.

Returns
value of the property
Created in NX6.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXString NXOpen::BasePropertyTable::GetFileReferencePropertyValue ( const NXString propertyName)

Returns the file reference value of the property.

Returns
value of the property
Created in NX12.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXString NXOpen::BasePropertyTable::GetFileReferencePropertyValue ( const char *  propertyName)

Returns the file reference value of the property.

Returns
value of the property
Created in NX12.0.0.

License requirements : None
Parameters
propertyNamename of the property
std::vector<int> NXOpen::BasePropertyTable::GetIntegerArrayPropertyValue ( const NXString propertyName)

Returns the integer array value of the property.

Returns

Created in NX5.0.0.

License requirements : None
Parameters
propertyNameproperty name
std::vector<int> NXOpen::BasePropertyTable::GetIntegerArrayPropertyValue ( const char *  propertyName)

Returns the integer array value of the property.

Returns

Created in NX5.0.0.

License requirements : None
Parameters
propertyNameproperty name
int NXOpen::BasePropertyTable::GetIntegerPropertyValue ( const NXString propertyName)

Returns the integer value of the property.

Returns
value of the property
Created in NX4.0.0.

License requirements : None
Parameters
propertyNamename of the property
int NXOpen::BasePropertyTable::GetIntegerPropertyValue ( const char *  propertyName)

Returns the integer value of the property.

Returns
value of the property
Created in NX4.0.0.

License requirements : None
Parameters
propertyNamename of the property
void NXOpen::BasePropertyTable::GetMaterialPropertyValue ( const NXString propertyName,
bool *  materialInherited,
NXOpen::PhysicalMaterial **  material 
)

Gets the material value.


Created in NX9.0.0.

License requirements : None

Parameters
propertyNamename of the property
materialInheritedtrue indicate the material is inherited from referenced object assignments such as geometry
materialthe material value to assign
void NXOpen::BasePropertyTable::GetMaterialPropertyValue ( const char *  propertyName,
bool *  materialInherited,
NXOpen::PhysicalMaterial **  material 
)

Gets the material value.


Created in NX9.0.0.

License requirements : None

Parameters
propertyNamename of the property
materialInheritedtrue indicate the material is inherited from referenced object assignments such as geometry
materialthe material value to assign
NXOpen::ScalarMatrixValue* NXOpen::BasePropertyTable::GetMatrixPropertyValue ( const NXString propertyName)

Returns a matrix cell value from the matrix value of the property.

Returns
NxM Scalar matrix
Created in NX6.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::ScalarMatrixValue* NXOpen::BasePropertyTable::GetMatrixPropertyValue ( const char *  propertyName)

Returns a matrix cell value from the matrix value of the property.

Returns
NxM Scalar matrix
Created in NX6.0.0.

License requirements : None
Parameters
propertyNamename of the property
int NXOpen::BasePropertyTable::GetPropertyCount ( )

The count of properties in the table.

Returns
count of properties
Created in NX4.0.0.

License requirements : None
NXString NXOpen::BasePropertyTable::GetPropertyNameByIndex ( int  index)

Returns the name of the property.

Returns
name of the property
Created in NX4.0.0.

License requirements : None
Parameters
indexindex of the property
std::vector<double> NXOpen::BasePropertyTable::GetScalarArrayPropertyValue ( const NXString propertyName)

Returns the scalar array value of the property.

Use NXOpen::BasePropertyTable::GetScalarArrayWithUnitsPropertyValue when other than base units are set.

Returns
value of the property
Created in NX5.0.0.

License requirements : None
Parameters
propertyNamename of the property
std::vector<double> NXOpen::BasePropertyTable::GetScalarArrayPropertyValue ( const char *  propertyName)

Returns the scalar array value of the property.

Use NXOpen::BasePropertyTable::GetScalarArrayWithUnitsPropertyValue when other than base units are set.

Returns
value of the property
Created in NX5.0.0.

License requirements : None
Parameters
propertyNamename of the property
void NXOpen::BasePropertyTable::GetScalarArrayWithUnitsPropertyValue ( const NXString propertyName,
std::vector< double > &  propertyValue,
NXOpen::Unit **  unitType 
)

Returns the scalar array and unit value of the property.


Created in NX7.5.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuearray of values of the property
unitTypeUnit type for the Array NULL if the Array has no units
void NXOpen::BasePropertyTable::GetScalarArrayWithUnitsPropertyValue ( const char *  propertyName,
std::vector< double > &  propertyValue,
NXOpen::Unit **  unitType 
)

Returns the scalar array and unit value of the property.


Created in NX7.5.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuearray of values of the property
unitTypeUnit type for the Array NULL if the Array has no units
void NXOpen::BasePropertyTable::GetScalarFieldTableRowCol ( const NXString propertyName,
int *  nRows,
int *  nCols 
)

Sets the scalar field wrapper NXOpen::Fields::ScalarFieldWrapper.


Created in NX11.0.0.

License requirements : None

Parameters
propertyNamename of the property
nRowsrow number
nColscol number
void NXOpen::BasePropertyTable::GetScalarFieldTableRowCol ( const char *  propertyName,
int *  nRows,
int *  nCols 
)

Sets the scalar field wrapper NXOpen::Fields::ScalarFieldWrapper.


Created in NX11.0.0.

License requirements : None

Parameters
propertyNamename of the property
nRowsrow number
nColscol number
NXOpen::Fields::ScalarFieldWrapper* NXOpen::BasePropertyTable::GetScalarFieldWrapperByIndex ( int  iRow,
int  iCol,
const NXString propertyName 
)

Returns the scalar field wrapper NXOpen::Fields::FieldWrapper.

Returns
value of the property
Created in NX11.0.0.

License requirements : None
Parameters
iRowrow number
iColcol number
propertyNamename of the property
NXOpen::Fields::ScalarFieldWrapper* NXOpen::BasePropertyTable::GetScalarFieldWrapperByIndex ( int  iRow,
int  iCol,
const char *  propertyName 
)

Returns the scalar field wrapper NXOpen::Fields::FieldWrapper.

Returns
value of the property
Created in NX11.0.0.

License requirements : None
Parameters
iRowrow number
iColcol number
propertyNamename of the property
NXOpen::Fields::ScalarFieldWrapper* NXOpen::BasePropertyTable::GetScalarFieldWrapperPropertyValue ( const NXString propertyName)

Returns the scalar field wrapper NXOpen::Fields::ScalarFieldWrapper.

Returns
value of the property
Created in NX6.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::Fields::ScalarFieldWrapper* NXOpen::BasePropertyTable::GetScalarFieldWrapperPropertyValue ( const char *  propertyName)

Returns the scalar field wrapper NXOpen::Fields::ScalarFieldWrapper.

Returns
value of the property
Created in NX6.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::Expression* NXOpen::BasePropertyTable::GetScalarPropertyValue ( const NXString propertyName)

Returns the expression NXOpen::Expression value of the property Use NXOpen::BasePropertyTable::SetBaseScalarWithDataPropertyValue for a constant value when an expression NXOpen::Expression is not needed.

Returns
value of the property
Created in NX4.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::Expression* NXOpen::BasePropertyTable::GetScalarPropertyValue ( const char *  propertyName)

Returns the expression NXOpen::Expression value of the property Use NXOpen::BasePropertyTable::SetBaseScalarWithDataPropertyValue for a constant value when an expression NXOpen::Expression is not needed.

Returns
value of the property
Created in NX4.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::ScalarTableValue* NXOpen::BasePropertyTable::GetScalarTablePropertyValue ( const NXString propertyName)

Returns a scalar table value value from the scalar table value of the property.

Returns
NxM Scalar table
Created in NX6.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXOpen::ScalarTableValue* NXOpen::BasePropertyTable::GetScalarTablePropertyValue ( const char *  propertyName)

Returns a scalar table value value from the scalar table value of the property.

Returns
NxM Scalar table
Created in NX6.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXString NXOpen::BasePropertyTable::GetStringPropertyValue ( const NXString propertyName)

Returns the string value of the property.

Returns
value of the property
Created in NX4.0.0.

License requirements : None
Parameters
propertyNamename of the property
NXString NXOpen::BasePropertyTable::GetStringPropertyValue ( const char *  propertyName)

Returns the string value of the property.

Returns
value of the property
Created in NX4.0.0.

License requirements : None
Parameters
propertyNamename of the property
void NXOpen::BasePropertyTable::SetBaseScalarFieldPropertyValue ( const NXString propertyName,
NXOpen::Fields::FieldExpression propertyValue 
)

Sets the field expression NXOpen::Fields::FieldExpression value of the property.


Created in NX9.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetBaseScalarFieldPropertyValue ( const char *  propertyName,
NXOpen::Fields::FieldExpression propertyValue 
)

Sets the field expression NXOpen::Fields::FieldExpression value of the property.


Created in NX9.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetBaseScalarWithDataPropertyValue ( const NXString propertyName,
double  propertyValue,
NXOpen::Unit unitType 
)

Sets the the Scalar property as a constant double value with units.

Use NXOpen::BasePropertyTable::SetScalarPropertyValue to enable Design Logic for this property.


Created in NX9.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValueThe double value for the Scalar
unitTypeUnit type for the Scalar NULL if the Scalar has no units
void NXOpen::BasePropertyTable::SetBaseScalarWithDataPropertyValue ( const char *  propertyName,
double  propertyValue,
NXOpen::Unit unitType 
)

Sets the the Scalar property as a constant double value with units.

Use NXOpen::BasePropertyTable::SetScalarPropertyValue to enable Design Logic for this property.


Created in NX9.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValueThe double value for the Scalar
unitTypeUnit type for the Scalar NULL if the Scalar has no units
void NXOpen::BasePropertyTable::SetBaseScalarWithDataPropertyValue ( const NXString propertyName,
const NXString propertyValue,
NXOpen::Unit unitType 
)

Sets the the Scalar property as a string value with units.

When the string does not represent a constant number, then an expression is created. Once a property has an expression, subsequent set commands will retain the expression and edit the new string into it. The string must not be empty. To set this property to empty, use NXOpen::BasePropertyTable::SetTablePropertyWithoutValue .


Created in NX9.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValueThe string value for the Scalar
unitTypeUnit type for the Scalar NULL if the Scalar has no units
void NXOpen::BasePropertyTable::SetBaseScalarWithDataPropertyValue ( const char *  propertyName,
const char *  propertyValue,
NXOpen::Unit unitType 
)

Sets the the Scalar property as a string value with units.

When the string does not represent a constant number, then an expression is created. Once a property has an expression, subsequent set commands will retain the expression and edit the new string into it. The string must not be empty. To set this property to empty, use NXOpen::BasePropertyTable::SetTablePropertyWithoutValue .


Created in NX9.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValueThe string value for the Scalar
unitTypeUnit type for the Scalar NULL if the Scalar has no units
void NXOpen::BasePropertyTable::SetBooleanPropertyValue ( const NXString propertyName,
bool  propertyValue 
)

Sets the boolean value of the property.


Created in NX4.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetBooleanPropertyValue ( const char *  propertyName,
bool  propertyValue 
)

Sets the boolean value of the property.


Created in NX4.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetComplexScalarFieldWrapperPropertyValue ( const NXString propertyName,
NXOpen::Fields::ComplexScalarFieldWrapper propertyValue 
)

Sets the complex scalar field wrapper NXOpen::Fields::ComplexScalarFieldWrapper.


Created in NX11.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetComplexScalarFieldWrapperPropertyValue ( const char *  propertyName,
NXOpen::Fields::ComplexScalarFieldWrapper propertyValue 
)

Sets the complex scalar field wrapper NXOpen::Fields::ComplexScalarFieldWrapper.


Created in NX11.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetComplexVectorFieldWrapperPropertyValue ( const NXString propertyName,
NXOpen::Fields::ComplexVectorFieldWrapper propertyValue 
)

Sets the complex vector field wrapper NXOpen::Fields::ComplexVectorFieldWrapper.


Created in NX12.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetComplexVectorFieldWrapperPropertyValue ( const char *  propertyName,
NXOpen::Fields::ComplexVectorFieldWrapper propertyValue 
)

Sets the complex vector field wrapper NXOpen::Fields::ComplexVectorFieldWrapper.


Created in NX12.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetCoordinateSystemPropertyValue ( const NXString propertyName,
NXOpen::CoordinateSystem propertyValue 
)

Sets the coordinate system NXOpen::CoordinateSystem.


Created in NX4.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetCoordinateSystemPropertyValue ( const char *  propertyName,
NXOpen::CoordinateSystem propertyValue 
)

Sets the coordinate system NXOpen::CoordinateSystem.


Created in NX4.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetDoublePropertyValue ( const NXString propertyName,
double  propertyValue 
)

Sets the double value of the property.


Created in NX4.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetDoublePropertyValue ( const char *  propertyName,
double  propertyValue 
)

Sets the double value of the property.


Created in NX4.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetFieldWrapperPropertyValue ( const NXString propertyName,
NXOpen::Fields::FieldWrapper propertyValue 
)

Sets the field wrapper NXOpen::Fields::FieldWrapper.


Created in NX6.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetFieldWrapperPropertyValue ( const char *  propertyName,
NXOpen::Fields::FieldWrapper propertyValue 
)

Sets the field wrapper NXOpen::Fields::FieldWrapper.


Created in NX6.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetFileReferencePropertyValue ( const NXString propertyName,
const NXString propertyValue 
)

Sets the file reference value of the property.


Created in NX12.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetFileReferencePropertyValue ( const char *  propertyName,
const char *  propertyValue 
)

Sets the file reference value of the property.


Created in NX12.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetIntegerArrayPropertyValue ( const NXString propertyName,
const std::vector< int > &  propertyValue 
)

Sets the integer array value of the property.


Created in NX5.0.0.

License requirements : None

Parameters
propertyNameproperty name
propertyValueproperty value
void NXOpen::BasePropertyTable::SetIntegerArrayPropertyValue ( const char *  propertyName,
const std::vector< int > &  propertyValue 
)

Sets the integer array value of the property.


Created in NX5.0.0.

License requirements : None

Parameters
propertyNameproperty name
propertyValueproperty value
void NXOpen::BasePropertyTable::SetIntegerPropertyValue ( const NXString propertyName,
int  propertyValue 
)

Sets the integer value of the property.


Created in NX4.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetIntegerPropertyValue ( const char *  propertyName,
int  propertyValue 
)

Sets the integer value of the property.


Created in NX4.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetMaterialPropertyValue ( const NXString propertyName,
bool  materialInherited,
NXOpen::PhysicalMaterial material 
)

Sets the material value.


Created in NX6.0.3.

License requirements : None

Parameters
propertyNamename of the property
materialInheritedtrue indicate the material is inherited from referenced object assignments such as geometry
materialthe material value to assign
void NXOpen::BasePropertyTable::SetMaterialPropertyValue ( const char *  propertyName,
bool  materialInherited,
NXOpen::PhysicalMaterial material 
)

Sets the material value.


Created in NX6.0.3.

License requirements : None

Parameters
propertyNamename of the property
materialInheritedtrue indicate the material is inherited from referenced object assignments such as geometry
materialthe material value to assign
void NXOpen::BasePropertyTable::SetMatrixPropertyValue ( const NXString propertyName,
NXOpen::ScalarMatrixValue matrix 
)

Set a matrix cell value from the matrix value of the property.


Created in NX6.0.0.

License requirements : None

Parameters
propertyNamename of the property
matrixNxM Scalar matrix
void NXOpen::BasePropertyTable::SetMatrixPropertyValue ( const char *  propertyName,
NXOpen::ScalarMatrixValue matrix 
)

Set a matrix cell value from the matrix value of the property.


Created in NX6.0.0.

License requirements : None

Parameters
propertyNamename of the property
matrixNxM Scalar matrix
void NXOpen::BasePropertyTable::SetScalarArrayPropertyValue ( const NXString propertyName,
const std::vector< double > &  propertyValue 
)

Sets the scalar array value of the property.

Use NXOpen::BasePropertyTable::SetScalarArrayWithUnitsPropertyValue when other than base units are set.


Created in NX5.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetScalarArrayPropertyValue ( const char *  propertyName,
const std::vector< double > &  propertyValue 
)

Sets the scalar array value of the property.

Use NXOpen::BasePropertyTable::SetScalarArrayWithUnitsPropertyValue when other than base units are set.


Created in NX5.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetScalarArrayWithUnitsPropertyValue ( const NXString propertyName,
const std::vector< double > &  propertyValue,
NXOpen::Unit unitType 
)

Sets the scalar array and unit value of the property.


Created in NX7.5.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
unitTypeUnit type for the Array
void NXOpen::BasePropertyTable::SetScalarArrayWithUnitsPropertyValue ( const char *  propertyName,
const std::vector< double > &  propertyValue,
NXOpen::Unit unitType 
)

Sets the scalar array and unit value of the property.


Created in NX7.5.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
unitTypeUnit type for the Array
void NXOpen::BasePropertyTable::SetScalarFieldWrapperByIndex ( int  iRow,
int  iCol,
const NXString propertyName,
NXOpen::Fields::ScalarFieldWrapper propertyValue 
)

Sets the scalar field wrapper NXOpen::Fields::ScalarFieldWrapper.


Created in NX11.0.0.

License requirements : None

Parameters
iRowrow number
iColcol number
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetScalarFieldWrapperByIndex ( int  iRow,
int  iCol,
const char *  propertyName,
NXOpen::Fields::ScalarFieldWrapper propertyValue 
)

Sets the scalar field wrapper NXOpen::Fields::ScalarFieldWrapper.


Created in NX11.0.0.

License requirements : None

Parameters
iRowrow number
iColcol number
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetScalarFieldWrapperPropertyValue ( const NXString propertyName,
NXOpen::Fields::ScalarFieldWrapper propertyValue 
)

Sets the scalar field wrapper NXOpen::Fields::ScalarFieldWrapper.


Created in NX6.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetScalarFieldWrapperPropertyValue ( const char *  propertyName,
NXOpen::Fields::ScalarFieldWrapper propertyValue 
)

Sets the scalar field wrapper NXOpen::Fields::ScalarFieldWrapper.


Created in NX6.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetScalarPropertyValue ( const NXString propertyName,
NXOpen::Expression propertyValue 
)

Sets the expression NXOpen::Expression value of the property Use NXOpen::BasePropertyTable::SetBaseScalarWithDataPropertyValue for a constant value when an expression NXOpen::Expression is not needed.


Created in NX4.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetScalarPropertyValue ( const char *  propertyName,
NXOpen::Expression propertyValue 
)

Sets the expression NXOpen::Expression value of the property Use NXOpen::BasePropertyTable::SetBaseScalarWithDataPropertyValue for a constant value when an expression NXOpen::Expression is not needed.


Created in NX4.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetScalarTablePropertyValue ( const NXString propertyName,
NXOpen::ScalarTableValue table 
)

Set a scalar table value from the scalar table value of the property.


Created in NX6.0.0.

License requirements : None

Parameters
propertyNamename of the property
tableNxM Scalar table
void NXOpen::BasePropertyTable::SetScalarTablePropertyValue ( const char *  propertyName,
NXOpen::ScalarTableValue table 
)

Set a scalar table value from the scalar table value of the property.


Created in NX6.0.0.

License requirements : None

Parameters
propertyNamename of the property
tableNxM Scalar table
void NXOpen::BasePropertyTable::SetStringPropertyValue ( const NXString propertyName,
const NXString propertyValue 
)

Sets the string value of the property.


Created in NX4.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetStringPropertyValue ( const char *  propertyName,
const char *  propertyValue 
)

Sets the string value of the property.


Created in NX4.0.0.

License requirements : None

Parameters
propertyNamename of the property
propertyValuevalue of the property
void NXOpen::BasePropertyTable::SetTablePropertyOverride ( const NXString propertyName)

Set property override flag.


Created in NX9.0.0.

License requirements : None

Parameters
propertyNamename of the property
void NXOpen::BasePropertyTable::SetTablePropertyOverride ( const char *  propertyName)

Set property override flag.


Created in NX9.0.0.

License requirements : None

Parameters
propertyNamename of the property
void NXOpen::BasePropertyTable::SetTablePropertyWithoutValue ( const NXString propertyName)

Unset a property.

Cause a property to be output to the solver as a blank so that the solver uses its default value


Created in NX7.5.0.

License requirements : None

Parameters
propertyNamename of the property
void NXOpen::BasePropertyTable::SetTablePropertyWithoutValue ( const char *  propertyName)

Unset a property.

Cause a property to be output to the solver as a blank so that the solver uses its default value


Created in NX7.5.0.

License requirements : None

Parameters
propertyNamename of the property

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