Reference (hwx.inspire.core)

Store a Named entity or Feature.

Use List or ListOfList(Reference) to store multiple values.

Default for references is not currently supported.

Public Methods

classmethod apply (cls, **kwds)

castForGet (self, obj, value)

castForSet (self, obj, value)

create (self, obj)

createList (self, listAttr, obj)

createListList (self, listAttr, obj)

disable (self, obj)

enable (self, obj)

getCreateArgs (self)

getDisplayName (self, obj)

getGuiValue (self, obj)

getInCoreValue (self, obj)

getReferences (self, obj)

getType (self, obj)

getUnits (self, obj)

getValue (self, obj)

getValueList (self, obj)

getValueListList (self, obj)

initialize (self, objCls, name)

loadValue (self, obj, value)

setInCoreValue (self, obj, value)

setValue (self, obj, value)

setValueList (self, obj, value)

setValueListList (self, obj, value)

Method Details

classmethod apply(cls, **kwds)

Context manager to specify Attribute constructor kwds Useful to avoid repeating kwds while defining a related group

castForGet(self, obj, value)

Converts and returns the reference value to its external type.

param obj

Object this attribute belongs to.

type obj

GeneralObject

param value

Value of the attribute to be converted.

type value

Named

returns

Converted value.

rtype

Named | Feature

castForSet(self, obj, value)

Converts and validates the reference values before setting.

param obj

Object this attribute belongs to.

type obj

GeneralObject

param value

Value of the attribute to set.

type value

Material, Part, Feature, Named

returns

Validated and converted value.

rtype

Reference

create(self, obj)

Creates a reference attribute of the specified object.

createList(self, listAttr, obj)

Creates a list of references.

createListList(self, listAttr, obj)

Creates a nested list of references.

disable(self, obj)

Disables the attribute.

enable(self, obj)

Enables the attribute.

getCreateArgs(self)

Helper used in create methods

getDisplayName(self, obj)

Returns the display name of the attribute.

Display name is used show the objects attribute name in the Property editor.

getGuiValue(self, obj)

Returns the reference value as a string.

getInCoreValue(self, obj)

Calls the incore get method (defined in C++) of the attribute.

param obj

Object this attribute belongs to.

type obj

GeneralObject

param value

Value of the attribute to get.

type value

Any

returns

Value returned by the incore get method.

rtype

Any

getReferences(self, obj)

Returns the list of references from the object.

getType(self, obj)

Returns the type of the Reference attribute.

getUnits(self, obj)

Returns the units of the attribute.

getValue(self, obj)

Returns the reference value.

getValueList(self, obj)

Returns the list of references.

getValueListList(self, obj)

Returns the nested list of references.

initialize(self, objCls, name)

Initializes the attribute.

param objCls

Object class this attribute belongs to.

type objCls

class

param name

Name of the attribute.

type name

str

loadValue(self, obj, value)

Loads and sets the value, when a model is loaded.

setInCoreValue(self, obj, value)

Calls the incore set method (defined in C++) of the attribute.

param obj

Object this attribute belongs to.

type obj

GeneralObject

param value

Value of the attribute to set.

type value

Any

setValue(self, obj, value)

Sets the specified reference value.

setValueList(self, obj, value)

Sets the specified list of references.

setValueListList(self, obj, value)

Sets the specified nested list of references.