Class MEANDER_SETTINGS.
More...
#include <pns_meander.h>
Class MEANDER_SETTINGS.
Holds the geometry of a single meander.
◆ MEANDER_SHAPE()
PNS::MEANDER_SHAPE::MEANDER_SHAPE |
( |
MEANDER_PLACER_BASE * |
aPlacer, |
|
|
int |
aWidth, |
|
|
bool |
aIsDual = false |
|
) |
| |
|
inline |
Constructor.
- Parameters
-
aPlacer | the meander placer instance |
aWidth | width of the meandered line |
aIsDual | when true, the shape contains two meandered lines at a given offset (diff pairs) |
◆ Amplitude()
int PNS::MEANDER_SHAPE::Amplitude |
( |
| ) |
const |
|
inline |
Function Amplitude()
- Returns
- the amplitude of the meander shape.
◆ BaseIndex()
int PNS::MEANDER_SHAPE::BaseIndex |
( |
| ) |
const |
|
inline |
Function BaseIndex()
- Returns
- auxillary index of the segment being meandered in its original LINE.
◆ BaselineLength()
int PNS::MEANDER_SHAPE::BaselineLength |
( |
| ) |
const |
Function BaselineLength()
- Returns
- length of the base segment for the meander (i.e. the minimum tuned length.
◆ BaseSegment()
const SEG& PNS::MEANDER_SHAPE::BaseSegment |
( |
| ) |
const |
|
inline |
Function BaseSegment()
Returns the base segment the meadner was fitted to.
- Returns
- the base segment.
◆ CLine()
Function CLine()
- Returns
- the line chain representing the shape of the meander.
◆ End()
VECTOR2I PNS::MEANDER_SHAPE::End |
( |
| ) |
const |
|
inline |
Function End()
- Returns
- end vertex of the base segment of the meander shape.
◆ Fit()
bool PNS::MEANDER_SHAPE::Fit |
( |
MEANDER_TYPE |
aType, |
|
|
const SEG & |
aSeg, |
|
|
const VECTOR2I & |
aP, |
|
|
bool |
aSide |
|
) |
| |
Function Fit()
Attempts to fit a meander of a given type onto a segment, avoiding collisions with other board features.
- Parameters
-
aType | type of meander shape |
aSeg | base segment for meandering |
aP | start point of the meander |
aSide | side of aSeg to put the meander on (true = right) |
- Returns
- true on success.
◆ IsDual()
bool PNS::MEANDER_SHAPE::IsDual |
( |
| ) |
const |
|
inline |
Function IsDual()
- Returns
- true if the shape represents 2 parallel lines (diff pair).
◆ MakeCorner()
Function MakeCorner()
Creates a dummy meander shape representing a line corner. Used to define the starts/ends of meandered segments.
- Parameters
-
aP1 | corner point of the 1st line |
aP2 | corner point of the 2nd line (if m_dual == true) |
◆ MakeEmpty()
void PNS::MEANDER_SHAPE::MakeEmpty |
( |
| ) |
|
Function MakeEmpty()
Replaces the meander with straight bypass line(s), effectively clearing it.
◆ MaxTunableLength()
int PNS::MEANDER_SHAPE::MaxTunableLength |
( |
| ) |
const |
◆ Recalculate()
void PNS::MEANDER_SHAPE::Recalculate |
( |
| ) |
|
Function Recalculate()
Recalculates the line chain representing the meanders's shape.
◆ Resize()
void PNS::MEANDER_SHAPE::Resize |
( |
int |
aAmpl | ) |
|
Function Resize()
Changes the amplitude of the meander shape to aAmpl and recalculates the resulting line chain.
- Parameters
-
◆ SetBaseIndex()
void PNS::MEANDER_SHAPE::SetBaseIndex |
( |
int |
aIndex | ) |
|
|
inline |
Function SetBaseIndex()
Sets an auxillary index of the segment being meandered in its original LINE.
◆ SetBaselineOffset()
void PNS::MEANDER_SHAPE::SetBaselineOffset |
( |
int |
aOffset | ) |
|
|
inline |
Function SetBaselineOffset()
Sets the parallel offset between the base segment and the meandered line. Used for dual menaders (diff pair) only.
- Parameters
-
◆ Settings()
Function Settings()
- Returns
- the current meandering settings.
◆ SetType()
void PNS::MEANDER_SHAPE::SetType |
( |
MEANDER_TYPE |
aType | ) |
|
|
inline |
Function SetType()
Sets the type of the meander.
◆ Side()
bool PNS::MEANDER_SHAPE::Side |
( |
| ) |
const |
|
inline |
Function Side()
- Returns
- true if the meander is to the right of its base segment.
◆ Type()
MEANDER_TYPE PNS::MEANDER_SHAPE::Type |
( |
| ) |
const |
|
inline |
Function Type()
- Returns
- the type of the meander.
◆ Width()
int PNS::MEANDER_SHAPE::Width |
( |
| ) |
const |
|
inline |
Function Width()
- Returns
- width of the meandered line.
The documentation for this class was generated from the following files:
- 3rd_party/router/router/pns_meander.h
- 3rd_party/router/router/pns_meander.cpp