Murl Engine Lua Addon API  Version 1.0 beta
Murl.IAttributes

The XML attributes interface.

The attributes interface provides XML attributes name and value information.
Names can be separated by a "dot syntax" e.g. position.x="14" position.y="15".
Attribute can use multiple values separated by "," e.g. digits="one, two, three".
Attribute values can be substitued by using attribute names in braces e.g. size="{myAttribute}".


Table members

Methods


Clear()

Clear all attributes.

Boolean Clear()

Returns
Boolean true if successful.

AddDefaults(defaultAttributes)

Add a set of default attributes for named queries.

Boolean AddDefaults(Murl.IAttributes defaultAttributes)

Parameters
defaultAttributesThe default attributes object to add.
Returns
Boolean true if successful, false if the given object was already added or the container does not allow to add defaults.

GetNumberOfDefaults()

Get the number of default attribute sets added via AddDefaults().

Integer GetNumberOfDefaults()

Returns
Integer The number of default attribute sets.

GetDefaults(index)

Get the default attribute set at a given index.

Murl.IAttributes GetDefaults(Integer index)

Parameters
indexThe index, from 0 to GetNumberOfDefaults()-1.
Returns
Murl.IAttributes The default attribute set, or null if index is out of range.

AddAttribute(fullName, value)

Add a single attribute name and value.

Boolean AddAttribute(String fullName, String value)

Parameters
fullNameThe full name of the attribute (including the dots).
valueThe value of the attribute.
Returns
Boolean true if successful, false if the name already exists.

SetAttribute(fullName, value)

Set a value for a named attribute. Sets the attribute to unused state.

Boolean SetAttribute(String fullName, String value)

Parameters
fullNameThe full name of the attribute (including the dots).
valueThe value of the attribute.
Returns
Boolean true if successful, false if the name does not exist.

GetNumberOfAttributes()

Get the number of attributes. Attributes are organized using an index and a level number to support the "dot syntax" native.
e.g. a="7" e.f="9" b.c.d="8" e.g="10"

  • The number of attributes is 6.
  • "a" has index 0 and level 0, value is "7".
  • "e" has index 1 and level 0, value is "null".
  • "f" has index 2 and level 1, value is "9".
  • "b" has index 3 and level 0, value is null.
  • "c" has index 4 and level 1, value is null.
  • "d" has index 5 and level 2, value is "8".
  • "g" has index 6 and level 1, value is "10".

The parents can be accessed by decreasing the level.

  • "b" can be found at index 4 and level 0.
  • "b" can be found at index 5 and level 0.
  • "c" can be found at index 5 and level 1.
  • "e" can be found at index 2 and level 0.
  • "e" can be found at index 6 and level 0.

Integer GetNumberOfAttributes()

Returns
Integer The number of attributes.

GetAttributeHash(index, level)

Get the hash of an attribute name.

Integer GetAttributeHash(Integer index, Integer level)

Parameters
indexThe index of the attribute.
levelThe level of the attribute.
Returns
Integer The hash value of the attribute name.

GetAttributeName(index, level)

Get the name of an attribute.

String GetAttributeName(Integer index, Integer level)

Parameters
indexThe index of the attribute.
levelThe level of the attribute.
Returns
String The name of the attribute or null if index / level is out of range.

GetAttributeValue(index, level)

Get the value of an attribute.

String GetAttributeValue(Integer index, Integer level)

Parameters
indexThe index of the attribute.
levelThe level of the attribute.
Returns
String The value of the attribute or null if the attribute has no value or if index / level is out of range.

GetFullAttributeName(index)

Get the full name of an attribute. The full name includes all parent attributes separated by dots.

String GetFullAttributeName(Integer index)

Parameters
indexThe index of the attribute.
Returns
String The name of the attribute or an empty string if index is out of range.

GetFullAttributeValue(index)

Get the value of an attribute (ignoring the level).

String GetFullAttributeValue(Integer index)

Parameters
indexThe index of the attribute.
Returns
String The value of the attribute or null if the attribute has no value or if index is out of range.

GetAttributeIndex(name)

Get the index of an attribute name at level 0.

Integer GetAttributeIndex(String name)

Parameters
nameThe name of the attribute.
Returns
Integer The index of the attribute or -1 if the name at level 0 does not exist.

GetFullAttributeIndex(fullName)

Get the index of a fully qualified attribute.

Integer GetFullAttributeIndex(String fullName)

Parameters
fullNameThe full name of the attribute, including separating dots.
Returns
Integer The index of the attribute or -1 if the given name does not exist.

GetAttributeParent(index)

Get the parent index of an attribute.

Integer GetAttributeParent(Integer index)

Parameters
indexThe index of the attribute.
Returns
Integer The parent index of the attribute or -1 if the attribute has no parent or if index is out of range.

GetAttributeLevel(index)

Get the level of an attribute.

Integer GetAttributeLevel(Integer index)

Parameters
indexThe index of the attribute.
Returns
Integer The level of the attribute.

IsAttributeUsed(index)

Check if the attribute is used. The attribute used state is set when calling one if the GetValue...() methods was successful.

Boolean IsAttributeUsed(Integer index)

Parameters
indexThe index of the attribute.
Returns
Boolean true if the attribute is used.

HasAttributeValue(index)

Check if the attribute has a value.

Boolean HasAttributeValue(Integer index)

Parameters
indexThe index of the attribute.
Returns
Boolean true if the attribute has a value.

GetNumberOfUnusedAttributes()

Get the number of unused attributes.

Integer GetNumberOfUnusedAttributes()

Returns
Integer The number of unused attributes.

GetUnusedAttributeNames(names)

Get the names of unused attributes.

Boolean, Murl.Array.String GetUnusedAttributeNames(Murl.Array.String names)

Parameters
namesThe string array to add the names.
Returns
Boolean true if names were added.
Murl.Array.String names The string array to add the names.

SetAllAttributesUsed()

Set all attributes to used state.

Boolean SetAllAttributesUsed()

Returns
Boolean true if successful.

EvaluateExpression(expression, value, error)

Evaluate an expression string.

Boolean, String, Boolean EvaluateExpression(String expression, String value, Boolean error)

Parameters
expressionThe expression string to evaluate.
valueA reference to a string receiving the result if successful.
errorThe error return value is set to true if evaluation failed.
Returns
Boolean true if successful.
String value A reference to a string receiving the result if successful.
Boolean error The error return value is set to true if evaluation failed.

EvaluateExpression(expression, value, result)

Evaluate an expression string.

Boolean, String, Murl.Result EvaluateExpression(String expression, String value, Murl.Result result)

Parameters
expressionThe expression string to evaluate.
valueA reference to a string receiving the result if successful.
resultAn error message is appended to this object if evaluation failed.
Returns
Boolean true if successful.
String value A reference to a string receiving the result if successful.
Murl.Result result An error message is appended to this object if evaluation failed.

GetValueByIndex(index, params, value, error)

Get the unsigned integer value of an attribute by index.

Boolean, Integer, Boolean GetValueByIndex(Integer index, Murl.IAttributes params, Integer value, Boolean error)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe unsigned integer return value.
errorThe error return value is set to true if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Integer value The unsigned integer return value.
Boolean error The error return value is set to true if data conversion failed.

GetValueByIndex(index, params, value, result)

Get the unsigned integer value of an attribute by index.

Boolean, Integer, Murl.Result GetValueByIndex(Integer index, Murl.IAttributes params, Integer value, Murl.Result result)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe unsigned integer return value.
resultAn error message is appended to this object if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Integer value The unsigned integer return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValueByIndex(index, params, value, error)

Get the string value of an attribute by index.

Boolean, String, Boolean GetValueByIndex(Integer index, Murl.IAttributes params, String value, Boolean error)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe string return value.
errorThe error return value is set to true if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
String value The string return value.
Boolean error The error return value is set to true if data conversion failed.

GetValueByIndex(index, params, value, result)

Get the string value of an attribute by index.

Boolean, String, Murl.Result GetValueByIndex(Integer index, Murl.IAttributes params, String value, Murl.Result result)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe string return value.
resultAn error message is appended to this object if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
String value The string return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValueByIndex(index, params, value, error)

Get the boolean value of an attribute by index.

Boolean, Boolean, Boolean GetValueByIndex(Integer index, Murl.IAttributes params, Boolean value, Boolean error)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe boolean return value.
errorThe error return value is set to true if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Boolean value The boolean return value.
Boolean error The error return value is set to true if data conversion failed.

GetValueByIndex(index, params, value, result)

Get the boolean value of an attribute by index.

Boolean, Boolean, Murl.Result GetValueByIndex(Integer index, Murl.IAttributes params, Boolean value, Murl.Result result)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe boolean return value.
resultAn error message is appended to this object if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Boolean value The boolean return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValueByIndex(index, params, value, error)

Get the color value of an attribute by index.

Boolean, Murl.Color, Boolean GetValueByIndex(Integer index, Murl.IAttributes params, Murl.Color value, Boolean error)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe color return value.
errorThe error return value is set to true if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Color value The color return value.
Boolean error The error return value is set to true if data conversion failed.

GetValueByIndex(index, params, value, result)

Get the color value of an attribute by index.

Boolean, Murl.Color, Murl.Result GetValueByIndex(Integer index, Murl.IAttributes params, Murl.Color value, Murl.Result result)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe color return value.
resultAn error message is appended to this object if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Color value The color return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetAngleValueByIndex(index, params, value, error)

Get the angle double value of an attribute by index.

Boolean, Number, Boolean GetAngleValueByIndex(Integer index, Murl.IAttributes params, Number value, Boolean error)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe angle double return value.
errorThe error return value is set to true if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Number value The angle double return value.
Boolean error The error return value is set to true if data conversion failed.

GetAngleValueByIndex(index, params, value, result)

Get the angle double value of an attribute by index.

Boolean, Number, Murl.Result GetAngleValueByIndex(Integer index, Murl.IAttributes params, Number value, Murl.Result result)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe angle double return value.
resultAn error message is appended to this object if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Number value The angle double return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetColorValueByIndex(index, params, value, error)

Get the color component value of an attribute by index.

Boolean, Number, Boolean GetColorValueByIndex(Integer index, Murl.IAttributes params, Number value, Boolean error)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe color component return value.
errorThe error return value is set to true if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Number value The color component return value.
Boolean error The error return value is set to true if data conversion failed.

GetColorValueByIndex(index, params, value, result)

Get the color component value of an attribute by index.

Boolean, Number, Murl.Result GetColorValueByIndex(Integer index, Murl.IAttributes params, Number value, Murl.Result result)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe color component return value.
resultAn error message is appended to this object if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Number value The color component return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValuesByIndex(index, params, values, error, clear)

Get the boolean values of an attribute by index.

Boolean, Murl.Array.Bool, Boolean GetValuesByIndex(Integer index, Murl.IAttributes params, Murl.Array.Bool values, Boolean error, Boolean clear)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe boolean array return value.
errorThe error return value is set to true if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Bool values The boolean array return value.
Boolean error The error return value is set to true if data conversion failed.

GetValuesByIndex(index, params, values, result, clear)

Get the boolean values of an attribute by index.

Boolean, Murl.Array.Bool, Murl.Result GetValuesByIndex(Integer index, Murl.IAttributes params, Murl.Array.Bool values, Murl.Result result, Boolean clear)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe boolean array return value.
resultAn error message is appended to this object if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Bool values The boolean array return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValuesByIndex(index, params, values, error, clear)

Get the double values of an attribute by index.

Boolean, Murl.Array.Double, Boolean GetValuesByIndex(Integer index, Murl.IAttributes params, Murl.Array.Double values, Boolean error, Boolean clear)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe double array return value.
errorThe error return value is set to true if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Double values The double array return value.
Boolean error The error return value is set to true if data conversion failed.

GetValuesByIndex(index, params, values, result, clear)

Get the double values of an attribute by index.

Boolean, Murl.Array.Double, Murl.Result GetValuesByIndex(Integer index, Murl.IAttributes params, Murl.Array.Double values, Murl.Result result, Boolean clear)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe double array return value.
resultAn error message is appended to this object if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Double values The double array return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValuesByIndex(index, params, values, error, clear)

Get the float values of an attribute by index.

Boolean, Murl.Array.Float, Boolean GetValuesByIndex(Integer index, Murl.IAttributes params, Murl.Array.Float values, Boolean error, Boolean clear)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe float array return value.
errorThe error return value is set to true if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Float values The float array return value.
Boolean error The error return value is set to true if data conversion failed.

GetValuesByIndex(index, params, values, result, clear)

Get the float values of an attribute by index.

Boolean, Murl.Array.Float, Murl.Result GetValuesByIndex(Integer index, Murl.IAttributes params, Murl.Array.Float values, Murl.Result result, Boolean clear)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe float array return value.
resultAn error message is appended to this object if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Float values The float array return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValuesByIndex(index, params, values, error, clear)

Get the signed integer values of an attribute by index.

Boolean, Murl.Array.SInt32, Boolean GetValuesByIndex(Integer index, Murl.IAttributes params, Murl.Array.SInt32 values, Boolean error, Boolean clear)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe signed integer array return value.
errorThe error return value is set to true if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.SInt32 values The signed integer array return value.
Boolean error The error return value is set to true if data conversion failed.

GetValuesByIndex(index, params, values, result, clear)

Get the signed integer values of an attribute by index.

Boolean, Murl.Array.SInt32, Murl.Result GetValuesByIndex(Integer index, Murl.IAttributes params, Murl.Array.SInt32 values, Murl.Result result, Boolean clear)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe signed integer array return value.
resultAn error message is appended to this object if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.SInt32 values The signed integer array return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValuesByIndex(index, params, values, error, clear)

Get the string values of an attribute by index.

Boolean, Murl.Array.String, Boolean GetValuesByIndex(Integer index, Murl.IAttributes params, Murl.Array.String values, Boolean error, Boolean clear)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe string array return value.
errorThe error return value is set to true if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.String values The string array return value.
Boolean error The error return value is set to true if data conversion failed.

GetValuesByIndex(index, params, values, result, clear)

Get the string values of an attribute by index.

Boolean, Murl.Array.String, Murl.Result GetValuesByIndex(Integer index, Murl.IAttributes params, Murl.Array.String values, Murl.Result result, Boolean clear)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe string array return value.
resultAn error message is appended to this object if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.String values The string array return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValuesByIndex(index, params, values, error, clear)

Get the unsigned integer values of an attribute by index.

Boolean, Murl.Array.UInt32, Boolean GetValuesByIndex(Integer index, Murl.IAttributes params, Murl.Array.UInt32 values, Boolean error, Boolean clear)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe unsigned integer array return value.
errorThe error return value is set to true if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.UInt32 values The unsigned integer array return value.
Boolean error The error return value is set to true if data conversion failed.

GetValuesByIndex(index, params, values, result, clear)

Get the unsigned integer values of an attribute by index.

Boolean, Murl.Array.UInt32, Murl.Result GetValuesByIndex(Integer index, Murl.IAttributes params, Murl.Array.UInt32 values, Murl.Result result, Boolean clear)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe unsigned integer array return value.
resultAn error message is appended to this object if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.UInt32 values The unsigned integer array return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetAngleValuesByIndex(index, params, values, error, clear)

Get the double angle values of an attribute by index.

Boolean, Murl.Array.Double, Boolean GetAngleValuesByIndex(Integer index, Murl.IAttributes params, Murl.Array.Double values, Boolean error, Boolean clear)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe double array return value.
errorThe error return value is set to true if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Double values The double array return value.
Boolean error The error return value is set to true if data conversion failed.

GetAngleValuesByIndex(index, params, values, result, clear)

Get the double angle values of an attribute by index.

Boolean, Murl.Array.Double, Murl.Result GetAngleValuesByIndex(Integer index, Murl.IAttributes params, Murl.Array.Double values, Murl.Result result, Boolean clear)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe double array return value.
resultAn error message is appended to this object if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Double values The double array return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetAngleValuesByIndex(index, params, values, error, clear)

Get the float angle values of an attribute by index.

Boolean, Murl.Array.Float, Boolean GetAngleValuesByIndex(Integer index, Murl.IAttributes params, Murl.Array.Float values, Boolean error, Boolean clear)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe float array return value.
errorThe error return value is set to true if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Float values The float array return value.
Boolean error The error return value is set to true if data conversion failed.

GetAngleValuesByIndex(index, params, values, result, clear)

Get the float angle values of an attribute by index.

Boolean, Murl.Array.Float, Murl.Result GetAngleValuesByIndex(Integer index, Murl.IAttributes params, Murl.Array.Float values, Murl.Result result, Boolean clear)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe float array return value.
resultAn error message is appended to this object if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Float values The float array return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetBitsToSetByIndex(index, params, value, error)

Get the bit number values of an attribute by index and set the bits.

Boolean, Integer, Boolean GetBitsToSetByIndex(Integer index, Murl.IAttributes params, Integer value, Boolean error)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe bits return value.
errorThe error return value is set to true if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Integer value The bits return value.
Boolean error The error return value is set to true if data conversion failed.

GetBitsToSetByIndex(index, params, value, result)

Get the bit number values of an attribute by index and set the bits.

Boolean, Integer, Murl.Result GetBitsToSetByIndex(Integer index, Murl.IAttributes params, Integer value, Murl.Result result)

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe bits return value.
resultAn error message is appended to this object if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Integer value The bits return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValueByName(name, params, value, error)

Get the unsigned integer value of an attribute by name at level 0.

Boolean, Integer, Boolean GetValueByName(String name, Murl.IAttributes params, Integer value, Boolean error)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe unsigned integer return value.
errorThe error return value is set to true if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Integer value The unsigned integer return value.
Boolean error The error return value is set to true if data conversion failed.

GetValueByName(name, params, value, result)

Get the unsigned integer value of an attribute by name at level 0.

Boolean, Integer, Murl.Result GetValueByName(String name, Murl.IAttributes params, Integer value, Murl.Result result)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe unsigned integer return value.
resultAn error message is appended to this object if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Integer value The unsigned integer return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValueByName(name, params, value, error)

Get the string value of an attribute by name at level 0.

Boolean, String, Boolean GetValueByName(String name, Murl.IAttributes params, String value, Boolean error)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe string return value.
errorThe error return value is set to true if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
String value The string return value.
Boolean error The error return value is set to true if data conversion failed.

GetValueByName(name, params, value, result)

Get the string value of an attribute by name at level 0.

Boolean, String, Murl.Result GetValueByName(String name, Murl.IAttributes params, String value, Murl.Result result)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe string return value.
resultAn error message is appended to this object if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
String value The string return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValueByName(name, params, value, error)

Get the boolean value of an attribute by name at level 0.

Boolean, Boolean, Boolean GetValueByName(String name, Murl.IAttributes params, Boolean value, Boolean error)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe boolean return value.
errorThe error return value is set to true if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Boolean value The boolean return value.
Boolean error The error return value is set to true if data conversion failed.

GetValueByName(name, params, value, result)

Get the boolean value of an attribute by name at level 0.

Boolean, Boolean, Murl.Result GetValueByName(String name, Murl.IAttributes params, Boolean value, Murl.Result result)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe boolean return value.
resultAn error message is appended to this object if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Boolean value The boolean return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValueByName(name, params, value, error)

Get the color value of an attribute by name at level 0.

Boolean, Murl.Color, Boolean GetValueByName(String name, Murl.IAttributes params, Murl.Color value, Boolean error)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe color return value.
errorThe error return value is set to true if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Color value The color return value.
Boolean error The error return value is set to true if data conversion failed.

GetValueByName(name, params, value, result)

Get the color value of an attribute by name at level 0.

Boolean, Murl.Color, Murl.Result GetValueByName(String name, Murl.IAttributes params, Murl.Color value, Murl.Result result)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe color return value.
resultAn error message is appended to this object if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Color value The color return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetAngleValueByName(name, params, value, error)

Get the angle double value of an attribute by name at level 0.

Boolean, Number, Boolean GetAngleValueByName(String name, Murl.IAttributes params, Number value, Boolean error)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe angle double return value.
errorThe error return value is set to true if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Number value The angle double return value.
Boolean error The error return value is set to true if data conversion failed.

GetAngleValueByName(name, params, value, result)

Get the angle double value of an attribute by name at level 0.

Boolean, Number, Murl.Result GetAngleValueByName(String name, Murl.IAttributes params, Number value, Murl.Result result)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe angle double return value.
resultAn error message is appended to this object if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Number value The angle double return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetColorValueByName(name, params, value, error)

Get the color component value of an attribute by name at level 0.

Boolean, Number, Boolean GetColorValueByName(String name, Murl.IAttributes params, Number value, Boolean error)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe color component return value.
errorThe error return value is set to true if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Number value The color component return value.
Boolean error The error return value is set to true if data conversion failed.

GetColorValueByName(name, params, value, result)

Get the color component value of an attribute by name at level 0.

Boolean, Number, Murl.Result GetColorValueByName(String name, Murl.IAttributes params, Number value, Murl.Result result)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe color component return value.
resultAn error message is appended to this object if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Number value The color component return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValuesByName(name, params, values, error, clear)

Get the boolean values of an attribute by name at level 0.

Boolean, Murl.Array.Bool, Boolean GetValuesByName(String name, Murl.IAttributes params, Murl.Array.Bool values, Boolean error, Boolean clear)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe boolean array return value.
errorThe error return value is set to true if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Bool values The boolean array return value.
Boolean error The error return value is set to true if data conversion failed.

GetValuesByName(name, params, values, result, clear)

Get the boolean values of an attribute by name at level 0.

Boolean, Murl.Array.Bool, Murl.Result GetValuesByName(String name, Murl.IAttributes params, Murl.Array.Bool values, Murl.Result result, Boolean clear)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe boolean array return value.
resultAn error message is appended to this object if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Bool values The boolean array return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValuesByName(name, params, values, error, clear)

Get the double values of an attribute by name at level 0.

Boolean, Murl.Array.Double, Boolean GetValuesByName(String name, Murl.IAttributes params, Murl.Array.Double values, Boolean error, Boolean clear)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe double array return value.
errorThe error return value is set to true if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Double values The double array return value.
Boolean error The error return value is set to true if data conversion failed.

GetValuesByName(name, params, values, result, clear)

Get the double values of an attribute by name at level 0.

Boolean, Murl.Array.Double, Murl.Result GetValuesByName(String name, Murl.IAttributes params, Murl.Array.Double values, Murl.Result result, Boolean clear)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe double array return value.
resultAn error message is appended to this object if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Double values The double array return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValuesByName(name, params, values, error, clear)

Get the float values of an attribute by name at level 0.

Boolean, Murl.Array.Float, Boolean GetValuesByName(String name, Murl.IAttributes params, Murl.Array.Float values, Boolean error, Boolean clear)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe float array return value.
errorThe error return value is set to true if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Float values The float array return value.
Boolean error The error return value is set to true if data conversion failed.

GetValuesByName(name, params, values, result, clear)

Get the float values of an attribute by name at level 0.

Boolean, Murl.Array.Float, Murl.Result GetValuesByName(String name, Murl.IAttributes params, Murl.Array.Float values, Murl.Result result, Boolean clear)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe float array return value.
resultAn error message is appended to this object if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Float values The float array return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValuesByName(name, params, values, error, clear)

Get the signed integer values of an attribute by name at level 0.

Boolean, Murl.Array.SInt32, Boolean GetValuesByName(String name, Murl.IAttributes params, Murl.Array.SInt32 values, Boolean error, Boolean clear)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe signed integer array return value.
errorThe error return value is set to true if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.SInt32 values The signed integer array return value.
Boolean error The error return value is set to true if data conversion failed.

GetValuesByName(name, params, values, result, clear)

Get the signed integer values of an attribute by name at level 0.

Boolean, Murl.Array.SInt32, Murl.Result GetValuesByName(String name, Murl.IAttributes params, Murl.Array.SInt32 values, Murl.Result result, Boolean clear)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe signed integer array return value.
resultAn error message is appended to this object if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.SInt32 values The signed integer array return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValuesByName(name, params, values, error, clear)

Get the string values of an attribute by name at level 0.

Boolean, Murl.Array.String, Boolean GetValuesByName(String name, Murl.IAttributes params, Murl.Array.String values, Boolean error, Boolean clear)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe string array return value.
errorThe error return value is set to true if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.String values The string array return value.
Boolean error The error return value is set to true if data conversion failed.

GetValuesByName(name, params, values, result, clear)

Get the string values of an attribute by name at level 0.

Boolean, Murl.Array.String, Murl.Result GetValuesByName(String name, Murl.IAttributes params, Murl.Array.String values, Murl.Result result, Boolean clear)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe string array return value.
resultAn error message is appended to this object if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.String values The string array return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetValuesByName(name, params, values, error, clear)

Get the unsigned integer values of an attribute by name at level 0.

Boolean, Murl.Array.UInt32, Boolean GetValuesByName(String name, Murl.IAttributes params, Murl.Array.UInt32 values, Boolean error, Boolean clear)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe unsigned integer array return value.
errorThe error return value is set to true if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.UInt32 values The unsigned integer array return value.
Boolean error The error return value is set to true if data conversion failed.

GetValuesByName(name, params, values, result, clear)

Get the unsigned integer values of an attribute by name at level 0.

Boolean, Murl.Array.UInt32, Murl.Result GetValuesByName(String name, Murl.IAttributes params, Murl.Array.UInt32 values, Murl.Result result, Boolean clear)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe unsigned integer array return value.
resultAn error message is appended to this object if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.UInt32 values The unsigned integer array return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetAngleValuesByName(name, params, values, error, clear)

Get the double angle values of an attribute by name at level 0.

Boolean, Murl.Array.Double, Boolean GetAngleValuesByName(String name, Murl.IAttributes params, Murl.Array.Double values, Boolean error, Boolean clear)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe double array return value.
errorThe error return value is set to true if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Double values The double array return value.
Boolean error The error return value is set to true if data conversion failed.

GetAngleValuesByName(name, params, values, result, clear)

Get the double angle values of an attribute by name at level 0.

Boolean, Murl.Array.Double, Murl.Result GetAngleValuesByName(String name, Murl.IAttributes params, Murl.Array.Double values, Murl.Result result, Boolean clear)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe double array return value.
resultAn error message is appended to this object if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Double values The double array return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetAngleValuesByName(name, params, values, error, clear)

Get the float angle values of an attribute by name at level 0.

Boolean, Murl.Array.Float, Boolean GetAngleValuesByName(String name, Murl.IAttributes params, Murl.Array.Float values, Boolean error, Boolean clear)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe float array return value.
errorThe error return value is set to true if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Float values The float array return value.
Boolean error The error return value is set to true if data conversion failed.

GetAngleValuesByName(name, params, values, result, clear)

Get the float angle values of an attribute by name at level 0.

Boolean, Murl.Array.Float, Murl.Result GetAngleValuesByName(String name, Murl.IAttributes params, Murl.Array.Float values, Murl.Result result, Boolean clear)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe float array return value.
resultAn error message is appended to this object if data conversion failed.
clearIf true clear the return value array before adding the return values.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Murl.Array.Float values The float array return value.
Murl.Result result An error message is appended to this object if data conversion failed.

GetBitsToSetByName(name, params, value, error)

Get the bit number values of an attribute by name at level 0 and set the bits.

Boolean, Integer, Boolean GetBitsToSetByName(String name, Murl.IAttributes params, Integer value, Boolean error)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe bits return value.
errorThe error return value is set to true if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Integer value The bits return value.
Boolean error The error return value is set to true if data conversion failed.

GetBitsToSetByName(name, params, value, result)

Get the bit number values of an attribute by name at level 0 and set the bits.

Boolean, Integer, Murl.Result GetBitsToSetByName(String name, Murl.IAttributes params, Integer value, Murl.Result result)

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe bits return value.
resultAn error message is appended to this object if data conversion failed.
Returns
Boolean true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Integer value The bits return value.
Murl.Result result An error message is appended to this object if data conversion failed.