Class SiemensSystemVariableSyntax

Namespace

Hi.NcParsers.EvaluationSyntaxs.Siemens

Assembly

HiMech.dll

Consumes writes to Sinumerik $ system variables the pipeline does not simulate ($TC_DP… handled elsewhere aside, e.g. $AC_TIME, $SC_…, non-TR $P_UIFR components). Siemens counterpart of the Fanuc record-only FanucSystemControlVariableSyntax pattern:

public class SiemensSystemVariableSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource

Inheritance

object

SiemensSystemVariableSyntax

Implements

ISituNcSyntax

INcSyntax

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)

Examples

#BeforeBuild:

{
  "Parsing": { "Assignments": { "$SC_PA_ACTIV_IMMED": "1" } }
}

#AfterBuild:

{
  "Vars": { "SystemNamed": { "$SC_PA_ACTIV_IMMED": 1 } }
}

Remarks

1. records the literal write on the block JSON under Vars.SystemNamed (round-trip and cache-dump visibility), carried forward block-by-block;
2. emits a SiemensSystemVariable--Unsupported UnsupportedMessage(ISentenceCarrier, string, string, object) so the user knows the assignment was recognised but its controller-side effect is not simulated (Message severity — safe no-op offline);
3. removes the entry from Parsing.Assignments so it does not re-surface as a generic Parsing--Unconsumed diagnostic.

MUST run after SiemensUifrWritingSyntax — this syntax is the $-catchall; the UIFR bridge owns the simulated subset. Only literal numeric RHS values are consumed; non-literal RHS is left for VariableEvaluatorSyntax.

Constructors

SiemensSystemVariableSyntax()

Default constructor.

public SiemensSystemVariableSyntax()

SiemensSystemVariableSyntax(XElement)

Loads from an XML element produced by MakeXmlSource(string, string, bool). No state to deserialise.

public SiemensSystemVariableSyntax(XElement src)

Parameters

src XElement

Fields

UnsupportedDiagId

Diagnostic id emitted for every consumed unsimulated $ assignment — recognised by the parser, ignored by simulation.

public const string UnsupportedDiagId = "SiemensSystemVariable--Unsupported"

Field Value

string

Properties

Name

Syntax kind name (typically the concrete type name).

public string Name { get; }

Property Value

string

XName

XML element name for Generators registration.

public static string XName { get; }

Property Value

string

Methods

Build(LazyLinkedListNode<SyntaxPiece>, List<INcDependency>, NcDiagnosticProgress)

Build syntax arrangement into the syntaxPieceNode in-place.

public void Build(LazyLinkedListNode<SyntaxPiece> syntaxPieceNode, List<INcDependency> ncDependencyList, NcDiagnosticProgress ncDiagnosticProgress)

Parameters

syntaxPieceNode LazyLinkedListNode<SyntaxPiece>

ncDependencyList List<INcDependency>

ncDiagnosticProgress NcDiagnosticProgress

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