IscAnalysisAF

Field Values

IscAnalysisAF Field Values

Type

Field Name

Description

Integer

IEEEStandard

Standard according to IEEE-1584 for the arc flash calculation used:

  • 0 = 2002 standard

  • 1 = 2018 standard

Float

BoundaryEnergyJcm2

Boundary energy defined at the standard level for a 2nd degree burn (defaults to 5 J/cm2).

Float

ReducedFaultCurrentPC

Reduction of fault current for more conservative arc flash calculation (default to 15%).

IscAnalysisAF Class

class ipsa.IscAnalysisAF

Analysis class for the ArcFlash analysis.

GetIValue(nFieldIndex: int) → int

Returns an integer value for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The integer value for the field.

Return type:

int

GetDValue(nFieldIndex: int) → float

Returns a float value for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The float value for the field.

Return type:

float

GetSValue(nFieldIndex: int) → str

Returns a string value for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The string value for the field.

Return type:

str

GetBValue(nFieldIndex: int) → bool

Returns a boolean value for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The boolean value for the field.

Return type:

bool

SetIValue(nFieldIndex: int, nValue: int) → bool

Sets the integer value for the enumerated field.

Parameters:

  • nFieldIndex (int) – The given enumerated field.

  • nValue (int) – The integer value that will be set.

Returns:

True if successful.

Return type:

bool

SetDValue(nFieldIndex: int, dValue: float) → bool

Sets the float value for the enumerated field.

Parameters:

  • nFieldIndex (int) – The given enumerated field.

  • dValue (float) – The float value that will be set.

Returns:

True if successful.

Return type:

bool

SetSValue(nFieldIndex: int, strValue: str) → bool

Sets the string value for the enumerated field.

Parameters:

  • nFieldIndex (int) – The given enumerated field.

  • strValue (str) – The string value that will be set.

Returns:

True if successful.

Return type:

bool

SetBValue(nFieldIndex: int, bValue: bool) → bool

Sets the integer value for the enumerated field.

Parameters:

  • nFieldIndex (int) – The given enumerated field.

  • bValue (bool) – The boolean value that will be set.

Returns:

True if successful.

Return type:

bool

GetFieldType(nFieldIndex: int) → str

Returns the field type as a string for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The field type.

Return type:

str

GetFieldName(nFieldIndex: int) → str

Returns the field name as a string for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The field name.

Return type:

str