SParameter
A solution S-parameter request.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Add a line and a wire port at the start of the line line = project.Contents.Geometry:AddLine(cf.Point(0,0,0), cf.Point(1,1,0)) port1 = project.Contents.Ports:AddWirePort(line.Wires[1]) -- Add an S-parameters calculation request for the wire port SParameterConfiguration = project.Contents.SolutionConfigurations:AddMultiportSParameter({port1}) -- Add a port to the S-parameters calculation port2 = project.Contents.Ports:AddWirePort(line.Wires[1]) port2.Location = cf.Enums.WirePortLocationEnum.End SParametersRequest = SParameterConfiguration.SParameter portProperties = SParametersRequest.PortProperties:append() portProperties.Terminal = port2 portProperties.Impedance = 60 portProperties.Active = true
Inheritance
The SParameter object is derived from the Object object.
Usage locations
The SParameter object can be accessed from the following locations:
- Properties
- SParameterConfiguration object has property SParameter.
Property List
- Included
- A boolean value defining if an entity is excluded or included. (Read/Write boolean)
- Label
- The object label. (Read/Write string)
- LoadsRestored
- Specifies if the loads are restored after calculation. (Read/Write boolean)
- MultiportPackageGenerationEnabled
- Enable the generation of multiport package files. (Read/Write boolean)
- PortProperties
- The collection of port properties for the S-parameter request. (Read/Write PortPropertiesList)
- TouchstoneExportEnabled
- Specifies if the S-parameters should be exported to a Touchstone (*.snp) file. (Read/Write boolean)
- Type
- The object type string. (Read only string)
Method List
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity. (Returns a Object object.)
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
- SetProperties (properties Object)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
- Included
- A boolean value defining if an entity is excluded or included.
- Type
- boolean
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- LoadsRestored
- Specifies if the loads are restored after calculation.
- Type
- boolean
- Access
- Read/Write
- MultiportPackageGenerationEnabled
- Enable the generation of multiport package files.
- Type
- boolean
- Access
- Read/Write
- PortProperties
- The collection of port properties for the S-parameter request.
- Type
- PortPropertiesList
- Access
- Read/Write
- TouchstoneExportEnabled
- Specifies if the S-parameters should be exported to a Touchstone (*.snp) file.
- Type
- boolean
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Method Details
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity.
- Return
- Object
- The new (duplicated) entity.
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
- Return
- table
- A table defining the properties.
- SetProperties (properties Object)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
- Input Parameters
- properties(Object)
- A table of properties defining the new state of the object.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.