CableVoltageSource
INTERNAL: A cable voltage source component.
Inheritance
The CableVoltageSource object is derived from the CableSchematicComponent object.
Property List
- Impedance
- The impedance of the voltage in Ohms. (Read/Write Expression)
- Label
- The object label. (Read/Write string)
- Magnitude
- The magnitude of the voltage in Volts. (Read/Write Expression)
- Phase
- The phase of the voltage in degrees. (Read/Write Expression)
- Position
- The schematic symbol position. (Read only SchematicSymbolPosition)
- Type
- The object type string. (Read only string)
Collection List
- Terminals
- The collection of schematic terminals on the symbol. (TerminalCollection of Terminal.)
Method List
- Delete ()
- Deletes the component from the cable schematic.
- 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.)
- Rotate ()
- Rotates the symbol 90 degrees clockwise.
- SetProperties (properties table)
- 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
- Impedance
- The impedance of the voltage in Ohms.
- Type
- Expression
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Magnitude
- The magnitude of the voltage in Volts.
- Type
- Expression
- Access
- Read/Write
- Phase
- The phase of the voltage in degrees.
- Type
- Expression
- Access
- Read/Write
- Position
- The schematic symbol position.
- Type
- SchematicSymbolPosition
- Access
- Read only
- Type
- The object type string.
- Type
- string
- Access
- Read only
Collection Details
- Terminals
- The collection of schematic terminals on the symbol.
- Type
- TerminalCollection
Method Details
- Delete ()
- Deletes the component from the cable schematic.
- 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 properties table.
- Rotate ()
- Rotates the symbol 90 degrees clockwise.
- SetProperties (properties table)
- 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(table)
- 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
- The default properties table.