Files
wwtools/aot/reference/CMxCustomEnum.md
T
Joseph Doherty 32f26272ae Initial commit: Wonderware / System Platform tools and reference
Five tools under one repo, all docs organized per DOCS-GUIDE.md:

- aalogcli: .NET 4.8 / x86 CliFx CLI for reading System Platform binary
  logs (*.aaLGX) for LLM debugging, built on aaOpenSource/aaLog. Commands:
  last, tail, range, unread, fields. Stable JSON envelope under --llm-json.
  Build template under lib/build/ for rebuilding aaLogReader.dll.

- aot: ArchestrA Object Toolkit 2014 v4.0 reference material. Dev guide
  (Markdown converted from CHM), API reference for the ArchestrA.Toolkit
  namespace, and the Monitor / Watchdog VS sample solutions.

- graccesscli: .NET 4.8 / x86 CliFx CLI that automates Galaxy
  configuration via the ArchestrA GRAccess COM interop. Includes session
  daemon, IPC protocol, and llm-json envelope contract.

- grdb: SQL/DDL exploration of the Galaxy Repository database. DDL
  captures, reusable queries, hierarchy / contained-name <-> tag-name
  translation notes.

- histdb: LLM-oriented reference for AVEVA Historian retrieval. INSQL
  linked-server, extension tables, every wwXxx time-domain extension,
  every retrieval mode, alarm/event SQL recipes, REST API. Distilled
  from the 243-page Historian Retrieval Guide.

Root contains:
- CLAUDE.md: thin index pointing into each tool's README.
- DOCS-GUIDE.md: doctrine for organizing docs for LLM consumption.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-03 18:22:20 -04:00

3.6 KiB

CMxCustomEnum Class

Namespace: ArchestrA.Toolkit

CMxCustomEnum is derived from CMxCommon and provides support for Enum Attributes.

Syntax

public class CMxCustomEnum : CMxCommon

CMxCustomEnum Properties

Value Property

Provides a property to get and set the ordinal value as a short.

Syntax

public short Value { get; set; }

Returns

short

Text Property

Provides a property to get and set the text value as a string.

Syntax

public string Text { get; set; }

Returns

string

CMxCustomEnum Constructors

CMxCustomEnum Constructor

Provides a default constructor.

Syntax

public CMxCustomEnum();

CMxCustomEnum Constructor (string, int)

Provides a constructor to initialize the class with the name of an array and its depth relative to the owning object.

Syntax

public CMxCustomEnum(string arrayAttribute, int depth);

Parameters

arrayAttribute

[in] string value that holds the name of the string array attribute.

depth

[in] int value that holds the depth of the string array attribute primitive.

CMxCustomEnum Constructor (SupportWrapper, string)

Provides a constructor to initialize the class for use in a primitive wrapper.

Syntax

public CMxCustomEnum(SupportWrapper _wrapper, string _attributeRef);

Parameters

_wrapper

[in] SupportWrapper.

_attributeRef

[in] string value that holds the attribute reference name.

CMxCustomEnum Constructor (string, int, short)

Provides a constructor to initialize the class with the name of an array, its depth relative to the owning object and the default ordinal as a short.

Syntax

public CMxCustomEnum(string arrayAttribute, int depth, short val);

Parameters

arrayAttribute

String value that holds the name of the referenced string array attribute.

depth

Int value that holds the depth.

The depth assigned to the reference determines the location of the String Array reference (0 represents the local Primitive, -1 represents the Parent, -2 represents the Parents Parent and so on.)

val

Short value that holds the value index.

CMxCustomEnum Method

Set Method

Provides a method to set the value of the Attribute from a CMxCustomEnum.

Syntax

public void Set(CMxCustomEnum val);

Parameters

val

[in] CMxCustomEnum instance value to be set.

CMxCustomEnum Operator Overloads

CMxValue Operator Overload

Provides an operator to convert a CMxCustomEnum into a CMxValue

Syntax

public static implicit operator CMxValue(CMxCustomEnum val);

Parameters

val

[in] CMxCustomEnum value to convert to CMxValue.

Returns

CMxValue

Short Operator Overload

Provides an operator to convert a CMxCustomEnum into a ordinal short.

Syntax

public static implicit operator short(CMxCustomEnum val);

Parameters

val

[in] CMxCustomEnum value to convert to short.

Returns

short

CMxCustomEnum Operator Overload (CMxValue)

Provides an operator to convert a CMxValue into a CMxCustomEnum.

Syntax

public static implicit operator CMxCustomEnum(CMxValue val);

Parameters

val

[in] CMxValue value to convert to CMxCustomEnum.

Returns

CMxCustomEnum

CMxCustomEnum Operator Overload (short)

Provides an operator to convert an ordinal short into a CMxCustomEnum.

Syntax

public static implicit operator CMxCustomEnum(short x);

Parameters

x

[in] short value to convert to CMxCustomEnum.

Returns

CMxCustomEnum