Class PlayerDivConfig

Namespace

Hi.HiNcKits

Assembly

HiNc.dll

Per-user visibility flags for the Player page's divisions (charts and info panels). Mirrors the HiNcRcl PlayerDivConfig + PlayerDivFlag pair, flattened into a single all-boolean config so the webservice (which has no HiNcHost / HiNcUser) can persist the whole layout through UserConfig alone.

public class PlayerDivConfig : IMakeXmlSource

Inheritance

object

PlayerDivConfig

Implements

IMakeXmlSource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

ColorUtil.GetGloomyColor(object, double, double)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Remarks

Defaults are tuned for a first-time user: the two info panels (EnableStepDiv and MessageTable) are ON so the Player page looks populated without having to open the Division Visibility dropdown; every chart toggle starts OFF.

Constructors

PlayerDivConfig()

Default constructor.

public PlayerDivConfig()

PlayerDivConfig(XElement)

Initializes a new instance of the PlayerDivConfig class from XML data.

public PlayerDivConfig(XElement src)

Parameters

src XElement

XML element containing player-div data.

Properties

ColorIndexTimeChart

Color-index strip chart (single-strip timeline coloured by arbitrary numeric/bool aspect).

public bool ColorIndexTimeChart { get; set; }

Property Value

bool

DynamometerForceCycleLineDiv

Cycle-line chart of sensor-measured force from an external dynamometer.

public bool DynamometerForceCycleLineDiv { get; set; }

Property Value

bool

EnableDetailDiv0

Developer-only raw step-property dump panel.

public bool EnableDetailDiv0 { get; set; }

Property Value

bool

EnableStepDiv

Full / condensed step information panel (Selected Step Info).

public bool EnableStepDiv { get; set; }

Property Value

bool

EnableStripAvailabilityChart

Availability strip chart (per-step timeline coloured by availability aspect).

public bool EnableStripAvailabilityChart { get; set; }

Property Value

bool

EnableStripRoughnessChart

Surface-roughness strip chart (per-step timeline coloured by surface-roughness aspect).

public bool EnableStripRoughnessChart { get; set; }

Property Value

bool

ForceCycleLineDiv

Cycle-line chart of cutting force along the step's rotation cycle.

public bool ForceCycleLineDiv { get; set; }

Property Value

bool

MessageTable

Session messages panel.

public bool MessageTable { get; set; }

Property Value

bool

SensorSpindleMomentCycleLineDiv

Cycle-line chart of sensor-measured spindle moment (overlay on sim moment).

public bool SensorSpindleMomentCycleLineDiv { get; set; }

Property Value

bool

SimSpindleMomentCycleLineDiv

Cycle-line chart of simulation-derived spindle moment on spindle-rotation coordinate.

public bool SimSpindleMomentCycleLineDiv { get; set; }

Property Value

bool

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

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.