The following functions provide an interface for working with properties.
In physical mode, the number argument is an integer, within the acceptable range.
Physical cell | 0 - 6999, 7105 (Flags), 7198 (Template Params), 7199 (Template Script), 7300 or larger. |
Physical object | 0 - 6999, 7198 (Template Params), 7200 or larger. |
Adding a Flags, Template Params or Template Script property will automatically remove the old property, if any. Note that pseudo-properties can be applied to physical objects.
In electrical mode, it is possible to set the name, model, value, param, other and nophys properties if the handle references an electrical device, or the same properties except for model and value if the handle references an electrical subcell, or the param and other properties in the cell. In this case, the number argument is a string, and should be a prefix of ``name'', ``model'', ``value'', ``param'', ``other'', or ``nophys''. The single character string ``n'' implies name, and (additionally) ``y'' implies nophys. If the string is not recognized, other is assumed. The object must be defined in the current cell, thus the mode must be electrical.
If the function succeeds, 1 is returned. otherwise 0 is returned.
In physical mode, the number argument is an integer, within the acceptable range. If the string is null or empty, only the number is used for comparison, and all properties with that number will be removed. Otherwise, if the string is a prefix of the property string and the numbers match, the property will be removed.
Physical cell | 0 - 6999, 7105 (Flags), 7300 or larger. |
Physical object | 0 - 6999, 7300 or larger. |
Note that template properties can not be removed.
In electrica mode, the name, model, value, param, other, and nophys properties can be removed from a device, and the same properties except for model and value can be removed from an electrical subcell, and param and other properties can be removed from the cell. In this case, the number argument is a string, which should be a prefix of ``name'', ``model'', ``value'', ``param'', ``other'', or ``nophys''. The single character string ``n'' implies name, and (additionally) ``y'' implies nophys. If the string is not recognized, other is assumed. Except for other, the string argument is ignored. For other properties, the string is used as above to identify the property to delete.
Objects must be defined in the current cell. The function returns the number of properties removed.
If the number argument is a prefix of ``all'', then any property string will be returned. In physical mode, the number argument should otherwise be an integer. In electrical mode, the number argument is a prefix of ``name'', ``model'', ``value'', ``param'', ``other'', or ``nophys'', which is appropriate for electrical devices. The single character string ``n'' implies name, and (additionally) ``y'' implies nophys. If the string is not recognized, other is assumed.
A prefix of the string ``all'' can be passed for the number argument, in which case the handle will reference all properties of the cell. In physical mode, the number argument should otherwise be an integer.
In electrical mode, the number argument is a prefix of ``name", ``model'', ``value'', ``param'' ``other'', or ``nophys''. The single character string ``n'' implies name, and (additionally) ``y'' implies nophys. If the string is not recognized, other is assumed.
If the requested property is a name property of an electrical device or subcircuit, only the name is returned (the internal property string is more complex). Otherwise the ``raw'' string is returned.
In physical mode, the function will locate a property with the given number, and return its string. If no property is found with that number, and a pseudo-property for the object matches the number, then the pseudo-property string is returned. Note that pseudo-properties are currently defined for objects, not cells. If no matching pseudo-property is found, a null string is returned. Note: objects can be modified through setting pseudo-properties using the PrptyAdd function.
In electrical mode, the number argument is a string, in which case it should be a prefix of one of ``name'', ``model'', ``value'', ``param'', ``other'', or ``nophys''. The single character string ``n'' implies name, and (additionally) ``y'' implies nophys. If the string is not recognized, other is assumed. This input is appropriate for obtaining property values from electrical devices.
If the requested property is a name property of an electrical device or subcircuit, only the name is returned (the internal property string is more complex). Otherwise the ``raw'' string is returned.