Canonical path: NemAll_Python_BaseElements.AttributeService
Service for reading existing attributes definitions and creating new user-defined attributes
Classes:
-
AttributeControlType–Available types of input controls for entering an attribute value
-
AttributeSelectionDialogType–Possible options of which attributes should be shown in an attribute selection dialog
-
AttributeType–Attribute types
Methods:
-
AddUserAttribute–Add a user attribute
-
GetAttributeControlType–Get the control type of the attribute
-
GetAttributeID–Get the attribute ID
-
GetAttributeName–Get the attribute name
-
GetAttributeType–Get the attribute type
-
GetAttributeUnit–Get the attribute unit
-
GetDefaultValue–Get the default value of an attribute
-
GetEnumIDFromValueString–Get the enumeration ID from the value string
-
GetEnumValueStringFromID–Get the enumeration value string from the enumeration ID
-
GetEnumValues–Get the enum attribute values
-
GetGroupAttributeIDs–Get the attribute IDs and the name of the attribute groups
-
GetInputListValues–Get the input list values
-
OpenAttributeSelectionDialog–Open the attribute selection dialog
Canonical path: NemAll_Python_BaseElements.AttributeService.AttributeControlType
Bases: Enum
Available types of input controls for entering an attribute value
Methods:
-
__getitem__–get the item for a key
Attributes:
-
Calculate–Option for creating a formula attribute, with deactivated input field.
-
CheckBox–Check box for true/false attribute
-
ComboBox–Combo box with proposed values, where user can also insert a custom value
-
ComboBoxFilling–Combo box for filling selection
-
ComboBoxFixed–Combo box with allowed values. Custom values are not possible
-
ComboBoxHatch–Combo box for hatch selection
-
ComboBoxPattern–Combo box for pattern selection
-
Edit–Simple edit field
-
Undef–Undefined
class-attribute
instance-attribute
Option for creating a formula attribute, with deactivated input field.
class-attribute
instance-attribute
Combo box with proposed values, where user can also insert a custom value
class-attribute
instance-attribute
Combo box for filling selection
class-attribute
instance-attribute
Combo box with allowed values. Custom values are not possible
class-attribute
instance-attribute
Combo box for pattern selection
__getitem__(key: str | int | float) -> AttributeControlType
get the item for a key
Parameters:
-
key(str | int | float) –value key
Returns:
-
AttributeControlType–value for the key
Canonical path: NemAll_Python_BaseElements.AttributeService.AttributeSelectionDialogType
Bases: Enum
Possible options of which attributes should be shown in an attribute selection dialog
Methods:
-
__getitem__–get the item for a key
Attributes:
-
eAllAttributes–Show all attributes
-
eInsertAttributes–Show only attributes, where a value can be entered by the user. Internally calculated attributes are not shown.
-
eProjectAttributes–Show only project-specific attributes
class-attribute
instance-attribute
Show only attributes, where a value can be entered by the user. Internally calculated attributes are not shown.
class-attribute
instance-attribute
Show only project-specific attributes
__getitem__(key: str | int | float) -> AttributeSelectionDialogType
get the item for a key
Parameters:
-
key(str | int | float) –value key
Returns:
-
AttributeSelectionDialogType–value for the key
Canonical path: NemAll_Python_BaseElements.AttributeService.AttributeType
Bases: Enum
Attribute types
Methods:
-
__getitem__–get the item for a key
Attributes:
-
ByteVec–Byte vector
-
Date–Date
-
Double–Floating point value
-
DoubleVec–Vector of floating point values
-
Enum–Enumeration
-
Integer–Integer
-
IntegerVec–Vector of integers
-
String–String
-
StringVec–Vector of strings
-
Undef–Undefined
-
WString–Unicode string
__getitem__(key: str | int | float) -> AttributeType
get the item for a key
Parameters:
-
key(str | int | float) –value key
Returns:
-
AttributeType–value for the key
staticmethod
AddUserAttribute(
doc: DocumentAdapter,
attributeType: AttributeType,
attributeName: str,
attributeDefaultValue: str,
attributeMinValue: float,
attributeMaxValue: float,
attributeDimension: str,
attributeCtrlType: AttributeControlType,
attributeListValues: VecStringList,
) -> int
Add a user attribute
Parameters:
-
doc(DocumentAdapter) –Document
-
attributeType(AttributeType) –Type
-
attributeName(str) –Name
-
attributeDefaultValue(str) –Default value
-
attributeMinValue(float) –Minimal value
-
attributeMaxValue(float) –Maximal value
-
attributeDimension(str) –Dimension
-
attributeCtrlType(AttributeControlType) –Control type
-
attributeListValues(VecStringList) –List with the allowed attribute values
Returns:
-
int–ID of the added user attribute, -1 = not possible to add
staticmethod
GetAttributeControlType(
doc: DocumentAdapter, attributeID: int
) -> AttributeControlType
Get the control type of the attribute
Parameters:
-
doc(DocumentAdapter) –Document
-
attributeID(int) –Attribute ID
Returns:
-
AttributeControlType–Control type of the attribute
staticmethod
GetAttributeID(doc: DocumentAdapter, attributeName: str) -> int
Get the attribute ID
Parameters:
-
doc(DocumentAdapter) –Document
-
attributeName(str) –Attribute name
Returns:
-
int–Attribute ID
staticmethod
GetAttributeName(doc: DocumentAdapter, attributeID: int) -> str
Get the attribute name
Parameters:
-
doc(DocumentAdapter) –Document
-
attributeID(int) –Attribute ID
Returns:
-
str–Attribute name
staticmethod
GetAttributeType(doc: DocumentAdapter, attributeID: int) -> AttributeType
Get the attribute type
Parameters:
-
doc(DocumentAdapter) –Document
-
attributeID(int) –Attribute ID
Returns:
-
AttributeType–Attribute type
staticmethod
GetAttributeUnit(doc: DocumentAdapter, attributeID: int) -> str
Get the attribute unit
Parameters:
-
doc(DocumentAdapter) –Document
-
attributeID(int) –Attribute ID
Returns:
-
str–Attribute unit
staticmethod
GetDefaultValue(doc: DocumentAdapter, attributeID: int) -> int | float | str
Get the default value of an attribute
Parameters:
-
doc(DocumentAdapter) –Document
-
attributeID(int) –Attribute ID
Returns:
-
int | float | str–Default value of the attribute
staticmethod
Get the enumeration ID from the value string
Parameters:
-
attributeID(int) –Attribute ID
-
valueString(str) –Value string
Returns:
-
int–Enumeration ID
staticmethod
Get the enumeration value string from the enumeration ID
Parameters:
-
attributeID(int) –Attribute ID
-
enumID(int) –Enumeration ID
Returns:
-
str–Enumeration value string
staticmethod
GetEnumValues(doc: DocumentAdapter, attributeID: int) -> VecStringList
Get the enum attribute values
Parameters:
-
doc(DocumentAdapter) –Document
-
attributeID(int) –Attribute ID
Returns:
-
VecStringList–Default attribute value
staticmethod
GetGroupAttributeIDs(
ele: BaseElementAdapter,
attributes: list[tuple[int, int | float | str]],
excludeHidden: bool,
) -> list[tuple[str, list[int] | VecIntList]]
Get the attribute IDs and the name of the attribute groups
Parameters:
-
ele(BaseElementAdapter) –Element for the attributes
-
attributes(list[tuple[int, int | float | str]]) –Attributes of the element
-
excludeHidden(bool) –Exclude the hidden attributes
Returns:
-
list[tuple[str, list[int] | VecIntList]]–Group name, group IDs
staticmethod
GetInputListValues(doc: DocumentAdapter, attributeID: int) -> VecStringList
Get the input list values
Parameters:
-
doc(DocumentAdapter) –Document
-
attributeID(int) –Attribute ID
Returns:
-
VecStringList–Attribute input list values
staticmethod
OpenAttributeSelectionDialog(
doc: DocumentAdapter, dialogType: AttributeSelectionDialogType
) -> int
Open the attribute selection dialog
Parameters:
-
doc(DocumentAdapter) –Document
-
dialogType(AttributeSelectionDialogType) –Dialog type
Returns:
-
int–Attribute ID