Table of Contents

Class UniformFluting

Namespace
Hi.Milling.FluteContours
Assembly
HiMech.dll

A milling cutter's fluting built from one shared baseline contour repeated evenly around the cutter: every flute has the same geometry, spaced at equal angles. Use FreeFluting when the flutes need to be defined individually.

public class UniformFluting : IFluting, IMakeXmlSource, IExpandToBox3d, IGetFluteNum, IUpdateByContent, IClearCache
Inheritance
UniformFluting
Implements
Inherited Members
Extension Methods

Constructors

UniformFluting()

Initializes a new instance of the UniformFluting class.

public UniformFluting()

UniformFluting(XElement, string, IProgress<IMessage>, object[])

Ctor.

public UniformFluting(XElement src, string baseDirectory, IProgress<IMessage> progress, object[] res)

Parameters

src XElement

XML

baseDirectory string

Base directory path for resolving relative paths

progress IProgress<IMessage>

Progress reporter for diagnostic messages emitted during construction.

res object[]

Additional optional resources

Properties

BaselineFluteOffsetAngle_deg

Gets or sets the flute offset angle of the baseline contour in degrees (FluteOffsetAngle_deg): the angular position of the first flute on the cutter body; the other flutes follow at equal spacing.

public double BaselineFluteOffsetAngle_deg { get; set; }

Property Value

double

BaselineOneContour

Gets or sets the baseline contour.

public FluteContour BaselineOneContour { get; set; }

Property Value

FluteContour

TrackNum

Gets or sets the number of flutes this fluting repeats the baseline contour into.

public int TrackNum { get; set; }

Property Value

int

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

ClearCache()

Clears any cached data held by the implementing object.

public void ClearCache()

Duplicate(IGetZrList)

Creates a duplicate of this fluting with the specified ZR list host.

public IFluting Duplicate(IGetZrList zrListHost)

Parameters

zrListHost IGetZrList

The ZR list host to use for the duplicate

Returns

IFluting

A new fluting instance

ExpandToBox3d(ref box3d_t)

Expands the destination box. This function is usually used to compute the bounding box of elements. box3d_t is a value type, so the destination is passed by reference (the C++ expand_to_box3d(box3&) shape); an implementation writes dst = dst.Expanded(...) or forwards ref dst to its parts.

public void ExpandToBox3d(ref box3d_t dst)

Parameters

dst box3d_t

Destination box, expanded in place

GetFluteContourList()

Gets the list of flute contours that make up this fluting.

public List<FluteContour> GetFluteContourList()

Returns

List<FluteContour>

A list of flute contours.

GetFluteNum()

Gets the number of flutes.

public int GetFluteNum()

Returns

int

The number of flutes.

MakeXmlSource(string, string, bool)

Creates an XML representation of the object. This method may also generate additional resources such as related files.

public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

baseDirectory string

The base directory for resolving relative paths

relFile string

The relative file path for the XML source

exhibitionOnly bool

if true, the extended file creation is suppressed.

Returns

XElement

An XML element representing the object's state

Remarks

For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied. The baseDirectory is typically the folder at the nearest configuration file folder. Since the folder can be moving with the configuration file.

Reg(XFactory)

Registers this type's deserializer with the given XFactory (or Default when factory is null). Idempotent.

public static void Reg(XFactory factory = null)

Parameters

factory XFactory

UpdateByContent()

Updates the object based on its current content.

public void UpdateByContent()