v_sim.PairWire¶

Implementations:: v_sim.PairLink

Methods¶

class	`getDefaultStipple` ()
class	`getDefaultWidth` ()
	`getShade` ()
	`getStipple` ()
	`getWidth` ()
	`setShade` (shade)
	`setStipple` (stipple)
	`setWidth` (val)

Virtual Methods¶

	`do_get_shade` ()
	`do_get_stipple` ()
	`do_get_width` ()
	`do_set_shade` (val)
	`do_set_stipple` (val)
	`do_set_width` (val)

Properties¶

Name	Type	Flags	Short Description
`shade`	`v_sim.Shade`	r/w	wire shade
`stipple`	`int`	r/w	wire stipple
`width`	`int`	r/w	wire width

Signals¶

None

Fields¶

None

Class Details¶

class v_sim.PairWire¶

Bases:: GObject.GInterface
Structure:: v_sim.PairWireInterface

Interface object.

New in version 3.8.

classmethod getDefaultStipple()¶

Returns:: the default stipple pattern.
Return type:: int

Retrieves the default stipple pattern.

New in version 3.8.

classmethod getDefaultWidth()¶

Returns:: the default width.
Return type:: int

Retrieves the default width.

New in version 3.8.

getShade()¶

Returns:: the v_sim.Shade scheme if used, or None.
Return type:: v_sim.Shade

Colour of wires can depend on length, following a v_sim.Shade scheme.

New in version 3.6.

getStipple()¶

Returns:: a line pattern (default is 65535).
Return type:: int

Get the line pattern of self.

getWidth()¶

Returns:: the width of the given pair.
Return type:: int

Get the width of the given pair self. If the given pair has no specific width, the defaul value is returned.

setShade(shade)¶

Parameters:: shade (v_sim.Shade or None) – a v_sim.Shade object (can be None).
Returns:: True if shade is changed.
Return type:: bool

If shade is not None, make the colour of each pair varies with its length according to shade colour scheme.

New in version 3.6.

setStipple(stipple)¶

Parameters:: stipple (int) – a pattern.
Returns:: True if the value is different from previous.
Return type:: bool

Change the line pattern of self.

setWidth(val)¶

Parameters:: val (int) – a positive integer.
Returns:: True if the value is different from previous.
Return type:: bool

This method allows to change the width of line for a specific pair. When a pair is rendered via with a line, it first checks if that pairs has a specific width value set by this method. If not, it uses the default value.

do_get_shade() virtual¶

Return type:: v_sim.Shade

a method to get the shading colourisation of a wire.

do_get_stipple() virtual¶

Return type:: int

a method to get the stipple scheme.

do_get_width() virtual¶

Return type:: int

a method to get the width.

do_set_shade(val) virtual¶

Parameters:: val (v_sim.Shade) –
Return type:: bool

a method to set if the wire should be coloured according to its length.

do_set_stipple(val) virtual¶

Parameters:: val (int) –
Return type:: bool

a method to change the stipple scheme of drawn wire v_sim.PairLink.

do_set_width(val) virtual¶

Parameters:: val (int) –
Return type:: bool

a method to change the width of drawn wire v_sim.PairLink.

Property Details¶

v_sim.PairWire.props.shade¶

Name:: shade
Type:: v_sim.Shade
Default Value:: None
Flags:: READABLE, WRITABLE

wire shade

v_sim.PairWire.props.stipple¶

Name:: stipple
Type:: int
Default Value:: 65535
Flags:: READABLE, WRITABLE

wire stipple

v_sim.PairWire.props.width¶

Name:: width
Type:: int
Default Value:: 2
Flags:: READABLE, WRITABLE

wire width