Class BallApt
Ball End Apt.
public class BallApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IToXElement
- Inheritance
-
BallApt
- Implements
- Inherited Members
- Extension Methods
Constructors
BallApt()
Ctor.
public BallApt()
BallApt(XElement)
Ctor.
public BallApt(XElement src)
Parameters
src
XElementXML
Properties
AbstractNote
Gets a descriptive note or abstract about the object.
public string AbstractNote { get; }
Property Value
Diameter_mm
Diameter.
public double Diameter_mm { get; set; }
Property Value
FluteHeight_mm
Flute Height.
public double FluteHeight_mm { get; set; }
Property Value
XName
Name for XML IO.
public static string XName { get; }
Property Value
Methods
ClearCache()
Clears the internal cache.
public void ClearCache()
Duplicate(params object[])
Creates a deep copy of the object, excluding any source file references.
public object Duplicate(params object[] res)
Parameters
res
object[]Optional parameters that may be needed during the duplication process
Returns
- object
A new instance that is a deep copy of the original object
ExpandToBox3d(Box3d)
Expands the destination box. This function is usually used to compute the bounding box of elements.
public void ExpandToBox3d(Box3d dst)
Parameters
dst
Box3dDestination box
GetGeneralApt()
Get Apt.
public GeneralApt GetGeneralApt()
Returns
- GeneralApt
Apt
MakeXmlSource(string, string)
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)
Parameters
baseDirectory
stringThe base directory for resolving relative paths
relFile
stringThe relative file path for the XML source
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.
ToXElement()
Get the XElement to represent the object.
public XElement ToXElement()