DataContainer Class¶
-
class
NXOpen.
DataContainer
¶ Bases:
NXOpen.PropertyContainer
Represents a list of data.
The data is associated with the unique string using which data can be accessed and modified. In addition, new data can be added to the existing container or list. .. versionadded:: NX7.5.0
Properties¶
Property | Description |
---|---|
Length | Returns the length of the list |
Mode | Returns the mode of the list |
Methods¶
Method | Description |
---|---|
AddBits | Adds the bits value in the container. |
AddDouble | Adds the double value in the container. |
AddDoubleMatrix | Adds the double matrix in the container. |
AddDoubleVector | Adds the double vector in the container. |
AddEnum | Adds the enum members in the container. |
AddFile | Adds the value in the container. |
AddInteger | Adds the integer value in the container. |
AddIntegerMatrix | Adds the integer matrix in the container. |
AddIntegerVector | Adds the integer vector in the container. |
AddLogical | Adds the logical value in the container. |
AddPoint | Adds the point value in the container. |
AddString | Adds the string value in the container. |
AddStrings | Adds the strings value in the container. |
AddTaggedObject | Adds the tagged object in the container. |
AddTaggedObjectVector | Adds the tagged object vector in the container. |
AddVector | Adds the vector value in the container. |
Dispose | Frees the object from memory. |
GetArray | Gets the value for the given property name. |
GetBits | Gets the bits value for the given property name. |
GetDouble | Gets the double value for the given property name. |
GetDoubleMatrix | Gets the double matrix for the given property name. |
GetDoubleVector | Gets the double vector for the given property name. |
GetEnum | Gets the value for the given property name. |
GetEnumAsString | Gets the value for the given property name. |
GetEnumMembers | Gets the enum members for the given property of type enum. |
GetFile | Gets the value for the given property name. |
GetInteger | Gets the integer value for the given property name. |
GetIntegerMatrix | Gets the integer matrix for the given property name. |
GetIntegerVector | Gets the integer vector for the given property name. |
GetLogical | Gets the logical value for the given property name. |
GetPoint | Gets the point value for the given property name. |
GetPropertyNames | Returns a list of all the property names @return Property names |
GetPropertyType | Returns the property type for given property name @return Property type. |
GetString | Gets the string value for the given property name. |
GetStrings | Gets the strings value for the given property name. |
GetTaggedObject | Gets the tagged object for the given property name. |
GetTaggedObjectVector | Gets the tagged object vector for the given property name. |
GetVector | Gets the vector value for the given property name. |
SetBits | Sets the bits value for the given property name. |
SetDouble | Sets the double value for the given property name. |
SetDoubleMatrix | Sets the double matrix for the given property name. |
SetDoubleVector | Sets the double vector for the given property name. |
SetEnum | Sets the value for the given property name. |
SetEnumAsString | Sets the value for the given property name. |
SetEnumMembers | Sets the enum members for the given property of type enum. |
SetFile | Sets the value for the given property name. |
SetInteger | Sets the integer value for the given property name. |
SetIntegerMatrix | Sets the integer matrix for the given property name. |
SetIntegerVector | Sets the integer vector for the given property name. |
SetLogical | Sets the logical value for the given property name. |
SetPoint | Sets the point value for the given property name. |
SetString | Sets the string value for the given property name. |
SetStrings | Sets the strings value for the given property name. |
SetTaggedObject | Sets the tagged object for the given property name. |
SetTaggedObjectVector | Sets the tagged object vector for the given property name. |
SetVector | Sets the vector value for the given property name. |
Method Detail¶
AddBits¶
-
DataContainer.
AddBits
¶ Adds the bits value in the container.
The value is associated with the unique property name.
Signature
AddBits(propertyName, bitsSc)
Parameters: - propertyName (str) – Name of the property.
- bitsSc (int) – Value to add for given property name.
New in version NX7.5.0.
License requirements: None.
AddDouble¶
-
DataContainer.
AddDouble
¶ Adds the double value in the container.
The value is associated with the unique property name.
Signature
AddDouble(propertyName, value)
Parameters: - propertyName (str) – Name of the property.
- value (float) – Value to add for given property name.
New in version NX7.5.0.
License requirements: None.
AddDoubleMatrix¶
-
DataContainer.
AddDoubleMatrix
¶ Adds the double matrix in the container.
The value is associated with the unique property name. This is a two dimensional array encoded into a single array.
Signature
AddDoubleMatrix(propertyName, nRows, nColumns, matrixValue)
Parameters: - propertyName (str) – Name of the property.
- nRows (int) – Number of Rows in the 2D matrix
- nColumns (int) – Number of Columns in the 2D matrix
- matrixValue (list of float) – Value to add for given property name.
New in version NX7.5.0.
License requirements: None.
AddDoubleVector¶
-
DataContainer.
AddDoubleVector
¶ Adds the double vector in the container.
The value is associated with the unique property name.
Signature
AddDoubleVector(propertyName, doubleVector)
Parameters: - propertyName (str) – Name of the property.
- doubleVector (list of float) – Value to add for given property name.
New in version NX7.5.3.
License requirements: None.
AddEnum¶
-
DataContainer.
AddEnum
¶ Adds the enum members in the container.
The enum is associated with the unique property name.
Signature
AddEnum(propertyName, stringArray)
Parameters: - propertyName (str) – Name of the property.
- stringArray (list of str) – Value to add for given property name.
New in version NX7.5.0.
License requirements: None.
AddFile¶
-
DataContainer.
AddFile
¶ Adds the value in the container.
The value is associated with the unique property name.
Signature
AddFile(propertyName, value)
Parameters: - propertyName (str) – Name of the property.
- value (str) – Value to add for given property name.
New in version NX7.5.0.
License requirements: None.
AddInteger¶
-
DataContainer.
AddInteger
¶ Adds the integer value in the container.
The value is associated with the unique property name.
Signature
AddInteger(propertyName, value)
Parameters: - propertyName (str) – Name of the property.
- value (int) – Value to add for given property name
New in version NX7.5.0.
License requirements: None.
AddIntegerMatrix¶
-
DataContainer.
AddIntegerMatrix
¶ Adds the integer matrix in the container.
The value is associated with the unique property name. This is a two dimensional array encoded into a single array.
Signature
AddIntegerMatrix(propertyName, nRows, nColumns, matrixValue)
Parameters: - propertyName (str) – Name of the property.
- nRows (int) – Number of Rows in the 2D matrix
- nColumns (int) – Number of Columns in the 2D matrix
- matrixValue (list of int) – Value to add for given property name.
New in version NX7.5.0.
License requirements: None.
AddIntegerVector¶
-
DataContainer.
AddIntegerVector
¶ Adds the integer vector in the container.
The value is associated with the unique property name.
Signature
AddIntegerVector(propertyName, intVector)
Parameters: - propertyName (str) – Name of the property.
- intVector (list of int) – Value to add for given property name.
New in version NX7.5.0.
License requirements: None.
AddLogical¶
-
DataContainer.
AddLogical
¶ Adds the logical value in the container.
The value is associated with the unique property name.
Signature
AddLogical(propertyName, value)
Parameters: - propertyName (str) – Name of the property.
- value (bool) – Value to add for given property name.
New in version NX7.5.0.
License requirements: None.
AddPoint¶
-
DataContainer.
AddPoint
¶ Adds the point value in the container.
The value is associated with the unique property name.
Signature
AddPoint(propertyName, pointSc)
Parameters: - propertyName (str) – Name of the property.
- pointSc (
NXOpen.Point3d
) – Value to add for given property name.
New in version NX7.5.0.
License requirements: None.
AddString¶
-
DataContainer.
AddString
¶ Adds the string value in the container.
The value is associated with the unique property name.
Signature
AddString(propertyName, value)
Parameters: - propertyName (str) – Name of the property.
- value (str) – Value to add for given property name.
New in version NX7.5.0.
License requirements: None.
AddStrings¶
-
DataContainer.
AddStrings
¶ Adds the strings value in the container.
The value is associated with the unique property name.
Signature
AddStrings(propertyName, stringArray)
Parameters: - propertyName (str) – Name of the property.
- stringArray (list of str) – Value to add for given property name.
New in version NX7.5.0.
License requirements: None.
AddTaggedObject¶
-
DataContainer.
AddTaggedObject
¶ Adds the tagged object in the container.
The added object is associated with the unique property name.
Signature
AddTaggedObject(propertyName, taggedSc)
Parameters: - propertyName (str) – Name of the property.
- taggedSc (
NXOpen.TaggedObject
) – Value to add for given property name.
New in version NX7.5.0.
License requirements: None.
AddTaggedObjectVector¶
-
DataContainer.
AddTaggedObjectVector
¶ Adds the tagged object vector in the container.
The value is associated with the unique property name.
Signature
AddTaggedObjectVector(propertyName, tagVector)
Parameters: - propertyName (str) – Name of the property.
- tagVector (list of
NXOpen.TaggedObject
) – Value to add for given property name.
New in version NX7.5.0.
License requirements: None.
AddVector¶
-
DataContainer.
AddVector
¶ Adds the vector value in the container.
The value is associated with the unique property name.
Signature
AddVector(propertyName, vector)
Parameters: - propertyName (str) – Name of the property
- vector (
NXOpen.Vector3d
) – Value to add for given property name.
New in version NX7.5.0.
License requirements: None.