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

OnAttributeModify (self, obj, attr, value, oldValue, units)
activateListener (self, obj)
castForGet (self, obj, value)
castForSet (self, obj, value)
create (self, obj)
createList (self, obj)
createListList (self, obj)
deactivateListener (self, obj)
disable (self, obj)
enable (self, obj)
getGuiValue (self, obj)
getInCoreValue (self, obj)
getReferences (self, obj)
getType (self, obj)
getValue (self, obj)
getValueList (self, obj)
getValueListList (self, obj)
setValue (self, obj, value)
setValueList (self, obj, value)
setValueListList (self, obj, value)

Method Details

OnAttributeModify(self, obj, attr, value, oldValue, units)

Callback method when the reference gets modified.

activateListener(self, obj)

Listen to referenced object for any changes.

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, obj)

Creates a list of references.

createListList(self, obj)

Creates a nested list of references.

deactivateListener(self, obj)

Stop listening to referenced objects.

disable(self, obj)

Disables listener for the reference object.

enable(self, obj)

Enables listener for the reference object.

getGuiValue(self, obj)

Returns the reference value as a string.

getInCoreValue(self, obj)

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

param obj:Object this attribute belongs to.
type obj:GeneralObject
param value:Value of the attribute to get.
type value:Named
returns:Value returned by the incore get method.
rtype:Reference
getReferences(self, obj)

Returns the list of references from the object.

getType(self, obj)

Returns the type of the Reference 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.

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.