MicrostripMeshPort
A microstrip mesh port is used to represent a feed line on a microstrip structure.
Example
application = cf.Application.GetInstance() project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/MeshPorts.cfx]]}) union1 = project.Contents.Geometry['Union1'] -- Unlink the Mesh. 'MicrostripMeshPorts' are automatically generated -- from 'MicrostripPorts' union1:UnlinkMesh() -- Get the 'MicrostripMeshPort' associated with the 'MicrostripPort' labelled 'MicrostripPort1' microstripMeshPort = project.Contents.Ports['MicrostripPort1_1'] -- Query if the mesh port is faulty isFaulty = microstripMeshPort.Faulty
Inheritance
The MicrostripMeshPort object is derived from the AbstractMeshPort object.
Usage locations
The MicrostripMeshPort object can be accessed from the following locations:
- Methods
- PortCollection collection has method AddMicrostripMeshPort(table).
- PortCollection collection has method AddMicrostripMeshPort(MeshVertexReference, MeshVertexReference).
Property List
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
- EndVertex
- The end vertex of the port. (Read/Write MeshVertexReference)
- Label
- The object label. (Read/Write string)
- PolarityReversed
- The option to reverse polarity of the port. (Read/Write boolean)
- Schematic
- The schematic associated with this item. (Read only Schematic)
- SchematicLocation
- The location of the item on the schematic. (Read only GridLocation)
- SchematicRotation
- The rotation of the item on the schematic. (Read only SymbolRotationEnum)
- StartVertex
- The start vertex of the port. (Read/Write MeshVertexReference)
- Terminals
- The schematic terminals on this item. (Read only List of Terminal)
- 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.)
- RotateSchematicSymbol ()
- Rotates the item on the schematic.
- 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.
- SetSchematicLocation (location GridLocation)
- Sets the location of the item on the schematic.
- SetSchematicRotation (rotation SymbolRotationEnum)
- Sets the rotation of the item on the schematic.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box).
- Type
- Box
- Access
- Read only
- EndVertex
- The end vertex of the port.
- Type
- MeshVertexReference
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- PolarityReversed
- The option to reverse polarity of the port.
- Type
- boolean
- Access
- Read/Write
- Schematic
- The schematic associated with this item.
- Type
- Schematic
- Access
- Read only
- SchematicLocation
- The location of the item on the schematic.
- Type
- GridLocation
- Access
- Read only
- SchematicRotation
- The rotation of the item on the schematic.
- Type
- SymbolRotationEnum
- Access
- Read only
- StartVertex
- The start vertex of the port.
- Type
- MeshVertexReference
- Access
- Read/Write
- Terminals
- The schematic terminals on this item.
- Access
- Read only
- 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.
- RotateSchematicSymbol ()
- Rotates the item on the schematic.
- 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.
- SetSchematicLocation (location GridLocation)
- Sets the location of the item on the schematic.
- Input Parameters
- location(GridLocation)
- The schematic location the item should be moved to.
- SetSchematicRotation (rotation SymbolRotationEnum)
- Sets the rotation of the item on the schematic.
- Input Parameters
- rotation(SymbolRotationEnum)
- The rotation setting.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.