# ImpressedCurrent

An impressed current may be defined as a source in a model.

## Example

application = cf.Application.GetInstance()
project = application:NewProject()

-- Create an impressed current

sourceCollection = project.Contents.SolutionConfigurations.GlobalSources
impressedCurrent = sourceCollection:AddImpressedCurrent(cf.Point(0,0,0),cf.Point(1,1,0),0.01)

## Inheritance

The ImpressedCurrent object is derived from the AbstractIdealSource object.

## Usage locations

The ImpressedCurrent object can be accessed from the following locations:

## Property List

BoundingBox
A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
ConnectEndToClosestVertex
The option to connect the end point to the closest vertex. (Read/Write boolean)
EndMagnitude
The magnitude at the end position. (Read/Write ParametricExpression)
EndPhase
The phase (degrees) at the end position. (Read/Write ParametricExpression)
EndPosition
The end position of the source. (Read/Write LocalCoordinate)
ImpressedCurrentClosestVertexType
The mesh element type to connect to. (Read/Write ImpressedCurrentClosestVertexTypeEnum)
Label
The object label. (Read/Write string)
LocalWorkplane
The source workplane. (Read/Write LocalWorkplane)
The radius of the impressed current. (Read/Write ParametricExpression)
StartMagnitude
The magnitude at the start position. (Read/Write ParametricExpression)
StartPhase
The phase (degrees) at the start position. (Read/Write ParametricExpression)
StartPosition
The start position of the source. (Read/Write LocalCoordinate)
Type
The object type string. (Read only string)
Visible
Specifies whether the geometry must be shown or hidden. (Read/Write boolean)

## Collection List

Transforms
The collection of transforms on the operator. (TransformCollection of Transform.)

## Method List

CopyAndMirror (properties table)
Apply a copy and mirror using a table defining the properties. (Returns a Object object.)
CopyAndRotate (properties table, count number)
Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.)
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
Copy and rotate the geometry. (Returns a List of Object object.)
CopyAndTranslate (properties table, count number)
Apply a copy and translate using a table defining the properties. (Returns a List of Object object.)
CopyAndTranslate (from Point, to Point, count number)
Copy and translate the geometry. (Returns a List of Object object.)
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

BoundingBox
A box indicating the bounding box of this entity. (Read only Box).
Type
Box
Access
ConnectEndToClosestVertex
The option to connect the end point to the closest vertex.
Type
boolean
Access
EndMagnitude
The magnitude at the end position.
Type
ParametricExpression
Access
EndPhase
The phase (degrees) at the end position.
Type
ParametricExpression
Access
EndPosition
The end position of the source.
Type
LocalCoordinate
Access
ImpressedCurrentClosestVertexType
The mesh element type to connect to.
Type
ImpressedCurrentClosestVertexTypeEnum
Access
Label
The object label.
Type
string
Access
LocalWorkplane
The source workplane.
Type
LocalWorkplane
Access
The radius of the impressed current.
Type
ParametricExpression
Access
StartMagnitude
The magnitude at the start position.
Type
ParametricExpression
Access
StartPhase
The phase (degrees) at the start position.
Type
ParametricExpression
Access
StartPosition
The start position of the source.
Type
LocalCoordinate
Access
Type
The object type string.
Type
string
Access
Visible
Specifies whether the geometry must be shown or hidden.
Type
boolean
Access

## Collection Details

Transforms
The collection of transforms on the operator.
Type
TransformCollection

## Method Details

CopyAndMirror (properties table)
Apply a copy and mirror using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the mirror transform.
Return
Object
The mirrored geometry.
CopyAndRotate (properties table, count number)
Apply a copy and rotate using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the rotate transform.
count(number)
The number of transform copies.
Return
List of Object
The list of rotated geometry.
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
Copy and rotate the geometry.
Input Parameters
origin(Point)
The coordinates of the origin of the rotation.
rotationaxis(Vector)
The axis of rotation.
angle(number)
The angle of rotation (degrees).
count(number)
The number of copies.
Return
List of Object
The list of rotated geometry.
CopyAndTranslate (properties table, count number)
Apply a copy and translate using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the translate transform.
count(number)
The number of transform copies.
Return
List of Object
The list of translated geometry.
CopyAndTranslate (from Point, to Point, count number)
Copy and translate the geometry.
Input Parameters
from(Point)
Translate from coordinate.
to(Point)
Translate to coordinate.
count(number)
The number of copies.
Return
List of Object
The list of translated geometry.
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.