simetrix.Curve¶

class simetrix.Curve(obj: GraphObject)¶

Bases: GraphObject

Represents a curve within a Graph.

Methods

`data`()	Deprecated, use `Curve.vector` to obtain a curve's data.
`prop`(propertyName)	Returns the property with the name given.
`properties`()	Returns the set of properties for this object.
`setPropertyValue`(propertyName, propertyValue)	Sets a property value for an object.

Attributes

`id`	Returns the ID of the object.
`type`	Returns the object type.
`valid`	Returns True if the GraphObject is valid.
`vector`	Returns the data for the curve.

__init__(obj: GraphObject) → Curve¶

data() → LegacyCurveData¶: Deprecated, use Curve.vector to obtain a curve’s data. Returns the LegacyCurveData object for the curve.

property id: int¶: Returns the ID of the object. This can be used to pass to a native SIMetrix script function.

prop(propertyName: str) → GraphProperty¶

Returns the property with the name given. Can also use property().

Some properties have a symbolic value denoted by enclosing the value with ‘%’ characters. The property method will return the resolved value instead of the symbolic value if the name is prefixed with the ‘@’ character. For example:

print(curve.prop('@Label').Value)

The Label property usually has the value %DefaultLabel% which is what would be returned by the method if the ‘@’ character were omitted. The resolved value is the value of the DefaultLabel property.

properties() → list[GraphProperty]¶

Returns the set of properties for this object.

Example

Print the name and data type for all properties belonging to the current graph.

import simetrix as sx

graph = sx.currentGraph()

props= graph.properties()

for p in props :
    print(p.name, p.type)

setPropertyValue(propertyName: str, propertyValue: str | float)¶

Sets a property value for an object.

As explained in GraphProperty GraphProperty obejcts can have one of five data types. However, writeable properties can only be scalar string or scalar real valued. Hence this method can only accept real or string data for the property value.

Example

import simetrix as sx

# Get the current graph
graph = sx.currentGraph()

# Get the first curve available
curve = graph.curves()[0]

# Change the curve colour to green
curve.setPropertyValue('RGBColour', 32768)

property type: GraphObjectType¶: Returns the object type.

property valid: bool¶

Returns True if the GraphObject is valid.

A GraphObject obtained from the GraphProperty of another GraphObject will not necessarily be valid. The following example obtains the MainCursor property of the current graph. This will be an invalid object if cursors are not enabled.

import simetrix as sx

graph = sx.currentGraph()

mainCursor = graph.prop('MainCursor')

if mainCursor.value.valid :
    print("Cursors are enabled")
else :
    print("Cursors are not enabled")

property vector: GroupVector¶

Returns the data for the curve.

Examples

Print the data elements from a curve’s data

import simetrix as sx

graph = sx.currentGraph()

data = graph.curves()[0].vector.y[0]

for d in data :
    print (d)