Smith Type

The smith subplot is used by TraceSmith traces.

Constructors

Constructor Description

Smith()

Full Usage: Smith()

Returns: Smith
Returns: Smith

Static members

Static member Description

Smith.getImaginaryAxis smith

Full Usage: Smith.getImaginaryAxis smith

Parameters:
    smith : Smith - The smith object to get the ImaginaryAxis from

Returns: ImaginaryAxis

Returns the ImaginaryAxis object of the given smith object. If there is no ImaginaryAxis set, returns an empty ImaginaryAxis object.

smith : Smith

The smith object to get the ImaginaryAxis from

Returns: ImaginaryAxis

Smith.getRealAxis smith

Full Usage: Smith.getRealAxis smith

Parameters:
    smith : Smith - The smith object to get the RealAxis from

Returns: RealAxis

Returns the RealAxis object of the given smith object. If there is no RealAxis set, returns an empty RealAxis object.

smith : Smith

The smith object to get the RealAxis from

Returns: RealAxis

Smith.init (?BGColor, ?Domain, ?ImaginaryAxis, ?RealAxis)

Full Usage: Smith.init (?BGColor, ?Domain, ?ImaginaryAxis, ?RealAxis)

Parameters:
    ?BGColor : Color - Set the background color of the subplot
    ?Domain : Domain - Sets the domain of this smith subplot
    ?ImaginaryAxis : ImaginaryAxis - Sets the imaginary axis of this smith subplot
    ?RealAxis : RealAxis - Sets the real axis of this smith subplot

Returns: Smith

Initialize a Smith object that contains layout options concerned with smith plots.

?BGColor : Color

Set the background color of the subplot

?Domain : Domain

Sets the domain of this smith subplot

?ImaginaryAxis : ImaginaryAxis

Sets the imaginary axis of this smith subplot

?RealAxis : RealAxis

Sets the real axis of this smith subplot

Returns: Smith

Smith.setImaginaryAxis imaginaryAxis

Full Usage: Smith.setImaginaryAxis imaginaryAxis

Parameters:
Returns: Smith -> Smith

Returns a function that sets the ImaginaryAxis object of the given smith object.

imaginaryAxis : ImaginaryAxis

The new ImaginaryAxis object

Returns: Smith -> Smith

Smith.setRealAxis realAxis

Full Usage: Smith.setRealAxis realAxis

Parameters:
    realAxis : RealAxis - The new RealAxis object

Returns: Smith -> Smith

Returns a function that sets the RealAxis object of the given smith object.

realAxis : RealAxis

The new RealAxis object

Returns: Smith -> Smith

Smith.style (?BGColor, ?Domain, ?ImaginaryAxis, ?RealAxis)

Full Usage: Smith.style (?BGColor, ?Domain, ?ImaginaryAxis, ?RealAxis)

Parameters:
    ?BGColor : Color - Set the background color of the subplot
    ?Domain : Domain - Sets the domain of this smith subplot
    ?ImaginaryAxis : ImaginaryAxis - Sets the imaginary axis of this smith subplot
    ?RealAxis : RealAxis - Sets the real axis of this smith subplot

Returns: Smith -> Smith

Create a function that applies the given style parameters to a Smith object

?BGColor : Color

Set the background color of the subplot

?Domain : Domain

Sets the domain of this smith subplot

?ImaginaryAxis : ImaginaryAxis

Sets the imaginary axis of this smith subplot

?RealAxis : RealAxis

Sets the real axis of this smith subplot

Returns: Smith -> Smith

Smith.tryGetTypedMember propName smith

Full Usage: Smith.tryGetTypedMember propName smith

Parameters:
    propName : string - The name of the dynamic member to get the value of
    smith : Smith - The object to get the dynamic member value from

Returns: 'T option

Returns Some(dynamic member value) of the object's underlying DynamicObj when a dynamic member with the given name exists, and None otherwise.

propName : string

The name of the dynamic member to get the value of

smith : Smith

The object to get the dynamic member value from

Returns: 'T option