LongitudinalBarProperties

Canonical path: NemAll_Python_Reinforcement.LongitudinalBarProperties

Implementation of the longitudinal bar properties

Classes:

• eDeliveryShapeType –

  Delivery shape types

• eInsideBarsState –

  Inside bar state

Methods:

• GetBendingShape –

  Get the bending shape

• GetDeliveryShapeType –

  Get the delivery shape type

• GetInsideBarsState –

  Get the insid bars state

• GetMinBarDistance –

  Get the minimal bar distance

• GetOverlappingAtEnd –

  Get the overlapping at end

• GetOverlappingAtStart –

  Get the overlapping at start

• GetOverlappingLength –

  Get the overlapping length

• GetStartLength –

  Get the start length

• IsOverlappingAtEndTurnedOn –

  Get the overlapping at end state

• IsOverlappingAtStartTurnedOn –

  Get the overlapping at start state

• SetBendingShape –

  Set the bending shape

• __eq__ –

  Compare operator

• __init__ –

  Overloaded function. See individual overloads.

Attributes:

• BendingShape (BendingShape) –

  Get the bending shape

BendingShape property writable

BendingShape: BendingShape

Get the bending shape

eDeliveryShapeType

Canonical path: NemAll_Python_Reinforcement.LongitudinalBarProperties.eDeliveryShapeType

Bases: Enum

Delivery shape types

Methods:

• __getitem__ –

  get the item for a key

__getitem__

__getitem__(key: str | int | float) -> eDeliveryShapeType

get the item for a key

Parameters:

• key (str | int | float) –

  value key

Returns:

• eDeliveryShapeType –

  value for the key

eInsideBarsState

Canonical path: NemAll_Python_Reinforcement.LongitudinalBarProperties.eInsideBarsState

Bases: Enum

Inside bar state

Methods:

• __getitem__ –

  get the item for a key

__getitem__

__getitem__(key: str | int | float) -> eInsideBarsState

get the item for a key

Parameters:

• key (str | int | float) –

  value key

Returns:

• eInsideBarsState –

  value for the key

GetBendingShape

GetBendingShape() -> BendingShape

Get the bending shape

Returns:

• BendingShape –

  Bending shape

GetDeliveryShapeType

GetDeliveryShapeType() -> eDeliveryShapeType

Get the delivery shape type

Returns:

• eDeliveryShapeType –

  Delivery shape type

GetInsideBarsState

GetInsideBarsState() -> eInsideBarsState

Get the insid bars state

Returns:

• eInsideBarsState –

  Inside bars state

GetMinBarDistance

GetMinBarDistance() -> float

Get the minimal bar distance

Returns:

• float –

  Minimal bar distance

GetOverlappingAtEnd

GetOverlappingAtEnd() -> float

Get the overlapping at end

Returns:

• float –

  Overlapping at end

GetOverlappingAtStart

GetOverlappingAtStart() -> float

Get the overlapping at start

Returns:

• float –

  Overlapping at start

GetOverlappingLength

GetOverlappingLength() -> float

Get the overlapping length

Returns:

• float –

  Overlapping length

GetStartLength

GetStartLength() -> float

Get the start length

Returns:

• float –

  Start length

IsOverlappingAtEndTurnedOn

IsOverlappingAtEndTurnedOn() -> bool

Get the overlapping at end state

Returns:

• bool –

  Overlapping at end state

IsOverlappingAtStartTurnedOn

IsOverlappingAtStartTurnedOn() -> bool

Get the overlapping at start state

Returns:

• bool –

  Overlapping at start state

SetBendingShape

SetBendingShape(shape: BendingShape)

Set the bending shape

Parameters:

• shape (BendingShape) –

  Shape

Returns:

• –

  Bending shape

__eq__

__eq__(props: LongitudinalBarProperties) -> bool

Compare operator

Args:

Returns:

• bool –

  Bars are equal: true/false

__init__ overloaded

__init__()

Initialize

__init__(
    shape: BendingShape,
    overlappingAtStartTurnedOn: bool,
    overlappingAtStart: float,
    overlappingAtEndTurnedOn: bool,
    overlappingAtEnd: float,
    overlappingLength: float,
    minBarDistance: float,
    deliveryShapeType: eDeliveryShapeType,
    insideBarsState: eInsideBarsState,
    startLength: float,
)

Constructor

Parameters:

• shape (BendingShape) –

  Bar shape

• overlappingAtStartTurnedOn (bool) –

  Overlapping at start start

• overlappingAtStart (float) –

  Overlapping at start

• overlappingAtEndTurnedOn (bool) –

  Overlapping at end state

• overlappingAtEnd (float) –

  Overlapping at end

• overlappingLength (float) –

  Overlapping length

• minBarDistance (float) –

  Minimal bar distance

• deliveryShapeType (eDeliveryShapeType) –

  Delivery shape type

• insideBarsState (eInsideBarsState) –

  Inside bars state

• startLength (float) –

  Start length

Placeholder