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>
This commit is contained in:
@@ -0,0 +1,981 @@
|
||||
# AObjectBase Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
AObjectBase class is the base class of the ConfigtimeBase and RuntimeBase classes.
|
||||
|
||||
Provides common functionality for configtime and runtime classes like Dictionary access, Logger access, Attribute Get and Put, Register and Unregister of Configtime/Runtime sethandlers.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class AObjectBase : _APrimitiveBase
|
||||
```
|
||||
|
||||
## AObjectBase Properties
|
||||
|
||||
### AObjectInstance Property
|
||||
|
||||
Provides access to set/get the instance of the object class.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public object AObjectInstance { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
object
|
||||
|
||||
### ClassName Property
|
||||
|
||||
Provides access to the name of the object class.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string ClassName { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### DictionaryInstance Property
|
||||
|
||||
Provides access to the Dictionary for this object.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public Dictionary DictionaryInstance { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
Dictionary
|
||||
|
||||
### MajorVersion Property
|
||||
|
||||
Provides access to the major version of this object.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string MajorVersion { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### MinorVersion Property
|
||||
|
||||
Provides access to the minor version of this object.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string MinorVersion { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### Runtime Property
|
||||
|
||||
Provides indication if the object is currently in runtime or configtime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool Runtime { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
true: when executing in runtime code.
|
||||
|
||||
false: when executing in configtime code.
|
||||
|
||||
### Tagname Property
|
||||
|
||||
Provides access to the Tagname of the object.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string Tagname { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
## AObjectBase Methods
|
||||
|
||||
### AddErrorMessage Method
|
||||
|
||||
Provides a method to add an error message to the site.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void AddErrorMessage(string message);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`message`**
|
||||
|
||||
string value that holds the message.
|
||||
|
||||
### AddWarningMessage Method
|
||||
|
||||
Provides a method to add a warning message to the site.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void AddWarningMessage(string message);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`message`**
|
||||
|
||||
string value that holds the message.
|
||||
|
||||
### AttributeExists Method
|
||||
|
||||
Provides a method to check the existence of an Attribute by name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool AttributeExists(string fullName);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`fullName`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### FormatError Method (Exception)
|
||||
|
||||
Provides a method to generate a formatted exception string from an exception.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
protected string FormatError(Exception ex);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`ex`**
|
||||
|
||||
Exception value to be formatted.
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### FormatError Method (string, Exception)
|
||||
|
||||
Provides a detailed method to generate a formatted exception string from an exception and add additional information to the exception string.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
protected string FormatError(
|
||||
string localMessage,
|
||||
Exception ex
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`localMessage`**
|
||||
|
||||
Additional information to add to the exception message.
|
||||
|
||||
**`ex`**
|
||||
|
||||
Exception value to be formatted.
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
This is a concatenation of the localMessage string and the formatted exception string.
|
||||
|
||||
### Get Method (string, EATTRIBUTEPROPERTY)
|
||||
|
||||
Provides a method to get the value of an Attribute’s property by name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxValue Get(
|
||||
string fullName,
|
||||
EATTRIBUTEPROPERTY property
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`fullName`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**`property`**
|
||||
|
||||
Attribute property to access.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### Get Method (short, short, EATTRIBUTEPROPERTY)
|
||||
|
||||
Provides a method to get the value of an Attribute’s property by ID and primitive ID.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxValue Get(
|
||||
short attributeId,
|
||||
short primitiveId,
|
||||
EATTRIBUTEPROPERTY propertyId
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`attributeId`**
|
||||
|
||||
Attribute ID.
|
||||
|
||||
**`primitiveId`**
|
||||
|
||||
Primitive ID.
|
||||
|
||||
**`propertyId`**
|
||||
|
||||
Attribute property to access.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### GetAttributeHandle Method
|
||||
|
||||
Provides a method to get an Attribute handle by name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public AttributeHandle GetAttributeHandle(string fullName);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`fullName`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**Returns**
|
||||
|
||||
AttributeHandle
|
||||
|
||||
### GetIsLocked Method (string)
|
||||
|
||||
Provides a method to get the Lock Status of an attribute by name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool GetIsLocked(string fullName);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`fullName`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
true: if the attribute is locked.
|
||||
|
||||
false: if the attribute is unlocked.
|
||||
|
||||
### GetIsLocked Method (short, short)
|
||||
|
||||
Provides a method to get the Lock Status of an attribute by ID and primitive ID.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool GetIsLocked(
|
||||
short attributeId,
|
||||
short primitiveId
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`attributeId`**
|
||||
|
||||
Attribute ID.
|
||||
|
||||
**`primitiveId`**
|
||||
|
||||
Primitive ID.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
true: if the attribute is locked.
|
||||
|
||||
false: if the attribute is unlocked.
|
||||
|
||||
### GetName Method
|
||||
|
||||
Provides a method to get the name of an attribute by ID and primitive ID.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string GetName(
|
||||
short attributeId,
|
||||
short primitiveId
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`attributeId`**
|
||||
|
||||
Attribute ID.
|
||||
|
||||
**`primitiveId`**
|
||||
|
||||
Primitive ID.
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### GetNumElements Method (string)
|
||||
|
||||
Provides a method to get the number of elements of an attribute by name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public int GetNumElements(string fullName);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`fullName`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**Returns**
|
||||
|
||||
int
|
||||
|
||||
Returns -1 in case of a non-array attribute.
|
||||
|
||||
### GetNumElements Method (short, short)
|
||||
|
||||
Provides a method to get the number of elements of an attribute by ID and primitive ID.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public int GetNumElements(
|
||||
short attributeId,
|
||||
short primitiveId
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`attributeId`**
|
||||
|
||||
Attribute ID.
|
||||
|
||||
**`primitiveId`**
|
||||
|
||||
Primitive ID.
|
||||
|
||||
**Returns**
|
||||
|
||||
int
|
||||
|
||||
Returns -1 in case of a non-array attribute.
|
||||
|
||||
### GetPrimitiveID Method
|
||||
|
||||
Provides a method to get a primitive ID by name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public short GetPrimitiveID(string primName);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`primName`**
|
||||
|
||||
Primitive internal name.
|
||||
|
||||
**Returns**
|
||||
|
||||
short
|
||||
|
||||
### GetSecurityClassification Method (string)
|
||||
|
||||
Provides a method to get the Security Classification of an attribute by name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxSecurityClassification GetSecurityClassification(string fullName);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`fullName`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**Returns**
|
||||
|
||||
MxSecurityClassification
|
||||
|
||||
### GetSecurityClassification Method (short, short)
|
||||
|
||||
Provides a method to get the Security Classification of an attribute by ID and primitive ID.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxSecurityClassification GetSecurityClassification(
|
||||
short attributeId,
|
||||
short primitiveId
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`attributeId`**
|
||||
|
||||
Attribute ID.
|
||||
|
||||
**`primitiveId`**
|
||||
|
||||
Primitive ID.
|
||||
|
||||
**Returns**
|
||||
|
||||
MxSecurityClassification
|
||||
|
||||
### GetText Method (int)
|
||||
|
||||
Provides a method to get a string from the dictionary by int ID.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string GetText(int phraseId);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`phraseId`**
|
||||
|
||||
PhraseId that exists in the dictionary.
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### GetText Method (string)
|
||||
|
||||
Provides a method to get a string from the dictionary by string ID.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string GetText(string phraseId);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`phraseId`**
|
||||
|
||||
PhraseId that exists in the dictionary.
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### GetType Method (string)
|
||||
|
||||
Provides a method to get the type of an attribute by name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxDataType GetType(string fullName);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`fullName`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**Returns**
|
||||
|
||||
MxDataType
|
||||
|
||||
### GetType Method (short, short)
|
||||
|
||||
Provides a method to get the type of an attribute by ID and primitive ID.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxDataType GetType(
|
||||
short attributeId,
|
||||
short primitiveId
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`attributeId`**
|
||||
|
||||
Attribute ID.
|
||||
|
||||
**`primitiveId`**
|
||||
|
||||
Primitive ID.
|
||||
|
||||
**Returns**
|
||||
|
||||
MxDataType
|
||||
|
||||
### GetValue Method (string)
|
||||
|
||||
Provides a method to get the value of an Attribute by name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxValue GetValue(string fullName);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`fullName`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### GetValue Method (short, short)
|
||||
|
||||
Provides a method to get the value of an Attribute by attribute ID and primitive ID.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxValue GetValue(
|
||||
short attributeId,
|
||||
short primitiveId
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`attributeId`**
|
||||
|
||||
Attribute ID.
|
||||
|
||||
**`primitiveId`**
|
||||
|
||||
Primitive ID.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### LogError Method
|
||||
|
||||
Provides a method to write an error message to the logger.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void LogError(string _message);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_message`**
|
||||
|
||||
string value that holds the error message to be logged.
|
||||
|
||||
### LogException Method
|
||||
|
||||
Provides a method to write a formatted exception to the logger.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void LogException(Exception ex);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`ex`**
|
||||
|
||||
Exception value to be logged.
|
||||
|
||||
### LogInfo Method
|
||||
|
||||
Provides a method to write an information message to the logger.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void LogInfo(string _message);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_message`**
|
||||
|
||||
string value that holds information to be logged.
|
||||
|
||||
### LogTrace Method
|
||||
|
||||
Provides a method to write a trace message to the logger.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void LogTrace(string _message);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_message`**
|
||||
|
||||
string value that holds trace message to be logged.
|
||||
|
||||
### LogWarning Method
|
||||
|
||||
Provides a method to write a warning message to the logger.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void LogWarning(string _message);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_message`**
|
||||
|
||||
string value that holds warning message to be logged.
|
||||
|
||||
### RegisterConfigtimeSetHandler Method
|
||||
|
||||
Provides a method to register the configtime set handler of an Attribute by name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void RegisterConfigtimeSetHandler(
|
||||
string _attrName,
|
||||
ConfigtimeSetHandlerDelegate _handler
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_attrName`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**`_handler`**
|
||||
|
||||
Handle of configtime set handler delegate.
|
||||
|
||||
### RegisterRuntimeSetHandler Method
|
||||
|
||||
Provides a method to register a runtime set handler to an Attribute by name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void RegisterRuntimeSetHandler(
|
||||
string attrName,
|
||||
RuntimeSetHandlerDelegate handler
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`attrName`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**`handler`**
|
||||
|
||||
Handle of runtime set handler delegate.
|
||||
|
||||
### Set Method (string, EATTRIBUTEPROPERTY, object)
|
||||
|
||||
Provides a method to set the value of a property of an Attribute by Attribute name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(
|
||||
string fullName,
|
||||
EATTRIBUTEPROPERTY property,
|
||||
object value
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`fullName`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**`property`**
|
||||
|
||||
Property type.
|
||||
|
||||
**`value`**
|
||||
|
||||
Value to set.
|
||||
|
||||
### Set Method (short, short, EATTRIBUTEPROPERTY, CMxValue)
|
||||
|
||||
Provides a method to set the value of a property of an Attribute by ID and primitive ID.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(
|
||||
short attributeId,
|
||||
short primitiveId,
|
||||
EATTRIBUTEPROPERTY propertyId,
|
||||
CMxValue val
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`attributeId`**
|
||||
|
||||
Attribute ID.
|
||||
|
||||
**`primitiveId`**
|
||||
|
||||
Primitive ID.
|
||||
|
||||
**`propertyId`**
|
||||
|
||||
Property type.
|
||||
|
||||
**`val`**
|
||||
|
||||
Value to set.
|
||||
|
||||
### SetNumElements Method (string, int)
|
||||
|
||||
Provides a method to set the number of elements of an Attribute by name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void SetNumElements(
|
||||
string fullName,
|
||||
int numElements
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`fullName`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**`numElements`**
|
||||
|
||||
Number of elements to set.
|
||||
|
||||
### SetNumElements Method (short, short, int)
|
||||
|
||||
Provides a method to set the number of elements of an Attribute by ID and primitive ID.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void SetNumElements(
|
||||
short attributeId,
|
||||
short primitiveId,
|
||||
int numElements
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`attributeId`**
|
||||
|
||||
Attribute ID.
|
||||
|
||||
**`primitiveId`**
|
||||
|
||||
Primitive ID.
|
||||
|
||||
**`numElements`**
|
||||
|
||||
Number of elements to set.
|
||||
|
||||
### SetValue Method (string, object)
|
||||
|
||||
Provides a method to set the value of an Attribute by name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void SetValue(
|
||||
string fullName,
|
||||
object value
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`fullName`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**`value`**
|
||||
|
||||
Value to set.
|
||||
|
||||
### SetValue Method (short, short, CMxValue)
|
||||
|
||||
Provides a method to set the value of an Attribute by attribute Id and primitive Id.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void SetValue(
|
||||
short attributeId,
|
||||
short primitiveId,
|
||||
CMxValue val
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`attributeId`**
|
||||
|
||||
Attribute ID.
|
||||
|
||||
**`primitiveId`**
|
||||
|
||||
Primitive ID.
|
||||
|
||||
**`val`**
|
||||
|
||||
Value to set.
|
||||
|
||||
### StoreObject Method
|
||||
|
||||
Provides a method to encode a C# object into a custom structure.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxCustomStruct StoreObject(
|
||||
int id,
|
||||
object obj
|
||||
);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`id`**
|
||||
|
||||
ID of the CustomStruct.
|
||||
|
||||
**`obj`**
|
||||
|
||||
C# object to be stored.
|
||||
|
||||
**Returns**
|
||||
|
||||
MxCustomStruct
|
||||
|
||||
### UnregisterConfigtimeSetHandler Method
|
||||
|
||||
Provides a method to unregister the configtime set handler of an Attribute by name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void UnregisterConfigtimeSetHandler(string _attrName);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_attrName`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
### UnregisterRuntimeSetHandler Method
|
||||
|
||||
Provides a method to unregister the runtime set handler of an Attribute by name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void UnregisterRuntimeSetHandler(string attrName);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`attrName`**
|
||||
|
||||
Attribute external name.
|
||||
@@ -0,0 +1,73 @@
|
||||
# CMxArrayBase Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxArrayBase is derived from CMxType and provides the default implementation for all array types.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public abstract class CMxArrayBase : CMxType
|
||||
```
|
||||
|
||||
## CMxArrayBase Properties
|
||||
|
||||
### DefLength Property
|
||||
|
||||
Provides a property to return a int of the default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
protected abstract int DefLength { get; set; };
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
int
|
||||
|
||||
### Length Property
|
||||
|
||||
Provides a property to get and set the Length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public int Length { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
int
|
||||
|
||||
## CMxArrayBase Constructors
|
||||
|
||||
### CMxArrayBase Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxArrayBase();
|
||||
```
|
||||
|
||||
### CMxArrayBase Constructor (SupportWrapper, string)
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxArrayBase(SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds attribute reference.
|
||||
@@ -0,0 +1,33 @@
|
||||
# CMxArray<T> Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxArray is derived from CMxArrayBase. It is a template class that can be implemented for each type to be supported to provide type safe data access.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public abstract class CMxArray<T> : CMxArrayBase
|
||||
```
|
||||
|
||||
## CMxArray<T> Constructor
|
||||
|
||||
### CMxArray
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxArray(SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
@@ -0,0 +1,141 @@
|
||||
# CMxBigString Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxBigString is derived from CMxString and provides support for BigString Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxBigString : CMxString
|
||||
```
|
||||
|
||||
## CMxBigString Constructors
|
||||
|
||||
### CMxBigString Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxBigString();
|
||||
```
|
||||
|
||||
### CMxBigString Constructor string
|
||||
|
||||
Provides a constructor to initialize the object with a string.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxBigString (string v);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`v`**
|
||||
|
||||
[in] string to be set.
|
||||
|
||||
### CMxBigString Constructor SupportWrapper, string
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxBigString (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxBigString Operator Overloads
|
||||
|
||||
### CMxValue Operator Overload CMxBigString
|
||||
|
||||
Provides an operator to convert CMxBigString to CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxBigString val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxBigString value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### String Operator Overload CMxBigString
|
||||
|
||||
Provides an operator to convert CMxBigString to string.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator string(CMxBigString val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxBigString value to convert to string.
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### CMxBigString Operator Overload CMxValue
|
||||
|
||||
Provides an operator to convert CMxValue to CMxBigString.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxBigString(CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxBigString.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxBigString
|
||||
|
||||
### CMxBigString Operator Overload string
|
||||
|
||||
Provides an operator to convert string to CMxBigString.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxBigString(string val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] string value to convert to CMxBigString.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxBigString
|
||||
@@ -0,0 +1,147 @@
|
||||
# CMxBigStringArray Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxBigStringArray is derived from CMxStringArray and provides support for BigString Array Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxBigStringArray : CMxStringArray
|
||||
```
|
||||
|
||||
## CMxBigStringArray Constructors
|
||||
|
||||
### CMxBigStringArray Constructor int
|
||||
|
||||
Provides a constructor to initialize the array to a default length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxBigStringArray(int length);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`length`**
|
||||
|
||||
[in] integer value that holds the array length.
|
||||
|
||||
### CMxBigStringArray Constructor string[ ]
|
||||
|
||||
Provides a constructor to initialize the class with a string array default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxBigStringArray (string[] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] string[ ].
|
||||
|
||||
### CMxBigStringArray Constructor SupportWrapper, string
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxBigStringArray (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxBigStringArray Operator Overloads
|
||||
|
||||
### CMxValue Operator Overload CMxBigStringArray
|
||||
|
||||
Provides an operator to convert CMxBigStringArray to CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxBigStringArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxBigStringArray value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### String[] Operator Overload CMxBigStringArray
|
||||
|
||||
Provides an operator to convert CMxBigStringArray to string array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator string[](CMxBigStringArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxBigStringArray value to convert to string[ ].
|
||||
|
||||
**Returns**
|
||||
|
||||
string[ ]
|
||||
|
||||
### CMxBigStringArray Operator Overload CMxValue
|
||||
|
||||
Provides an operator to convert CMxValue to CMxBigStringArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxBigStringArray (CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxBigStringArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxBigStringArray
|
||||
|
||||
### CMxBigStringArray Operator Overload string[ ]
|
||||
|
||||
Provides an operator to convert string array to CMxBigStringArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxBigStringArray (string[] val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] string[ ] value to convert to CMxBigStringArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxBigStringArray
|
||||
@@ -0,0 +1,164 @@
|
||||
# CMxBoolean Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxBoolean is derived from CMxCommon and provides support for Boolean Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxBoolean : CMxCommon
|
||||
```
|
||||
|
||||
## CMxBoolean Property
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as a bool.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
## CMxBoolean Constructors
|
||||
|
||||
### CMxBoolean Constructor
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxBoolean();
|
||||
```
|
||||
|
||||
### CMxBoolean Constructor (bool)
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxBoolean(bool v);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`v`**
|
||||
|
||||
[in] bool value to be set.
|
||||
|
||||
### CMxBoolean Constructor (SupportWrapper, string)
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxBoolean(SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxBoolean Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxBoolean.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxBoolean val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxBoolean value to be set.
|
||||
|
||||
## CMxBoolean Operator Overloads
|
||||
|
||||
### CMxBoolean Operator Overload (bool)
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxBoolean(bool x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] bool value to convert to CMxBoolean.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxBoolean
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxBoolean into a CMxValue.
|
||||
|
||||
```csharp
|
||||
Syntax
|
||||
public static implicit operator CMxValue(CMxBoolean val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxBoolean value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### bool Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxBoolean into a bool.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator bool(CMxBoolean val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxBoolean value to convert to bool.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### CMxBoolean Operator Overload (CMxValue)
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxBoolean(CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxBoolean.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxBoolean
|
||||
@@ -0,0 +1,195 @@
|
||||
# CMxBooleanArray Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxBooleanArray is derived from CMxArray and provides support for Boolean Array Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxBooleanArray : CMxArray<bool>
|
||||
```
|
||||
|
||||
## CMxBooleanArray Properties
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as a bool array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool[] Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
bool[ ]
|
||||
|
||||
### Property to Get and Set Bool Value using the [ ] operator
|
||||
|
||||
Provide a property to get and set the bool value of an element using [ ] operator.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool this[short i] { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
## CMxBooleanArray Constructors
|
||||
|
||||
### CMxBooleanArray Constructor (int)
|
||||
|
||||
Constructor that initializes the array to a default length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxBooleanArray(int length);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`length`**
|
||||
|
||||
[in] int value that holds the length of the array.
|
||||
|
||||
### CMxBooleanArray Constructor (bool[ ])
|
||||
|
||||
Provides a constructor to initialize the array with a bool array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxBooleanArray(bool[] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] bool [ ] value to be set.
|
||||
|
||||
### CMxBooleanArray Constructor (SupportWrapper, string)
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxBooleanArray (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxBooleanArray Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxBooleanArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxBooleanArray newValue);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`newValue`**
|
||||
|
||||
[in] CMxBooleanArray value to be set.
|
||||
|
||||
## CMxBooleanArray Operator Overloads
|
||||
|
||||
### CMxBooleanArray Operator Overload (bool[ ])
|
||||
|
||||
Provides an operator to convert a bool array into a CMxBooleanArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxBooleanArray(bool[] val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] bool [ ] value to convert to CMxBooleanArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxBooleanArray
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxBooleanArray into a CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxBooleanArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxBooleanArray value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### Bool[ ] Overload
|
||||
|
||||
Provides an operator to convert a CMxBooleanArray into a bool array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator bool[](CMxBooleanArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxBooleanArray value to convert to bool[].
|
||||
|
||||
**Returns**
|
||||
|
||||
bool[ ]
|
||||
|
||||
### CMxBooleanArray Operator Overload (CMxValue)
|
||||
|
||||
Provides an operator to convert a CMxValue into a CMxBooleanArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
static implicit operator CMxBooleanArray(CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxBooleanArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxBooleanArray
|
||||
@@ -0,0 +1,59 @@
|
||||
# CMxCommon Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxCommon is derived from CMxType and provides the default implementation for all non-array types.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public abstract class CMxCommon : CMxType
|
||||
```
|
||||
|
||||
## CMxCommon Property
|
||||
|
||||
### DefaultValue Property
|
||||
|
||||
Provides a property to hold the default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public object defaultValue;
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
object
|
||||
|
||||
## CMxCommon Constructors
|
||||
|
||||
### CMxCommon Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
CMxCommon();
|
||||
```
|
||||
|
||||
### CMxCommon Constructor (SupportWrapper, string)
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxCommon(SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds attribute reference.
|
||||
@@ -0,0 +1,219 @@
|
||||
# CMxCustomEnum Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxCustomEnum is derived from CMxCommon and provides support for Enum Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxCustomEnum : CMxCommon
|
||||
```
|
||||
|
||||
## CMxCustomEnum Properties
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the ordinal value as a short.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public short Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
short
|
||||
|
||||
### Text Property
|
||||
|
||||
Provides a property to get and set the text value as a string.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string Text { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
## CMxCustomEnum Constructors
|
||||
|
||||
### CMxCustomEnum Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
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**
|
||||
|
||||
```csharp
|
||||
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**
|
||||
|
||||
```csharp
|
||||
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**
|
||||
|
||||
```csharp
|
||||
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**
|
||||
|
||||
```csharp
|
||||
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**
|
||||
|
||||
```csharp
|
||||
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**
|
||||
|
||||
```csharp
|
||||
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**
|
||||
|
||||
```csharp
|
||||
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**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxCustomEnum(short x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] short value to convert to CMxCustomEnum.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxCustomEnum
|
||||
@@ -0,0 +1,269 @@
|
||||
# CMxCustomEnumArray Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxCustomEnumArray is derived from CMxArray and provides support for Enum Array Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxCustomEnumArray : CMxArray<short>
|
||||
```
|
||||
|
||||
## CMxCustomEnumArray Properties
|
||||
|
||||
### Text Property
|
||||
|
||||
Provides an EnumText to allow accessing elements as strings.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public EnumText Text;
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
EnumText
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the values of the ordinals as a short array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public short[] Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
short[ ]
|
||||
|
||||
### Property to get and set the value of an ordinal
|
||||
|
||||
Provides a property to get and set the value of an ordinal element by short index.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public short this[short i] { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
short
|
||||
|
||||
## CMxCustomEnumArray Constructors
|
||||
|
||||
### CMxCustomEnumArray 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 an array of ordinals as short.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxCustomEnumArray(string arrayAttribute, int depth, short[] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`arrayAttribute`**
|
||||
|
||||
[in] string value that holds the name of the string array attribute.
|
||||
|
||||
**`depth`**
|
||||
|
||||
[in] int value that holds the relative depth of the string array attribute primitive.
|
||||
|
||||
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.)
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] short[ ] value that holds the ordinal values.
|
||||
|
||||
### CMxCustomEnumArray Constructor (string, int, int)
|
||||
|
||||
Provides a constructor to initialize the class with the name of an array, its depth relative to the owning object and the default length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxCustomEnumArray(string arrayAttribute, int depth, int length);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`arrayAttribute`**
|
||||
|
||||
[in] string value that holds the name of the string array attribute.
|
||||
|
||||
**`depth`**
|
||||
|
||||
[in] int value that holds the relative depth of the string array attribute primitive.
|
||||
|
||||
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.)
|
||||
|
||||
**`length`**
|
||||
|
||||
[in] int value that holds the array length.
|
||||
|
||||
### CMxCustomEnumArray Constructor (SupportWrapper, string)
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxCustomEnumArray(SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxCustomEnumArray Methods
|
||||
|
||||
### GetString Method
|
||||
|
||||
Provides a method to get the value of an element from an ordinal as a short.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string GetString(short i);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`i`**
|
||||
|
||||
[in] short value that holds the index.
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### SetString Method
|
||||
|
||||
Provides a method to set the value of an element from a string.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void SetString(short i, string value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`i`**
|
||||
|
||||
[in] short value that holds the index.
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] string value to be set.
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxCustomEnumArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxCustomEnumArray newValue);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`newValue`**
|
||||
|
||||
[in] CMxCustomEnumArray value to be set.
|
||||
|
||||
## CMxCustomEnumArray Operator Overloads
|
||||
|
||||
### CMxCustomEnumArray Operator Overload (short[ ])
|
||||
|
||||
Provides an operator to convert a short array into a CMxCustomEnumArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxCustomEnumArray(short[] val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] short[ ] value to convert to CMxCustomEnumArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxCustomEnumArray
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxCustomEnumArray into CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxCustomEnumArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxCustomEnumArray value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### Short Operator Overload
|
||||
|
||||
Provide an operator to convert a CMxCustomEnumArray into a short array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator short[](CMxCustomEnumArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxCustomEnumArray value to convert to short[ ].
|
||||
|
||||
**Returns**
|
||||
|
||||
short[ ]
|
||||
|
||||
### CMxCustomEnumArray Operator Overload
|
||||
|
||||
Provides a operator to convert a CMxValue into a CMxCustomEnumArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxCustomEnumArray(CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxCustomEnumArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxCustomEnumArray
|
||||
@@ -0,0 +1,205 @@
|
||||
# CMxCustomStruct Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxCustomStruct is derived from CMxCommon and provides support for custom data in the form of a guid and byte array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxCustomStruct : CMxCommon
|
||||
```
|
||||
|
||||
## CMxCustomStruct Property
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as an MxCustomStruct.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxCustomStruct Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
MxCustomStruct
|
||||
|
||||
## CMxCustomStruct Constructors
|
||||
|
||||
### CMxCustomStruct Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxCustomStruct();
|
||||
```
|
||||
|
||||
### CMxCustomStruct Constructor (int)
|
||||
|
||||
Provides a constructor to initialize struct with an ID.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxCustomStruct(int id);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`id`**
|
||||
|
||||
[in] int value that holds the ID.
|
||||
|
||||
### CMxCustomStruct Constructor (SupportWrapper, string)
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxCustomStruct(SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxCustomStruct Method
|
||||
|
||||
### GetObject Method
|
||||
|
||||
Provides a method to retrieve a serialized C# object from the data in a CMxCustomStruct.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public object GetObject();
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
object
|
||||
|
||||
### StoreObject Method
|
||||
|
||||
Provides a method to serialize and store a C# object into the data of a CMxCustomStruct.
|
||||
|
||||
Syntax
|
||||
|
||||
```csharp
|
||||
public void StoreObject(object obj);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`obj`**
|
||||
|
||||
[in] C# object to be stored.
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxCustomStruct.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxCustomStruct val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxCustomStruct value to be set.
|
||||
|
||||
## CMxCustomStruct Operator Overloads
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxCustomStruct into a CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxCustomStruct val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxCustomStruct value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### MxCustomStruct Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxCustomStruct into a MxCustomStruct.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator MxCustomStruct(CMxCustomStruct val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxCustomStruct value to convert to MxCustomStruct.
|
||||
|
||||
**Returns**
|
||||
|
||||
MxCustomStruct
|
||||
|
||||
### CMxCustomStruct Operator Overload (CMxValue)
|
||||
|
||||
Provides an operator to convert a CMxValue into a CMxCustomStruct.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxCustomStruct(CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxCustomStruct.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxCustomStruct
|
||||
|
||||
### CMxCustomStruct Operator Overload (MxCustomStruct)
|
||||
|
||||
Provides an operator to convert a MxCustomStruct into a CMxCustomStruct.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxCustomStruct(MxCustomStruct x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] MxCustomStruct value to convert to CMxCustomStruct.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxCustomStruct
|
||||
@@ -0,0 +1,215 @@
|
||||
# CMxCustomStructArray Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxCustomStructArray is derived from CMxArray and provides support for an array of custom data in the form of a guid and byte array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxCustomStructArray : CMxArray<MxCustomStruct>
|
||||
```
|
||||
|
||||
## CMxCustomStructArray Properties
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as an MxCustomStruct array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxCustomStruct[] Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
MxCustomStruct[ ]
|
||||
|
||||
### Property to get and set value as a MxCustomStruct
|
||||
|
||||
Provides a property to get and set the value of an element as an MxCustomStruct.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxCustomStruct this[short i] { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
MxCustomStruct
|
||||
|
||||
## CMxCustomStructArray Constructors
|
||||
|
||||
### CMxCustomStructArray Constructor (int)
|
||||
|
||||
Provides a constructor to initialize the CustomStructArray with a length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxCustomStructArray(int length);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`length`**
|
||||
|
||||
[in] int value that holds the length of the array.
|
||||
|
||||
### CMxCustomStructArray Constructor (int, int)
|
||||
|
||||
Provides a constructor to initialize CustomStructArray with an ID and length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxCustomStructArray(int id, int length);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`id`**
|
||||
|
||||
[in] int value that holds the ID.
|
||||
|
||||
**`length`**
|
||||
|
||||
[in] int value that holds the array length.
|
||||
|
||||
### CMxCustomStructArray Constructor (MxCustomStruct[ ])
|
||||
|
||||
Provides a constructor to initialize CustomStructArray with an array of MxCustomStruct.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxCustomStructArray(MxCustomStruct[] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] MxCustomStruct[ ] value to be set.
|
||||
|
||||
### CMxCustomStructArray Constructor (SupportWrapper, string)
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxCustomStruct(SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxCustomStructArray Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxCustomStructArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxCustomStructArray newValue);’
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`newValue`**
|
||||
|
||||
[in] CMxCustomStructArray value to be set.
|
||||
|
||||
## CMxCustomStructArray Operator Overloads
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxCustomStructArray into a CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxCustomStructArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxCustomStructArray value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### MxCustomStruct [ ]Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxCustomStructArray into a MxCustomStruct array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator MxCustomStruct[] (CMxCustomStructArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxCustomStructArray value to convert to MxCustomStruct[ ].
|
||||
|
||||
**Returns**
|
||||
|
||||
MxCustomStruct[ ]
|
||||
|
||||
### CMxCustomStructArray Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxValue into a CMxCustomStructArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxCustomStructArray(CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxCustomStructArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxCustomStructArray
|
||||
|
||||
### CMxCustomStructArray Operator Overload
|
||||
|
||||
Provides an operator to convert a MxCustomStruct array into a CMxCustomStructArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxCustomStructArray(MxCustomStruct[] val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] MxCustomStruct[ ] value to convert to CMxCustomStructArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxCustomStructArray
|
||||
@@ -0,0 +1,231 @@
|
||||
# CMxDataQuality Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
A wrapper class for handling MxDataQuality. Indicates the data quality of an associated value as the OPC-compliant data quality word.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxDataQuality
|
||||
```
|
||||
|
||||
**Remarks**
|
||||
|
||||
The high order byte is reserved by ArchestrA (do not use) as allowed by the OPC specification.
|
||||
|
||||
## CMxDataQuality Property
|
||||
|
||||
### Quality Property
|
||||
|
||||
Provides a property to store the quality as a short.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public short quality;
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
short
|
||||
|
||||
## CMxDataQuality Constructors
|
||||
|
||||
### CMxDataQuality Constructor
|
||||
|
||||
Provides a constructor that creates a data quality with a default initial value (bad).
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDataQuality();
|
||||
```
|
||||
|
||||
### CMxDataQuality Constructor DataQuality
|
||||
|
||||
Provides a constructor to create a data quality with an initial value of DataQuality type.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDataQuality(DataQuality dataQuality);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`dataQuality`**
|
||||
|
||||
[in] DataQuality value to be set.
|
||||
|
||||
### CMxDataQuality Constructor OpcQuality
|
||||
|
||||
Provides a constructor to create a data quality with an initial value of OpcQuality type.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDataQuality(OpcQuality opcQuality);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`opcQuality`**
|
||||
|
||||
[in] OpcQuality value to be set.
|
||||
|
||||
### CMxDataQuality Constructor short
|
||||
|
||||
Provides a constructor to create a data quality with an initial value of short type.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDataQuality(short q);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`q`**
|
||||
|
||||
[in] short.
|
||||
|
||||
## CMxDataQuality Methods
|
||||
|
||||
### IsBad Method
|
||||
|
||||
Provides a method to check if the current quality is bad.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool isBad { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### IsGood Method
|
||||
|
||||
Provides a method to check if the current quality is good.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool isGood { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### IsInitializing Method
|
||||
|
||||
Provides a method to check if the current quality is initializing.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool isInitializing { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### IsUncertain Method
|
||||
|
||||
Provides a method to check if the current quality is uncertain.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool isUncertain { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
## CMxDataQuality Operator Overloads
|
||||
|
||||
### CMxValue Operator Overload CMxDataQuality
|
||||
|
||||
Provides an operator that converts from CMxDataQuality to CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxDataQuality x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] CMxDataQuality value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### DataQuality Operator Overload CMxDataQuality
|
||||
|
||||
Provides an operator that converts from CMxDataQuality to DataQuality.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator DataQuality(CMxDataQuality x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] CMxDataQuality value to convert to DataQuality.
|
||||
|
||||
**Returns**
|
||||
|
||||
DataQuality
|
||||
|
||||
### CMxDataQuality Operator Overload DataQuality
|
||||
|
||||
Provides an operator that converts from DataQuality to CMxDataQuality.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxDataQuality(DataQuality x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] DataQuality value to convert to CMxDataQuality.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxDataQuality
|
||||
|
||||
### CMxDataQuality Operator Overload OpcQuality
|
||||
|
||||
Provides an operator that converts from OpcQuality to CMxDataQuality.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxDataQuality(OpcQuality x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] OpcQuality value to convert to CMxDataQuality.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxDataQuality
|
||||
@@ -0,0 +1,171 @@
|
||||
# CMxDataType Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxDataType is derived from CMxCommon and provides support for MxDataType Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxDataType : CMxCommon
|
||||
```
|
||||
|
||||
## CMxDataType Property
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as an MxDataType.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxDataType Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
MxDataType
|
||||
|
||||
## CMxDataType Constructors
|
||||
|
||||
### CMxDataType Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDataType();
|
||||
```
|
||||
|
||||
### CMxDataType Constructor (MxDataType)
|
||||
|
||||
Provides a constructor to initialize the class with a MxDataType default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDataType (MxDataType v);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`v`**
|
||||
|
||||
[in] MxDataType value to be set.
|
||||
|
||||
### CMxDataType Constructor (SupportWrapper, string)
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDataType (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
string value that holds the attribute reference.
|
||||
|
||||
## CMxDataType Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxDataType.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxDataType val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxDataType value to be set
|
||||
|
||||
## CMxDataType Operator Overloads
|
||||
|
||||
### CMxDataType Operator Overload (MxDataType)
|
||||
|
||||
Provides an operator to convert a MxDataType into a CMxDataType.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxDataType(MxDataType x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] MxDataType value to convert to CMxDataType.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxDataType
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxDataType into a CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxDataType val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxDataType value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### MxDataType Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxDataType into a MxDataType.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator MxDataType(CMxDataType val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxDataType value to convert to MxDataType.
|
||||
|
||||
**Returns**
|
||||
|
||||
MxDataType
|
||||
|
||||
### CMxDataType Operator Overload (CMxValue)
|
||||
|
||||
Provides an operator to convert a CMxValue into a CMxDataType.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxDataType(CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxDataType.
|
||||
@@ -0,0 +1,195 @@
|
||||
# CMxDataTypeArray Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxDataTypeArray is derived from CMxArray and provides support for MxDataType Array Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxDataTypeArray : CMxArray<MxDataType>
|
||||
```
|
||||
|
||||
## CMxDataTypeArray Properties
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as a MxDataType array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxDataType[] Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
MxDataType[ ]
|
||||
|
||||
### Property to Get and Set the MxDatatype using the [ ] Operator
|
||||
|
||||
Provides a property to get and set the MxDataType value of an element using [ ] operator.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxDataType this[short i] { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
MxDataType
|
||||
|
||||
## CMxDataTypeArray Constructors
|
||||
|
||||
### CMxDataTypeArray Constructor (int)
|
||||
|
||||
Provides a constructor to initialize the array to a default length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDataTypeArray(int length);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`length`**
|
||||
|
||||
[in] int value that holds the length of the array.
|
||||
|
||||
### CMxDataTypeArray Constructor (MxDataType[ ])
|
||||
|
||||
Provides a constructor to initialize the class with a MxDataType array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDataTypeArray (MxDataType[] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] MxDataType[ ] value to be set.
|
||||
|
||||
### CMxDataTypeArray Constructor (SupportWrapper, string)
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDataTypeArray (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxDataTypeArray Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxDataTypeArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxDataTypeArray newValue);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`newValue`**
|
||||
|
||||
[in] CMxDataTypeArray value to be set
|
||||
|
||||
## CMxDataTypeArray Operator Overloads
|
||||
|
||||
### CMxDataTypeArray Operator Overload (MxDataType[ ])
|
||||
|
||||
Provides a operator to convert a MxDataType array into a CMxDataTypeArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxDataTypeArray(MxDataType[] val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] MxDataType[ ] value to convert to CMxDataTypeArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxDataTypeArray
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxDataTypeArray into a CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxDataTypeArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxDataTypeArray value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### MxDataType Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxDataTypeArray into a MxDataType array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator MxDataType[](CMxDataTypeArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxDataTypeArray value to convert to MxDataType[ ].
|
||||
|
||||
**Returns**
|
||||
|
||||
MxDataType[ ]
|
||||
|
||||
### CMxDataTypeArray Operator Overload (CMxValue)
|
||||
|
||||
Provides an operator to convert a CMxValue into a CMxDataTypeArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxDataTypeArray (CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
CMxDataTypeArray
|
||||
|
||||
**Returns**
|
||||
|
||||
[in] CMxValue value to convert to DataTypeArray.
|
||||
@@ -0,0 +1,175 @@
|
||||
# CMxDouble Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxDouble is derived from CMxCommon and provides support for Double Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxDouble : CMxCommon
|
||||
```
|
||||
|
||||
## CMxDouble Property
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as a double.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public double Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
double
|
||||
|
||||
## CMxDouble Constructors
|
||||
|
||||
### CMxDouble Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDouble();
|
||||
```
|
||||
|
||||
### CMxDouble Constructor (double)
|
||||
|
||||
Provides a constructor to initialize the class with a double default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDouble (double v);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`v`**
|
||||
|
||||
[in] double value to be set.
|
||||
|
||||
### CMxDouble Constructor (SupportWrapper, string)
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDouble (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in]string value that holds attribute reference.
|
||||
|
||||
## CMxDouble Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxDouble.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxDouble val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxDouble value to be set.
|
||||
|
||||
## CMxDouble Operator Overloads
|
||||
|
||||
### CMxDouble Operator Overload (double)
|
||||
|
||||
Provides an operator to convert a double into a CMxDouble.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxDouble(double x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] double value to convert to CMxDouble.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxDouble
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxDouble into a CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxDouble val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxDouble value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### Double Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxDouble into a double.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator double (CMxDouble val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to double.
|
||||
|
||||
**Returns**
|
||||
|
||||
double
|
||||
|
||||
### CMxDouble Operator Overload (CMxValue)
|
||||
|
||||
Provides an operator to convert a CMxValue into a CMxDouble.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxDouble (CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxDouble.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxDouble
|
||||
@@ -0,0 +1,195 @@
|
||||
# CMxDoubleArray Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxDoubleArray is derived from CMxArray and provides support for Double Array Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxDoubleArray : CMxArray<double>
|
||||
```
|
||||
|
||||
## CMxDoubleArray Properties
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as a double array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public double [] Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
double [ ]
|
||||
|
||||
### Property to Get and Set Double Value using [ ] Operator
|
||||
|
||||
Provides a property to get and set the double value of an element using [ ] operator.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public double this[short i] { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
double
|
||||
|
||||
## CMxDoubleArray Constructors
|
||||
|
||||
### CMxDoubleArray Constructor (int)
|
||||
|
||||
Provides a constructor to initialize the array to a default length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDoubleArray(int length);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`length`**
|
||||
|
||||
[in] int value that holds the length of array.
|
||||
|
||||
### CMxDoubleArray Constructor (double[ ])
|
||||
|
||||
Provides a constructor to initialize the class with a double array default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDoubleArray(double [] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] double [ ] value to be set.
|
||||
|
||||
### CMxDoubleArray Constructor (SupportWrapper, string)
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDoubleArray (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxDoubleArray Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxDoubleArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxDoubleArray newValue);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`newValue`**
|
||||
|
||||
[in] CMxDoubleArray value to be set.
|
||||
|
||||
## CMxDoubleArray Operator Overloads
|
||||
|
||||
### CMxDoubleArray Operator Overload (double[ ])
|
||||
|
||||
Provides an operator to convert a double array into a CMxDoubleArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxDoubleArray(double [] val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] double [ ] value to convert to CMxDoubleArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxDoubleArray
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxDoubleArray into a CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxDoubleArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxDoubleArray value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### Double Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxDoubleArray into a double array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator double [](CMxDoubleArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxDoubleArray value to convert to double [].
|
||||
|
||||
**Returns**
|
||||
|
||||
double
|
||||
|
||||
### CMxDoubleArray Operator Overload (CMxValue)
|
||||
|
||||
Provides an operator to convert a CMxValue into a CMxDoubleArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxDoubleArray(CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxDoubleArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxDoubleArray
|
||||
@@ -0,0 +1,423 @@
|
||||
# CMxElapsedTime Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxElapsedTime is derived from CMxCommon and provides support for Elapsed time/Timespan Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxElapsedTime : CMxCommon
|
||||
```
|
||||
|
||||
## CMxElapsedTime Property
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as a TimeSpan.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public TimeSpan Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
TimeSpan
|
||||
|
||||
## CMxElapsedTime Constructors
|
||||
|
||||
### CMxElapsedTime Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxElapsedTime();
|
||||
```
|
||||
|
||||
### CMxElapsedTime Constructor (TimeSpan)
|
||||
|
||||
Provides a constructor to initialize the class with a TimeSpan default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxElapsedTime (TimeSpan v);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`v`**
|
||||
|
||||
[in] TimeSpan value to be set.
|
||||
|
||||
### CMxElapsedTime Constructor (string)
|
||||
|
||||
Provides a constructor to initialize the class with a formatted time string default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxElapsedTime(string timeString);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`timeString`**
|
||||
|
||||
[in] string value that holds the time.
|
||||
|
||||
### CMxElapsedTime Constructor (SupportWrapper, string)
|
||||
|
||||
Provides a constructor that initializes the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxElapsedTime (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxElapsedTime Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Sets the value of the Attribute from a CMxElapsedTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxElapsedTime val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxElapsedTime value to be set.
|
||||
|
||||
## CMxElapsedTime Operator Overloads
|
||||
|
||||
### CMxElapsedTime Operator Overload (TimeSpan)
|
||||
|
||||
Provides an operator to convert a MxDataType into a CMxElapsedTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxElapsedTime(TimeSpan x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] TimeSpan value to convert to CMxElapsedTime.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxElapsedTime
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxElapsedTime into a CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxElapsedTime val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxElapsedTime value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### TimeSpan Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxElapsedTime into a MxDataType.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator TimeSpan (CMxElapsedTime val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxElapsedTime value to convert to TimeSpan.
|
||||
|
||||
**Returns**
|
||||
|
||||
TimeSpan
|
||||
|
||||
### CMxElapsedTime Operator Overload (CMxValue)
|
||||
|
||||
Provides an operator to convert a CMxValue into a CMxElapsedTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxElapsedTime (CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxElapsedTime.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxElapsedTime
|
||||
|
||||
### - Operator Overload (CMxElapsedTime)
|
||||
|
||||
Provides an operator to subtract a CMxElapsedTime from a CMxElapsedTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static TimeSpan operator -(CMxElapsedTime t);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t`**
|
||||
|
||||
[in] CMxElapsedTime value.
|
||||
|
||||
**Returns**
|
||||
|
||||
TimeSpan
|
||||
|
||||
### - Operator Overload (CMxElapsedTime, TimeSpan)
|
||||
|
||||
Provides an operator to subtract a TimeSpan from a CMxElapsedTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static TimeSpan operator -(CMxElapsedTime t1, TimeSpan t2);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t1`**
|
||||
|
||||
[in] CMxElapsedTime value.
|
||||
|
||||
**`t2`**
|
||||
|
||||
[in] TimeSpan value.
|
||||
|
||||
**Returns**
|
||||
|
||||
TimeSpan
|
||||
|
||||
### != Operator Overload
|
||||
|
||||
Provides an operator to compare a CMxElapsedtime with a TimeSpan.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static bool operator !=(CMxElapsedTime t1, TimeSpan t2);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t1`**
|
||||
|
||||
[in] CMxElapsedTime value.
|
||||
|
||||
**`t2`**
|
||||
|
||||
[in] TimeSpan value.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### + Operator Overload (CMxElapsedTime)
|
||||
|
||||
Provides an operator to add a CMxElapsedTime to a TimeSpan.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static TimeSpan operator +(CMxElapsedTime t);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t`**
|
||||
|
||||
[in] CMxElapsedTime value.
|
||||
|
||||
**Returns**
|
||||
|
||||
TimeSpan
|
||||
|
||||
### + Operator Overload (CMxElapsedTime, TimeSpan)
|
||||
|
||||
Provides an operator to add a TimeSpan to a CMxElapsedTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static TimeSpan operator +(CMxElapsedTime t, TimeSpan ts);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t`**
|
||||
|
||||
[in] CMxElapsedTime value.
|
||||
|
||||
**`ts`**
|
||||
|
||||
[in] TimeSpan value.
|
||||
|
||||
**Returns**
|
||||
|
||||
TimeSpan
|
||||
|
||||
### < Operator Overload
|
||||
|
||||
Provides an operator to test if a CMxElapsedTime is less than a TimeSpan.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static bool operator <(CMxElapsedTime t1, TimeSpan t2);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t1`**
|
||||
|
||||
[in] CMxElapsedTime value.
|
||||
|
||||
**`t2`**
|
||||
|
||||
[in] TimeSpan.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### <= Operator Overload
|
||||
|
||||
Provides an operator to test if a CMxElapsedTime is less than or equal to a TimeSpan.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static bool operator <=(CMxElapsedTime t1, TimeSpan t2);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t1`**
|
||||
|
||||
[in] CMxElapsedTime value.
|
||||
|
||||
**`t2`**
|
||||
|
||||
[in] TimeSpan value.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### == Operator Overload
|
||||
|
||||
Provides an operator to test if a CMxElapsedTime and a TimeSpan are equal.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static bool operator ==(CMxElapsedTime t1, TimeSpan t2);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t1`**
|
||||
|
||||
[in] CMxElapsedTime value.
|
||||
|
||||
**`t2`**
|
||||
|
||||
[in] TimeSpan value.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### > Operator Overload
|
||||
|
||||
Provides an operator to test if a CMxElapsedTime is greater than a TimeSpan.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static bool operator >(CMxElapsedTime t1, TimeSpan t2);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t1`**
|
||||
|
||||
[in] CMxElapsedTime value.
|
||||
|
||||
**`t2`**
|
||||
|
||||
[in] TimeSpan value.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### >= Operator Overload
|
||||
|
||||
Provides an operator to test if a CMxElapsedTime is greater than or equal to a TimeSpan.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static bool operator >=(CMxElapsedTime t1, TimeSpan t2);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t1`**
|
||||
|
||||
[in] CMxElapsedTime value.
|
||||
|
||||
**`t2`**
|
||||
|
||||
[in] TimeSpan value.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
@@ -0,0 +1,213 @@
|
||||
# CMxElapsedTimeArray Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxElapsedTimeArray is derived from CMxArray and provides support for Elapsed time/Timespan Array Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxElapsedTimeArray : CMxArray<TimeSpan>
|
||||
```
|
||||
|
||||
## CMxElapsedTimeArray Properties
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as a TimeSpan array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public TimeSpan[] Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
TimeSpan[ ]
|
||||
|
||||
### Property to Get and Set the TimeSpan Value using the [ ] Operator
|
||||
|
||||
Provides a property to get and set the TimeSpan value of an element using [ ] operator.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public TimeSpan this[short i] { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
TimeSpan
|
||||
|
||||
## CMxElapsedTimeArray Constructors
|
||||
|
||||
### CMxElapsedTimeArray Constructor (int)
|
||||
|
||||
Provides a constructor to initialize the array to a default length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxElapsedTimeArray(int length);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`length`**
|
||||
|
||||
[in] int value that holds the array length.
|
||||
|
||||
### CMxElapsedTimeArray Constructor (TimeSpan)
|
||||
|
||||
Provide a constructor to initialize the class with a TimeSpan array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxElapsedTimeArray (TimeSpan[] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] TimeSpan[ ] value to be set.
|
||||
|
||||
### CMxElapsedTimeArray Constructor (string)
|
||||
|
||||
Provides a constructor to initialize the class with a formatted time string array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxElapsedTimeArray (string[] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] string[ ] value to be set.
|
||||
|
||||
### CMxElapsedTimeArray Constructor
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxElapsedTimeArray (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string that holds the attribute reference.
|
||||
|
||||
## CMxElapsedTimeArray Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Sets the value of the Attribute from a CMxElapsedTimeArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxElapsedTimeArray newValue);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`newValue`**
|
||||
|
||||
[in] CMxElapsedTimeArray value to be set.
|
||||
|
||||
## CMxElapsedTimeArray Operator Overloads
|
||||
|
||||
### CMxElapsedTimeArray Operator Overload (TimeSpan)
|
||||
|
||||
Provides an operator to convert a TimeSpan array into a CMxElapsedTimeArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxElapsedTimeArray(TimeSpan[] val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] TimeSpan[ ] value to convert to
|
||||
|
||||
CMxElapsedTimeArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxElapsedTimeArray
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxElapsedTimeArray into a CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxElapsedTimeArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxElapsedTimeArray value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### TimeSpan Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxElapsedTimeArray into a TimeSpan array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator TimeSpan[](CMxElapsedTimeArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxElapsedTimeArray value to convert to TimeSpan[ ].
|
||||
|
||||
**Returns**
|
||||
|
||||
TimeSpan[ ]
|
||||
|
||||
### CMxElapsedTimeArray Operator Overload (CMxValue)
|
||||
|
||||
Provides an operator to convert a CMxValue into a CMxElapsedTimeArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxElapsedTimeArray (CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxElapsedTimeArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxElapsedTimeArray
|
||||
@@ -0,0 +1,175 @@
|
||||
# CMxFloat Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxFloat is derived from CMxCommon and provides support for float Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxFloat : CMxCommon
|
||||
```
|
||||
|
||||
## CMxFloat Property
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as a float.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public float Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
float
|
||||
|
||||
## CMxFloat Constructors
|
||||
|
||||
### CMxFloat Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxFloat();
|
||||
```
|
||||
|
||||
### CMxFloat Constructor (float)
|
||||
|
||||
Provides a constructor to initialize the class with a float default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
CMxFloat(float v);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`v`**
|
||||
|
||||
[in] float value to be set.
|
||||
|
||||
### CMxFloat Constructor (SupportWrapper, string)
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxFloat(SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxFloat Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxFloat.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxFloat val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxFloat value to be set.
|
||||
|
||||
## CMxFloat Operator Overloads
|
||||
|
||||
### CMxFloat Operator Overload (float)
|
||||
|
||||
Provides an operator to convert a float into a CMxFloat.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxFloat(float x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] float value to convert to CMxFloat.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxFloat
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxFloat into a CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxFloat val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxFloat to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### Float Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxFloat into a float.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator float(CMxFloat val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxFloat to convert to float.
|
||||
|
||||
**Returns**
|
||||
|
||||
float
|
||||
|
||||
### CMxFloat Operator Overload (CMxValue)
|
||||
|
||||
Provides an operator to convert a CMxValue into a CMxFloat.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxFloat(CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxFloat.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxFloat
|
||||
@@ -0,0 +1,195 @@
|
||||
# CMxFloatArray Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxFloatArray is derived from CMxArray and provides support for float Array Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxFloatArray : CMxArray<float>
|
||||
```
|
||||
|
||||
## CMxFloatArray Properties
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as a float array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public float [] Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
float [ ]
|
||||
|
||||
### Property to get and set using [ ] operator
|
||||
|
||||
Provides a property to get and set the float value of an element using [ ] operator.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public float this[short i] { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
float
|
||||
|
||||
## CMxFloatArray Constructors
|
||||
|
||||
### CMxFloatArray Constructor (int)
|
||||
|
||||
Provides a constructor to initialize the array to a default length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxFloatArray(int length);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`length`**
|
||||
|
||||
[in] integer value that holds array length.
|
||||
|
||||
### CMxFloatArray Constructor (float[ ])
|
||||
|
||||
Provides a constructor to initialize the class with a float array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxFloatArray(float[] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] float[ ] value.
|
||||
|
||||
### CMxFloatArray Constructor (SupportWrapper, string)
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxFloatArray (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxFloatArray Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxFloat Array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxFloatArray newValue);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`newValue`**
|
||||
|
||||
[in] CMxFloatArray value to be set.
|
||||
|
||||
## CMxFloatArray Operator Overloads
|
||||
|
||||
### CMxFloatArray Operator Overload (float[ ])
|
||||
|
||||
Provides an operator to convert a float array into a CMxFloatArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxFloatArray(float[] val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] float[ ] value to convert to CMxFloatArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxFloatArray
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxFloatArray into a CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxFloatArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxFloatArray value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### Float Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxFloatArray into a float array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator float[](CMxFloatArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxFloatArray value to convert to float[].
|
||||
|
||||
**Returns**
|
||||
|
||||
float[ ]
|
||||
|
||||
### CMxFloatArray Operator Overload (CMxValue)
|
||||
|
||||
Provides an operator to convert a CMxValue into a CMxFloatArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxFloatArray(CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxFloatArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxFloatArray
|
||||
@@ -0,0 +1,155 @@
|
||||
# CMxIndirect Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxIndirect is a support class that allows a user to connect to an external attribute and read/write its value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxIndirect : CMxIndirectBase
|
||||
```
|
||||
|
||||
## CMxIndirect Properties
|
||||
|
||||
### Value Property
|
||||
|
||||
Allows a user to read/write the value of the referenced attribute.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxValue Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### DataQualityOfLastRead Property
|
||||
|
||||
There are several methods that cause the value of the referenced attribute to be read, that is, Value, TestRead but they do not directly return the data quality. This property contains the data quality of the last read attribute so that it can be used.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxDataQuality DataQualityOfLastRead { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxDataQuality
|
||||
|
||||
### StatusOfLastRead Property
|
||||
|
||||
There are several methods that cause the value of the referenced attribute to be read, that is, Value, TestRead but do not directly return the status. This property contains the status of the last read so that it can be checked.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxStatus StatusOfLastRead { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
MxStatus
|
||||
|
||||
### TestRead Property
|
||||
|
||||
TestRead performs a read check on the indirect but does not return the value. It returns true if the status of the read was successful. The data quality and full status can be accessed by DataQualityOfLastRead and StatusOfLastRead.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool TestRead { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### TimeStampOfLastRead Property
|
||||
|
||||
There are several methods that cause the value of the referenced attribute to be read, that is, Value, TestRead but do not directly return the timestamp. This property contains the timestamp of the last read so that it can be used.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
DateTime TimeStampOfLastRead { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
DateTime
|
||||
|
||||
## CMxIndirect Constructor
|
||||
|
||||
### CMxIndirect Constructor string,string,IMxSupervisoryConnection3,RuntimeBase, int,short,int
|
||||
|
||||
This is an internal constructor intended for use only in BindTo.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
CMxIndirect(string _fullRefString, string _context, IMxSupervisoryConnection3 _superConn, RuntimeBase _rb, int _refHandle, short _statusId, int _statusIndex)
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_fullRefString`**
|
||||
|
||||
[in] Full reference string of the attribute to bind to.
|
||||
|
||||
**`_context`**
|
||||
|
||||
[in] Context of the reference.
|
||||
|
||||
**`_superConn`**
|
||||
|
||||
[in] A supervisory connection to the runtime.
|
||||
|
||||
**`_rb`**
|
||||
|
||||
[in] handle to the RuntimeBase class instance that created this indirect.
|
||||
|
||||
**`_refHandle`**
|
||||
|
||||
[in] The ArchestrA reference handle of the registered reference.
|
||||
|
||||
**`_statusId`**
|
||||
|
||||
[in] The attribute id of the dynamic array that holds the write status.
|
||||
|
||||
**`_statusIndex`**
|
||||
|
||||
[in] The index of the element in the dynamic status array that this reference uses.
|
||||
|
||||
## CMxIndirect Method
|
||||
|
||||
### Get Method
|
||||
|
||||
Provides a method to get the value, timestamp, and data quality of the referenced attribute in a single operation.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool Get(out CMxValue value, out DateTime timeStamp, out CMxDataQuality quality);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[out] the value of the reference attribute.
|
||||
|
||||
**`timestamp`**
|
||||
|
||||
[out] the timestamp of the reference attribute.
|
||||
|
||||
**`quality`**
|
||||
|
||||
[out] the data quality of the reference attribute.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
@@ -0,0 +1,273 @@
|
||||
# CMxIndirectBase Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxIndirectBase is an inherited class that provides methods and properties common to the two types of Indirects: CMxIndirect and CMxIndirectWriteOnly.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxIndirectBase
|
||||
```
|
||||
|
||||
## CMxIndirectBase Properties
|
||||
|
||||
### Context Property
|
||||
|
||||
The context that was used to create the indirect.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string Context { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### FullReferenceString Property
|
||||
|
||||
The reference string that was used to create the CMXIndirectBase instance.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string FullReferenceString { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### HasTimedOut Property
|
||||
|
||||
Indirects contains a timer that tracks how long it successfully connected to its remote attribute. If this time is longer than the TimeOut value, then this property returns true.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool HasTimedOut { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### RefHandle Property
|
||||
|
||||
The RefHandle is the ArchestrA id for the reference bound to this Indirect.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public int RefHandle { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
int
|
||||
|
||||
### StatusId Property
|
||||
|
||||
The status of a write is written to a dynamic attribute array. This is attribute id of the dynamic array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public short StatusId { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
short
|
||||
|
||||
### StatusIndex Property
|
||||
|
||||
The status of a write is written to a dynamic attribute array. This is the index of the element of that array that this indirect will write its status to.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public int StatusIndex { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
int
|
||||
|
||||
### StatusOfLastWrite Property
|
||||
|
||||
This returns the status value of the last write attempt from the dynamic attribute array.
|
||||
|
||||
A user can monitor this value to seen when a write has completed, successfully or otherwise.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxStatus StatusOfLastWrite { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
MxStatus
|
||||
|
||||
### TimeOut Property
|
||||
|
||||
Allows the user the set the TimeOut used by HasTimedOut.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public TimeSpan TimeOut { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
TimeSpan
|
||||
|
||||
## CMxIndirectBase Constructor
|
||||
|
||||
### CMxIndirectBase Constructor string, string, ArchestrA.Core.IMxSupervisoryConnection3, RuntimeBase, int, short, int
|
||||
|
||||
This is an internal constructor intended for use only by derived classes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
CMxIndirectBase(string _fullRefString, string _context, ArchestrA.Core.IMxSupervisoryConnection3 _superConn, RuntimeBase _rb, int _refHandle, short _statusId, int _statusIndex)
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_fullRefString`**
|
||||
|
||||
[in] Full reference string of the attribute to bind to.
|
||||
|
||||
**`_context`**
|
||||
|
||||
[in] Context of the reference.
|
||||
|
||||
**`_superConn`**
|
||||
|
||||
[in] A supervisory connection to the runtime.
|
||||
|
||||
**`_rb`**
|
||||
|
||||
[in] A handle to the RuntimeBase class instance that created this indirect.
|
||||
|
||||
**`_refHandle`**
|
||||
|
||||
[in] The ArchestrA reference handle of the registered reference.
|
||||
|
||||
**`_statusId`**
|
||||
|
||||
[in] The attribute id of the dynamic array that holds the write status's.
|
||||
|
||||
**`_statusIndex`**
|
||||
|
||||
[in] The index of the element in the dynamic status array that this reference uses.
|
||||
|
||||
## CMxIndirectBase Methods
|
||||
|
||||
### Activate Method
|
||||
|
||||
Activates a suspended indirect.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool Activate();
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### Activate Method(ArchestrA.MessageExchange.IMxCallback2)
|
||||
|
||||
Activates a suspended indirect and allows the user to supply a callback variable.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool Activate(ArchestrA.MessageExchange.IMxCallback2 callback)
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`callback`**
|
||||
|
||||
[in] The callback supplied by the user to be called when the Activate has finished.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### Set Method(CMxValue, DateTime)
|
||||
|
||||
Writes the value and timestamp to the indirect in a single operation.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool Set(CMxValue value, DateTime timeStamp)
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] The value to be written.
|
||||
|
||||
**`timeStamp`**
|
||||
|
||||
[in] The timestamp for the value.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### Suspend Method
|
||||
|
||||
Suspends an active indirect.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool Suspend()
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### Suspend Method (ArchestrA.MessageExchange.IMxCallback2)
|
||||
|
||||
Suspends an active indirect and allows the user to supply a callback variable.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool Suspend(ArchestrA.MessageExchange.IMxCallback2 callback)
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`callback`**
|
||||
|
||||
[in] The callback supplied by the user to be called when the Suspend has finished.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### Unbind Method
|
||||
|
||||
Unbinds the indirect, releasing the ArchestrA reference and dynamic status array index.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Unbind()
|
||||
```
|
||||
@@ -0,0 +1,69 @@
|
||||
# CMxIndirectWriteOnly Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxIndirectWriteOnly is a support class that allows a user to connect to an external attribute and write its value. This type of indirect has less overhead than one that is readable as well as writable.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxIndirectWriteOnly : CMxIndirectBase
|
||||
```
|
||||
|
||||
## CMxIndirectWriteOnly Property
|
||||
|
||||
### Value Property
|
||||
|
||||
Allows a user to set the value of the referenced attribute.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxValue Value { set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
## CMxIndirectWriteOnly Constructor
|
||||
|
||||
### CMxIndirectWriteOnly Constructor string, string, IMxSupervisoryConnection3, RuntimeBase, int, short, int
|
||||
|
||||
This is an internal constructor intended for use only in BindToWriteOnly.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
CMxIndirectWriteOnly(string _fullRefString, string _context, IMxSupervisoryConnection3 _superConn, RuntimeBase _rb, int _refHandle, short _statusId, int _statusIndex)
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_fullRefString`**
|
||||
|
||||
[in] Full reference string of the attribute to bind to.
|
||||
|
||||
**`_context`**
|
||||
|
||||
[in] Context of the reference.
|
||||
|
||||
**`_superConn`**
|
||||
|
||||
[in] A supervisory connection to the runtime.
|
||||
|
||||
**`_rb`**
|
||||
|
||||
[in] handle to the RuntimeBase class instance that created this indirect.
|
||||
|
||||
**`_refHandle`**
|
||||
|
||||
[in] The ArchestrA reference handle of the registered reference.
|
||||
|
||||
**`_statusId`**
|
||||
|
||||
[in] The attribute id of the dynamic array that holds the write status's.
|
||||
|
||||
**`_statusIndex`**
|
||||
|
||||
[in] The index of the element in the dynamic status array that this reference uses.
|
||||
@@ -0,0 +1,175 @@
|
||||
# CMxInteger Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxInteger is derived from CMxCommon and provides support for Integer Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxInteger : CMxCommon
|
||||
```
|
||||
|
||||
## CMxInteger Property
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as an int.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public int Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
int
|
||||
|
||||
## CMxInteger Constructors
|
||||
|
||||
### CMxInteger Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxInteger();
|
||||
```
|
||||
|
||||
### CMxInteger Constructor (int)
|
||||
|
||||
Provides a constructor to initialize the class with an int.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxInteger (int v);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`v`**
|
||||
|
||||
[in] int value to be set.
|
||||
|
||||
### CMxInteger Constructor (SupportWrapper, string)
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxInteger (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxInteger Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxInteger.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxInteger val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxInteger value to be set.
|
||||
|
||||
## CMxInteger Operator Overloads
|
||||
|
||||
### CMxInteger Operator Overload (int)
|
||||
|
||||
Provides an operator to convert an int into a CMxInteger.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxInteger(int x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] int value to convert to CMxInteger.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxInteger
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxInteger into a CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxInteger val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxInteger value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### int Operator Overload (CMxInteger)
|
||||
|
||||
Conversion operator that converts from CMxInteger to int.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator int (CMxInteger val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[i] CMxInteger value to convert to int.
|
||||
|
||||
**Returns**
|
||||
|
||||
int
|
||||
|
||||
### CMxInteger Operator Overload (CMxValue)
|
||||
|
||||
Provides an operator to convert a CMxValue into a CMxInteger.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxInteger (CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxInteger.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxInteger
|
||||
@@ -0,0 +1,195 @@
|
||||
# CMxIntegerArray Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxIntegerArray is derived from CMxArray and provides support for Integer Array Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxIntegerArray : CMxArray<int>
|
||||
```
|
||||
|
||||
## CMxIntegerArray Properties
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as an int array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public int Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
int[ ]
|
||||
|
||||
### Property to Get and Set the Int Value using the [ ] Operator
|
||||
|
||||
Provides a property to get and set the int value of an element using[ ] operator.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public int this[short i] { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
int
|
||||
|
||||
## CMxIntegerArray Constructors
|
||||
|
||||
### CMxIntegerArray Constructor (int)
|
||||
|
||||
Provides a constructor to initialize the array to a default length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxIntegerArray(int length);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`length`**
|
||||
|
||||
[in] integer value that holds the length of the array.
|
||||
|
||||
### CMxIntegerArray Constructor (int[ ])
|
||||
|
||||
Provides a constructor to initialize the class with an int array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxIntegerArray(int [] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] int array value to be set.
|
||||
|
||||
### CMxIntegerArray Constructor (SupportWrapper, string)
|
||||
|
||||
Provide a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxIntegerArray (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxIntegerArray Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxIntegerArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxIntegerArray newValue);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`newValue`**
|
||||
|
||||
[in] CMxIntegerArray instance value to be set.
|
||||
|
||||
## CMxIntegerArray Operator Overloads
|
||||
|
||||
### CMxIntegerArray Operator Overload (int[ ])
|
||||
|
||||
Provides an operator to convert an int array into a CMxInteger Array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxIntegerArray(int [] val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] int [ ] value to convert to CMxIntegerArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxIntegerArray
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxInteger Array into a CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxIntegerArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxIntegerArray to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### int[ ] Operator Overload
|
||||
|
||||
Provides an operator to convert a CMxIntegerArray into an int array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator int [](CMxIntegerArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxIntegerArray to convert to int [].
|
||||
|
||||
**Returns**
|
||||
|
||||
int[ ]
|
||||
|
||||
### CMxIntegerArray Operator Overload (CMxValue)
|
||||
|
||||
Provides an operator to convert a CMxValue into a CMxIntegerArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxIntegerArray(CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue to convert to CMxIntegerArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxIntegerArray
|
||||
@@ -0,0 +1,59 @@
|
||||
# CMxInternalDumpLoadData Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxInternalDumpLoadData class is derived from CMxCustomStruct and provides support for dump/load at Configtime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxInternalDumpLoadData : CMxCustomStruct
|
||||
```
|
||||
|
||||
## CMxInternalDumpLoadData Property
|
||||
|
||||
### StructID Property
|
||||
|
||||
Provides a property to indicate the struct ID for CMxInternalDumpLoadData.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public const int structId = 369875326;
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
int
|
||||
|
||||
## CMxInternalDumpLoadData Constructors
|
||||
|
||||
### CMxInternalDumpLoadData Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxInternalDumpLoadData();
|
||||
```
|
||||
|
||||
### CMxInternalDumpLoadData Constructor SupportWrapper, string
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxInternalDumpLoadData(SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
@@ -0,0 +1,59 @@
|
||||
# CMxInternalFailoverData Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxInternalFailoverData class is derived from CMxCustomStruct and provides support for failover at Runtime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxInternalFailoverData : CMxCustomStruct
|
||||
```
|
||||
|
||||
## CMxInternalFailoverData Property
|
||||
|
||||
### StructID Property
|
||||
|
||||
Provides a property to indicate the struct ID for CMxInternalFailoverData.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public const int structId = 369875325;
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
int
|
||||
|
||||
## CMxInternalFailoverData Constructors
|
||||
|
||||
### CMxInternalFailoverData Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxInternalFailoverData ();
|
||||
```
|
||||
|
||||
### CMxInternalFailoverData Constructor SupportWrapper, string
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxInternalFailoverData (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
@@ -0,0 +1,235 @@
|
||||
# CMxInternationalizedString Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxInternationalizedString is derived from CMxCommon and provides support for Internationalized string Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxInternationalizedString : CMxCommon
|
||||
```
|
||||
|
||||
## CMxInternationalizedString Properties
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as an MxDataType.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxDataType Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
MxDataType
|
||||
|
||||
### Locale Property
|
||||
|
||||
Provides a method return a string of the default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public int Locale { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
int
|
||||
|
||||
## CMxInternationalizedString Constructors
|
||||
|
||||
### CMxInternationalizedString Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxInternationalizedString ();
|
||||
```
|
||||
|
||||
### CMxInternationalizedString Constructor CMxValue
|
||||
|
||||
Provides a constructor that initializes the class with a CMxValue default Value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxInternationalizedString (CMxValue v);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`v`**
|
||||
|
||||
[in] CMxValue instance value.
|
||||
|
||||
### CMxInternationalizedString Constructor string
|
||||
|
||||
Provides a constructor that initializes the class with a string default Value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxInternationalizedString (string v);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`v`**
|
||||
|
||||
[in] string value.
|
||||
|
||||
### CMxInternationalizedString Constructor SupportWrapper, string
|
||||
|
||||
Provides a constructor that initializes the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxInternationalizedString (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxInternationalizedString Methods
|
||||
|
||||
## GetString Method
|
||||
|
||||
## SetString Method
|
||||
|
||||
## Set Method
|
||||
|
||||
## CMxInternationalizedString Operator Overloads
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator that converts from CMxInternationalizedString to CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxInternationalizedString val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxInternationalizedString instance.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### CMxString Operator Overload
|
||||
|
||||
Provides an operator that converts from CMxInternationalizedString to CMxString.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxString(CMxInternationalizedString val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxInternationalizedString instance.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxString
|
||||
|
||||
### string operator Overload
|
||||
|
||||
Provides an operator that converts from CMxInternationalizedString to string.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator string(CMxInternationalizedString val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxInternationalizedString instance value.
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### CMxInternationalizedString Operator Overload CMxString
|
||||
|
||||
Provides an operator that converts from CMxString to CMxInternationalizedString.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxInternationalizedString(CMxString val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxString instance value.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxInternationalizedString
|
||||
|
||||
### CMxInternationalizedString Operator Overload CMxValue
|
||||
|
||||
Provides an operator that converts from CMxValue to CMxInternationalizedString.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxInternationalizedString(CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxInternationalizedString
|
||||
|
||||
### CMxInternationalizedString Operator Overload string
|
||||
|
||||
Provides an operator that converts from string to CMxInternationalizedString.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxInternationalizedString(string x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] string.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxInternationalizedString
|
||||
@@ -0,0 +1,317 @@
|
||||
# CMxInternationalizedStringArray Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxInternationalizedStringArray is derived from CMxArray and provides support for Arrays of Internationalized Strings.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxInternationalizedStringArray : CMxArray<string>
|
||||
```
|
||||
|
||||
## CMxInternationalizedStringArray Properties
|
||||
|
||||
### Locale Property
|
||||
|
||||
Provides a property to gets or set the current locale.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public int Locale { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
int
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value of the current locale as an array of strings.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string[] Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string[ ]
|
||||
|
||||
### Property to get and set current locale as a string
|
||||
|
||||
Provides a property to get and set value of a specified element of the current locale as a string.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string this[short i] { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
## CMxInternationalizedStringArray Constructors
|
||||
|
||||
### CMxInternationalizedStringArray Constructor int
|
||||
|
||||
Provides a constructor to initialize the array to a default length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxInternationalizedStringArray(int length);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`length`**
|
||||
|
||||
[in] int value that holds the array length.
|
||||
|
||||
### CMxInternationalizedStringArray Constructor string[]
|
||||
|
||||
Provides a constructor to initialize the array with an array of strings.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxInternationalizedStringArray(string[] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] string[ ].
|
||||
|
||||
### CMxInternationalizedStringArray Constructor SupportWrapper, string
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxInternationalizedStringArray(SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxInternationalizedStringArray Methods
|
||||
|
||||
### GetString Method
|
||||
|
||||
Provides a method to get the value of an element by locale.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string GetString(short index, int _locale);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`index`**
|
||||
|
||||
[in] index of the element.
|
||||
|
||||
**`locale`**
|
||||
|
||||
[in] int value that holds the locale.
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### GetStrings Method
|
||||
|
||||
Provides a method to get the value of all elements by locale.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string[] GetStrings(int _locale);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`locale`**
|
||||
|
||||
[in] Int value that holds the locale.
|
||||
|
||||
**Returns**
|
||||
|
||||
string[ ]
|
||||
|
||||
### SetString Method
|
||||
|
||||
Provides a method to set the value of a element by locale.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void SetString(short index, int _locale, string val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`index`**
|
||||
|
||||
[in] index of the element.
|
||||
|
||||
**`locale`**
|
||||
|
||||
[in] Int value that holds the locale to be set.
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] string that holds the value to be set.
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxInternationalizedStringArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxInternationalizedStringArray newValue);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxInternationalizedStringArray value to be set.
|
||||
|
||||
## CMxInternationalizedStringArray Operator Overloads
|
||||
|
||||
### string[ ] Operator Overload
|
||||
|
||||
Provides an operator that converts from CMxInternationalizedStringArray to string array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator string[](CMxInternationalizedStringArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxInternationalizedStringArray instance value.
|
||||
|
||||
**Returns**
|
||||
|
||||
string[ ]
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator that converts from CMxInternationalizedStringArray to CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxInternationalizedStringArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxInternationalizedStringArray instance value.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### CMxStringArray Operator Overload
|
||||
|
||||
Provides an operator that converts from CMxInternationalizedStringArray to CMxStringArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxStringArray(CMxInternationalizedStringArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxInternationalizedStringArray instance value.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxStringArray
|
||||
|
||||
### CMxInternationalizedStringArray Operator Overload CMxStringArray
|
||||
|
||||
Provides an operator that converts from CMxStringArray to CMxInternationalizedStringArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxInternationalizedStringArray(CMxStringArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxStringArray instance value.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxInternationalizedStringArray
|
||||
|
||||
### CMxInternationalizedStringArray Operator Overload CMxValue
|
||||
|
||||
Provides an operator that converts from CMxValue to CMxInternationalizedStringArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxInternationalizedStringArray(CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue instance value.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxInternationalizedStringArray
|
||||
|
||||
### CMxInternationalizedStringArray Operator Overload string[ ]
|
||||
|
||||
Provides an operator that converts from string array to CMxInternationalizedStringArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxInternationalizedStringArray(string[] val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] string[ ].
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxInternationalizedStringArray
|
||||
@@ -0,0 +1,175 @@
|
||||
# CMxReference Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxReference is derived from CMxCommon and provides support for Reference Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxReference : CMxCommon
|
||||
```
|
||||
|
||||
## CMxReference Property
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get or set the value as a full reference string.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
## CMxReference Constructors
|
||||
|
||||
### CMxReference Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxReference ();
|
||||
```
|
||||
|
||||
### CMxReference Constructor string
|
||||
|
||||
Provides a constructor to initialize the class with a full reference string.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxReference (string v);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`v`**
|
||||
|
||||
[in] string value that holds the reference.
|
||||
|
||||
### CMxReference Constructor SupportWrapper, string
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxReference (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxReference Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxReference.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxReference val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxReference value.
|
||||
|
||||
## CMxReference Operator Overloads
|
||||
|
||||
### CMxReference Operator Overload string
|
||||
|
||||
Provides an operator that converts from full reference string to CMxReference.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxReference (string x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] string to convert to CMxReference.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxReference
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator that converts from CMxReference to CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxReference val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxReference value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### string Operator Overload
|
||||
|
||||
Provides an operator that converts from CMxReference to full reference string.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator string (CMxReference val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxReference value to convert to string.
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### CMxReference Operator Overload CMxValue
|
||||
|
||||
Provides an operator that converts from CMxValue to CMxReference.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxReference (CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxReference.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxReference
|
||||
@@ -0,0 +1,195 @@
|
||||
# CMxReferenceArray Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxReferenceArray is derived from CMxArray and provides support for Reference Array Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxReferenceArray : CMxArray<string>
|
||||
```
|
||||
|
||||
## CMxReferenceArray Properties
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get or set the value as a string array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string[] Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string[ ]
|
||||
|
||||
### Property to Get and Set an Element using the [ ] Operator
|
||||
|
||||
Provides a property to get or set the string value of an element using [ ] operator.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string this[short i] { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
## CMxReferenceArray Constructors
|
||||
|
||||
### CMxReferenceArray Constructor int
|
||||
|
||||
Provides a constructor to initialize the array to a default length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxReferenceArray(int length);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`length`**
|
||||
|
||||
[in] int value that holds the array length.
|
||||
|
||||
### CMxReferenceArray Constructor string[ ]
|
||||
|
||||
Provides a constructor to initialize the class with a string array default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxReferenceArray (string[] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] string[ ].
|
||||
|
||||
### CMxReferenceArray Constructor SupportWrapper, string
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxReferenceArray (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] int value that holds the array length.
|
||||
|
||||
## CMxReferenceArray Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxReferenceArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxReferenceArray newValue);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`newValue`**
|
||||
|
||||
[in] CMxReferenceArray instance value.
|
||||
|
||||
## CMxReferenceArray Operator Overloads
|
||||
|
||||
### CMxReferenceArray Operator Overload string[ ]
|
||||
|
||||
Provides an operator that converts from string array to CMxReferenceArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxReferenceArray(string [] val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] string [ ].
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxReferenceArray
|
||||
|
||||
### CMxValue Operator Overload
|
||||
|
||||
Provides an operator that converts from CMxReferenceArray to CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxReferenceArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxReferenceArray instance value.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### String[ ] Operator Overload
|
||||
|
||||
Provides an operator that converts from CMxReferenceArray to string array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator string [](CMxReferenceArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxReferenceArray instance value.
|
||||
|
||||
**Returns**
|
||||
|
||||
string [ ]
|
||||
|
||||
### CMxReferenceArray Operator Overload CMxValue
|
||||
|
||||
Provides an operator that converts from CMxValue to CMxReferenceArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxReferenceArray (CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue instance value.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxReferenceArray
|
||||
@@ -0,0 +1,175 @@
|
||||
# CMxStatus Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxStatus is derived from CMxCommon and provides support for MxStatus Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxStatus : CMxCommon
|
||||
```
|
||||
|
||||
## CMxStatus Property
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a Property to get and set the value as an MxStatus.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxStatus Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
MxStatus
|
||||
|
||||
## CMxStatus Constructors
|
||||
|
||||
### CMxStatus Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxStatus();
|
||||
```
|
||||
|
||||
### CMxStatus Constructor MxStatus
|
||||
|
||||
Provides a constructor to initialize the class with an MxStatus.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxStatus (MxStatus v);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`v`**
|
||||
|
||||
[in] MxStatus value to be set.
|
||||
|
||||
### CMxStatus Constructor SupportWrapper, string
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxStatus (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper value to be set.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxStatus Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxStatus.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxStatus val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxStatus value to be set.
|
||||
|
||||
## CMxStatus Operator Overloads
|
||||
|
||||
### CMxStatus Operator Overload MxStatus
|
||||
|
||||
Provides an operator that converts from MxStatus to CMxStatus.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxStatus(MxStatus x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] MxStatus value to convert to CMxStatus.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxStatus
|
||||
|
||||
### CMxStatus Operator Overload CMxValue
|
||||
|
||||
Provides an operator that converts from CMxValue to CMxStatus.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxStatus(CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxStatus.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxStatus
|
||||
|
||||
### CMxValue Operator Overload CMxStatus
|
||||
|
||||
Provides an operator that converts from CMxStatus to CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue (CMxStatus val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxStatus value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### MxStatus Operator Overload CMxStatus
|
||||
|
||||
Provides an operator that converts from CMxStatus to MxStatus.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator MxStatus (CMxStatus val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxStatus value to convert to MxStatus.
|
||||
|
||||
**Returns**
|
||||
|
||||
MxStatus
|
||||
@@ -0,0 +1,195 @@
|
||||
# CMxStatusArray Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxStatusArray is derived from CMxArray and provides support for MxStatus Array Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxStatusArray : CMxArray<MxStatus>
|
||||
```
|
||||
|
||||
## CMxStatusArray Properties
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a Property to get and set the value as a MxStatus array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxStatus[] Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
MxStatus[ ]
|
||||
|
||||
### Property to Get and Set the MxStatus Value using the [ ] Operator
|
||||
|
||||
Provide a property to get and set the MxStatus value of an element using [] Operator.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public MxStatus this[short i] { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
MxStatus
|
||||
|
||||
## CMxStatusArray Constructors
|
||||
|
||||
### CMxStatusArray Constructor int
|
||||
|
||||
Provides a constructor to initialize the array to a default length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxStatusArray(int length);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`length`**
|
||||
|
||||
[in] integer value that holds the array length.
|
||||
|
||||
### CMxStatusArray Constructor MxStatus[ ]
|
||||
|
||||
Provides a constructor to initialize the class with an MxStatus array default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxStatusArray (MxStatus[] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] MxStatus[ ] value to be set.
|
||||
|
||||
### CMxStatusArray Constructor SupportWrapper, string
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxStatusArray (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxStatusArray Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxStatusArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxStatusArray newValue);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`newValue`**
|
||||
|
||||
[in] CMxStatusArray value to be set.
|
||||
|
||||
## CMxStatusArray Operator Overloads
|
||||
|
||||
### CMxStatusArray Operator Overload MxStatus[ ]
|
||||
|
||||
Provides an operator that converts from MxStatus array to CMxStatusArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxStatusArray(MxStatus[] val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] MxStatus[ ] value to convert to CMxStatusArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxStatusArray
|
||||
|
||||
### CMxStatusArray Operator Overload CMxValue
|
||||
|
||||
Provides an operator that converts from CMxValue to CMxStatusArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxStatusArray(CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxStatusArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxStatusArray
|
||||
|
||||
### MxStatus[ ] Operator Overload CMxStatusArray
|
||||
|
||||
Provides an operator that converts from CMxStatusArray to a MxStatus array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator MxStatus[](CMxStatusArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxStatusArray value to convert to MxStatus[ ].
|
||||
|
||||
**Returns**
|
||||
|
||||
MxStatus[ ]
|
||||
|
||||
### CMxValue Operator Overload CMxStatusArray
|
||||
|
||||
Provides an operator that converts from CMxStatusArray to CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxStatusArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxStatusArray value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
@@ -0,0 +1,175 @@
|
||||
# CMxString Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxString is derived from CMxCommon and provides support for string Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxString : CMxCommon
|
||||
```
|
||||
|
||||
## CMxString Property
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as a string.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
## CMxString Constructors
|
||||
|
||||
### CMxString Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxString();
|
||||
```
|
||||
|
||||
### CMxString Constructor string
|
||||
|
||||
Provides a constructor to initialize the class with a string.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxStatus (string v);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`v`**
|
||||
|
||||
[in] string value to be set.
|
||||
|
||||
### CMxString Constructor SupportWrapper, string
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxString (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxString Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxString.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxString val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxString value to be set.
|
||||
|
||||
## CMxString Operator Overloads
|
||||
|
||||
### CMxString Operator Overload string
|
||||
|
||||
Provides an operator that converts from string to CMxString.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxString (string x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] string value to convert to CMxString.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxString
|
||||
|
||||
### CMxString Operator Overload CMxValue
|
||||
|
||||
Provides an operator that converts from CMxValue to CMxString.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxString (CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxString.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxString
|
||||
|
||||
### CMxValue Operator Overload CMxString
|
||||
|
||||
Provides an operator that converts from CMxString to CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxString val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxString value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### string Operator Overload CMxString
|
||||
|
||||
Provides an operator that converts from CMxString to string.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator string (CMxString val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxString value to convert to string.
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
@@ -0,0 +1,195 @@
|
||||
# CMxStringArray Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxStringArray is derived from CMxArray and provides support for string Array Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxStringArray : CMxArray<string>
|
||||
```
|
||||
|
||||
## CMxStringArray Properties
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as a string array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string[] Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string[ ]
|
||||
|
||||
### Property to Get and Get the String using the [ ] Operator
|
||||
|
||||
Provides a property to get and set the string value of an element using [] Operator.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string this[short i] { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
## CMxStringArray Constructors
|
||||
|
||||
### CMxStringArray Constructor int
|
||||
|
||||
Provides a constructor to initialize the array to a default length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxStringArray(int length);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`length`**
|
||||
|
||||
[in] integer value that holds the array length.
|
||||
|
||||
### CMxStringArray Constructor string[ ]
|
||||
|
||||
Provides a constructor to initialize the class with a string array default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxStringArray(string[] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] string[ ] value
|
||||
|
||||
### CMxStringArray Constructor SupportWrapper, string
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxStringArray (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxStringArray Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxStringArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxStringArray newValue);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`newValue`**
|
||||
|
||||
[in] CMxStringArray value to be set.
|
||||
|
||||
## CMxStringArray Operator Overloads
|
||||
|
||||
### CMxStringArray Operator Overload string[ ]
|
||||
|
||||
Provides an operator that converts from string array to CMxStringArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxStringArray (string[] val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] string[ ] to convert to CMxStringArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxStringArray
|
||||
|
||||
### CMxStringArray Operator Overload CMxValue
|
||||
|
||||
Provides an operator that converts from CMxValue to CMxStringArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxStringArray (CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxStringArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxStringArray
|
||||
|
||||
### string[ ] Operator Overload CMxStringArray
|
||||
|
||||
Provides an operator that converts from CMxStringArray to string array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator string[](CMxStringArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxStringArray value to convert to string array.
|
||||
|
||||
**Returns**
|
||||
|
||||
string[ ]
|
||||
|
||||
### CMxValue Operator Overload CMxStringArray
|
||||
|
||||
Provides an operator that converts from CMxStringArray to CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxStringArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxStringArray value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
@@ -0,0 +1,407 @@
|
||||
# CMxTime Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxTime is derived from CMxCommon and provides support for Time/DateTime Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxTime : CMxCommon
|
||||
```
|
||||
|
||||
## CMxTime Property
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as a DateTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public DateTime Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
DateTime
|
||||
|
||||
## CMxTime Constructors
|
||||
|
||||
### CMxTime Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxTime();
|
||||
```
|
||||
|
||||
### CMxTime Constructor DateTime
|
||||
|
||||
Provides a constructor to initialize the class with a DateTime default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxTime (DateTime v);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`v`**
|
||||
|
||||
[in] DateTime instance value to be set.
|
||||
|
||||
### CMxTime Constructor string
|
||||
|
||||
Provides a constructor to initialize the class with a formatted time string default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxTime(string v);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`v`**
|
||||
|
||||
[in] string value to be set.
|
||||
|
||||
### CMxTime Constructor SupportWrapper, string
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxTime (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxTime Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxTime val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxTime value to be set.
|
||||
|
||||
## CMxTime Operator Overloads
|
||||
|
||||
### CMxTime Operator Overload DateTime
|
||||
|
||||
Provides an operator that converts from DateTime to CMxTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxTime(DateTime x);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`x`**
|
||||
|
||||
[in] DateTime value to convert to CMxTime.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxTime
|
||||
|
||||
### CMxTime Operator Overload CMxValue
|
||||
|
||||
Provides an operator that converts from CMxValue to CMxTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxTime (CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxTime.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxTime
|
||||
|
||||
### CMxValue Operator Overload CMxTime
|
||||
|
||||
Provides an operator that converts from CMxTime to CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxTime val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxTime value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### DateTime Operator Overload CMxTime
|
||||
|
||||
Provides an operator that converts from CMxTime to DateTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator DateTime (CMxTime val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxTime value to convert to DateTime.
|
||||
|
||||
**Returns**
|
||||
|
||||
DateTime
|
||||
|
||||
### - Operator Overload CMxTime, DateTime (TimeSpan)
|
||||
|
||||
Provides an operator to subtract a DateTime from a CMxTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static TimeSpan operator -(CMxTime t1, DateTime t2);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t1`**
|
||||
|
||||
[in] CMxTime value.
|
||||
|
||||
**`t2`**
|
||||
|
||||
[in] DateTime value.
|
||||
|
||||
**Returns**
|
||||
|
||||
TimeSpan
|
||||
|
||||
### - Operator Overload CMxTime, TimeSpan (DateTime)
|
||||
|
||||
Provides an operator to subtract a TimeSpan from a CMxTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static DateTime operator -(CMxTime t1, TimeSpan t2);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t1`**
|
||||
|
||||
[in] CMxTime value.
|
||||
|
||||
**`t2`**
|
||||
|
||||
[in] TimeSpan value.
|
||||
|
||||
**Returns**
|
||||
|
||||
DateTime
|
||||
|
||||
### != Operator Overload CMxTime, DateTime (bool)
|
||||
|
||||
Provides an operator to check if a CMxTime and DateTime are not equal.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static bool operator !=(CMxTime t1, DateTime t2);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t1`**
|
||||
|
||||
[in] CMxTime value.
|
||||
|
||||
**`t2`**
|
||||
|
||||
[in] DateTime value.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### + Operator Overload CMxTime, TimeSpan (DateTime)
|
||||
|
||||
Provides an operator to add a TimeSpan to a CMxTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static DateTime operator +(CMxTime t, TimeSpan ts);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t`**
|
||||
|
||||
[in] CMxTime value.
|
||||
|
||||
**`ts`**
|
||||
|
||||
[in] TimeSpan value.
|
||||
|
||||
**Returns**
|
||||
|
||||
DateTime
|
||||
|
||||
### < Operator Overload CMxTime, DateTime (bool)
|
||||
|
||||
Provides an operator to check if a CMxTime is less than a DateTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static bool operator <(CMxTime t1, DateTime t2);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t1`**
|
||||
|
||||
[in] CMxTime value.
|
||||
|
||||
**`t2`**
|
||||
|
||||
[in] DateTime value.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### <= Operator Overload CMxTime, DateTime (bool)
|
||||
|
||||
Provides an operator to check if a CMxTime is less than or equal to a DateTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static bool operator <=(CMxTime t1, DateTime t2);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t1`**
|
||||
|
||||
[in] CMxTime value.
|
||||
|
||||
**`t2`**
|
||||
|
||||
[in] DateTime value.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### == Operator Overload CMxTime, DateTime (bool)
|
||||
|
||||
Provides an operator to check if a CMxTime is equal to a DateTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static bool operator ==(CMxTime t1, DateTime t2);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t1`**
|
||||
|
||||
[in] CMxTime value.
|
||||
|
||||
**`t2`**
|
||||
|
||||
[in] DateTime value.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### > Operator Overload CMxTime, DateTime (bool)
|
||||
|
||||
Provides an operator to check if a CMxTime is greater than a DateTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static bool operator >(CMxTime t1, DateTime t2);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t1`**
|
||||
|
||||
[in] CMxTime value.
|
||||
|
||||
**`t2`**
|
||||
|
||||
[in] DateTime value.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### >= Operator Overload CMxTime, DateTime (bool)
|
||||
|
||||
Provides an operator to check if a CMxTime is greater than or equal to a DateTime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static bool operator >=(CMxTime t1, DateTime t2);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`t1`**
|
||||
|
||||
[in] CMxTime value.
|
||||
|
||||
**`t2`**
|
||||
|
||||
[in] DateTime value.
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
@@ -0,0 +1,211 @@
|
||||
# CMxTimeArray Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxTimeArray is derived from CMxArray and provides support for Time/DateTime Array Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxTimeArray : CMxArray<DateTime>
|
||||
```
|
||||
|
||||
## CMxTimeArray Properties
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as a DateTime array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public DateTime[] Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
DateTime[ ]
|
||||
|
||||
### Property to get and set the DateTime using [ ] operator
|
||||
|
||||
Provides a property to get and set the DateTime value of an element using [ ] operator.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public DateTime this[short i] { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
DateTime
|
||||
|
||||
## CMxTimeArray Constructors
|
||||
|
||||
### CMxTimeArray Constructor int
|
||||
|
||||
Provides a constructor to initialize the array to a default length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxTimeArray(int length);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`length`**
|
||||
|
||||
[in] integer value that holds the array length.
|
||||
|
||||
### CMxTimeArray Constructor DateTime[ ]
|
||||
|
||||
Provides a constructor to initialize the class with a DateTime array default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxTimeArray (DateTime[] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] DateTime[ ].
|
||||
|
||||
### CMxTimeArray Constructor string[ ]
|
||||
|
||||
Provides a constructor to initialize the class with a formatted time string array default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxTimeArray (string[] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] string[ ] value.
|
||||
|
||||
### CMxTimeArray Constructor SupportWrapper, string
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxTimeArray (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxTimeArray Method
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxTimeArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxTimeArray newValue);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`newValue`**
|
||||
|
||||
[in] CMxTimeArray value to be set.
|
||||
|
||||
## CMxTimeArray Operator Overloads
|
||||
|
||||
### CMxTimeArray Operator Overload DateTime[ ]
|
||||
|
||||
Provides an operator that converts from DateTime array to CMxTimeArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxTimeArray(DateTime[] val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] DateTime[ ] value to convert to CMxTimeArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxTimeArray
|
||||
|
||||
### CMxTimeArray Operator Overload CMxValue
|
||||
|
||||
Provides an operator that converts from CMxValue to CMxTimeArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxTimeArray (CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxTimeArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxTimeArray
|
||||
|
||||
### DateTime[ ] Operator Overload CMxTimeArray
|
||||
|
||||
Provides an operator that converts from CMxTimeArray to DateTime array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator DateTime[](CMxTimeArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxTimeArray value to convert to DateTime[ ].
|
||||
|
||||
**Returns**
|
||||
|
||||
DateTime[ ]
|
||||
|
||||
### CMxValue Operator Overload CMxTimeArray
|
||||
|
||||
Provides an operator that converts from CMxTimeArray to CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxTimeArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxTimeArray value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
@@ -0,0 +1,347 @@
|
||||
# CMxType Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxType is an abstract class that provides the methods and properties available to all classes for supporting CMx{type}{Array} style classes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public abstract class CMxType
|
||||
```
|
||||
|
||||
## CMxType Properties
|
||||
|
||||
### Attribute Property
|
||||
|
||||
Provides a property to hold information about the Attribute from ArchestrA.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
protected AttributeHandle attribute;
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
AttributeHandle
|
||||
|
||||
### AttributeRef Property
|
||||
|
||||
Provides a property to hold the attribute reference string when CMxType classes are used to implement properties of Primitive Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
protected string attributeRef;
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### Owner Property
|
||||
|
||||
Provides a property to hold a handle to the owner of the object which also provides access to ArchestrA Site pointers.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
protected AObjectBase owner;
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
AObjectBase
|
||||
|
||||
### Runtime Property
|
||||
|
||||
Provides a property to hold an indication that the object is currently servicing the Runtime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
protected bool runtime;
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### RuntimeSite2 Property
|
||||
|
||||
Provides a property to hold a handle to the IPrimitiveRuntimeSite2 site for the current attribute when the object is correctly configured at Runtime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
protected IPrimitiveRuntimeSite2 runtimeSite2;
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
IPrimitiveRuntimeSite2
|
||||
|
||||
### Attribute Property
|
||||
|
||||
Provides a property to get and set the AttributeHandle.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
AttributeHandle Attribute { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
AttributeHandle
|
||||
|
||||
### Category Property
|
||||
|
||||
Provides a property to get the MxAttributeCategory.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public virtual MxAttributeCategory Category { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
MxAttributeCategory
|
||||
|
||||
### Checkpoint Property
|
||||
|
||||
Provides a property to Checkpoint the attribute at runtime.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool Checkpoint { set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### DataType Property
|
||||
|
||||
Provides a property to get the MxDataType.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public virtual MxDataType DataType { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
MxDataType
|
||||
|
||||
### DefValue Property
|
||||
|
||||
Provides a property to return the default value as a string.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public abstract string DefValue { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### LiteMode Property
|
||||
|
||||
Provides a property to indicate if the class is running disconnected from ArchestrA.
|
||||
|
||||
> **Note** Disconnected refers to an instance of a wrapper that is not associated with an ArchestrA Attribute (that is a CMxValue that is declared locally in the class).
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool LiteMode { get; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### Locked Property
|
||||
|
||||
Provides a property to get and set the lock of the Attribute.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public bool Locked { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
bool
|
||||
|
||||
### MxValue Property
|
||||
|
||||
Provides a property to get and set the IMxValue of the Attribute.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public virtual IMxValue mxValue { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
MxValueClass
|
||||
|
||||
### Quality Property
|
||||
|
||||
Provides a property to get and set the Quality of the Attribute.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public abstract CMxDataQuality Quality { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxDataQuality
|
||||
|
||||
### Time Property
|
||||
|
||||
Provides a property to get and set the Time of the Attribute.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public abstract CMxTime Time { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxTime
|
||||
|
||||
### Security Property
|
||||
|
||||
Provides a property to get and set the Security of the Attribute.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public virtual MxSecurityClassification Security { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
MxSecurityClassification
|
||||
|
||||
### SetHandlerValue Property
|
||||
|
||||
Provides a property to set the value from a SetHandlerEventArgs value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public virtual SetHandlerEventArgs SetHandlerValue { set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
SetHandlerEventArgs
|
||||
|
||||
## CMxType Constructor
|
||||
|
||||
### CMxType Constructor
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxType(SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxType Methods
|
||||
|
||||
### Initialize Method
|
||||
|
||||
Provides a method to initialize the attribute with ArchestrA information.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Initialize(AttributeHandle _attribute, AObjectBase _owner, bool _runtime);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_attribute`**
|
||||
|
||||
[in] AttributeHandle handle as a parameter.
|
||||
|
||||
**`_owner`**
|
||||
|
||||
[in] base class object of type AObjectBase.
|
||||
|
||||
**`_runtime`**
|
||||
|
||||
[in] bool value to indicate Runtime or not.
|
||||
|
||||
### CheckConnect Method
|
||||
|
||||
Provides a method to verify and connect to ArchestrA if needed for primitive wrappers.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
protected void CheckConnect();
|
||||
```
|
||||
|
||||
### PadMiliseconds Method
|
||||
|
||||
Provides a method to get the ArchestrA style milliseconds as a string from a TimeSpan.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
protected string PadMiliseconds(TimeSpan ts);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`ts`**
|
||||
|
||||
[in] TimeSpan value.
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
### UpdateArrayLength Method
|
||||
|
||||
Provides a method to set the length of an array to a new length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
protected void UpdateArrayLength(int newLength);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`newlength`**
|
||||
|
||||
[in] int value that holds the new length of the array.
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,151 @@
|
||||
# CMxVariant Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxVariant class is derived from CMxCommon and provides support for variant Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxVariant : CMxCommon
|
||||
```
|
||||
|
||||
## CMxVariant Property
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as a string.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxValue Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
## CMxVariant Constructors
|
||||
|
||||
### CMxVariant Constructor
|
||||
|
||||
Provides a default constructor.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxVariant();
|
||||
```
|
||||
|
||||
### CMxVariant Constructor CMxValue
|
||||
|
||||
Provides a constructor to initialize the object with a CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxVariant(CMxValue v);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`v`**
|
||||
|
||||
[in] CMxValue value.
|
||||
|
||||
### CMxVariant Constructor SupportWrapper, string
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxStatus (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxVariant Methods
|
||||
|
||||
### Set Method
|
||||
|
||||
Provide a method to set the value of the Attribute from a CMxVariant
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxVariant val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxVariant value to be set.
|
||||
|
||||
### SetDataType Method
|
||||
|
||||
Provides a method to set the MxDataType of the Attribute.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void SetDataType(MxDataType dtype);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`dtype`**
|
||||
|
||||
[in] MxDataType value to be set.
|
||||
|
||||
## CMxVariant Operator Overloads
|
||||
|
||||
### CMxValue Operator Overload CMxVariant
|
||||
|
||||
Provides an operator that converts from CMxVariant to CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxVariant val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxVariant value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### CMxVariant Operator Overload CMxValue
|
||||
|
||||
Provides an operator that converts from CMxValue to CMxVariant.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxVariant(CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxVariant.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxVariant
|
||||
@@ -0,0 +1,171 @@
|
||||
# CMxVariantArray Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
CMxVariantArray is derived from CMxArray and provides support for Variant Array Attributes.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class CMxVariantArray : CMxArray<CMxValue)
|
||||
```
|
||||
|
||||
## CMxVariantArray Properties
|
||||
|
||||
### Value Property
|
||||
|
||||
Provides a property to get and set the value as a CMxValue array.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxValue [] Value { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue [ ]
|
||||
|
||||
### Property to Get and Set the CMxValue Value using the [ ] Operator
|
||||
|
||||
Provides a property to get and set the CMxValue of an element using [ ] operator.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxValue this[short i] { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
## CMxVariantArray Constructors
|
||||
|
||||
### CMxVariantArray Constructor int
|
||||
|
||||
Provides a constructor to initialize the array to a default length.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxVariantArray(int length);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`length`**
|
||||
|
||||
[in] integer value that holds the array length.
|
||||
|
||||
### CMxVariantArray Constructor CMxValue[ ]
|
||||
|
||||
Provides a constructor to initialize the class with a CMxValue array default value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxVariantArray (CMxValue[] value);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] CMxValue[ ] value to be set.
|
||||
|
||||
### CMxVariantArray Constructor SupportWrapper, string
|
||||
|
||||
Provides a constructor to initialize the class for use in a primitive wrapper.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxVariantArray (SupportWrapper _wrapper, string _attributeRef);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_wrapper`**
|
||||
|
||||
[in] SupportWrapper.
|
||||
|
||||
**`_attributeRef`**
|
||||
|
||||
[in] string value that holds the attribute reference.
|
||||
|
||||
## CMxVariantArray Methods
|
||||
|
||||
### Set Method
|
||||
|
||||
Provides a method to set the value of the Attribute from a CMxVariantArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void Set(CMxVariantArray newValue);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`newValue`**
|
||||
|
||||
[in] CMxVariantArray value to be set.
|
||||
|
||||
### SetDataType Method
|
||||
|
||||
Provides a method to set the value of the MxDataType of the Attribute.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void SetDataType(MxDataType dtype);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`dtype`**
|
||||
|
||||
[in] MxDataType value.
|
||||
|
||||
## CMxVariantArray Operator Overloads
|
||||
|
||||
### CMxValue Operator Overload CMxVariantArray
|
||||
|
||||
Provides an operator that converts from CMxVariantArray to CMxValue.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxValue(CMxVariantArray val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxVariantArray value to convert to CMxValue.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxValue
|
||||
|
||||
### CMxVariantArray Operator Overload CMxValue
|
||||
|
||||
Provides an operator that converts from CMxValue to CMxVariantArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public static implicit operator CMxVariantArray (CMxValue val);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`val`**
|
||||
|
||||
[in] CMxValue value to convert to CMxVariantArray.
|
||||
|
||||
**Returns**
|
||||
|
||||
CMxVariantArray
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,13 @@
|
||||
# ConfigtimeSetHandlerEventArgs Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
ConfigtimeSetHandlerEventArgs is a class that provides configtime set handlers with the information they need when called.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class ConfigtimeSetHandlerEventArgs : SetHandlerEventArgs
|
||||
```
|
||||
|
||||
## ConfigtimeSetHandlerEventArgs Constructor
|
||||
@@ -0,0 +1,20 @@
|
||||
# DataQuality Enumeration
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
enum DataQuality
|
||||
{
|
||||
DataQualityUnknown = -1,
|
||||
DataQualityGood = 0,
|
||||
DataQualityUncertain = 1,
|
||||
DataQualityInitializing = 2,
|
||||
DataQualityBad = 3,
|
||||
}
|
||||
```
|
||||
|
||||
**Remarks**
|
||||
|
||||
An enumeration that represents the four primary OPC data quality states as interpreted by ArchestrA. The DataQualityInitializing state is actually a substatus of Bad according to OPC. In general, use of MxDataQuality is preferred since it contains the most complete OPC bit definitions.
|
||||
@@ -0,0 +1,20 @@
|
||||
# ECALLCONTEXTFLAG Enumeration
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
enum ECALLCONTEXTFLAG
|
||||
{
|
||||
eCallingContextUnknown = 0,
|
||||
eSupervisorySetAttribute = 1,
|
||||
eSystemSetAttribute = 2,
|
||||
eUserSetAttribute = 3,
|
||||
eInternalSetAttribute = 4,
|
||||
}
|
||||
```
|
||||
|
||||
**Remarks**
|
||||
|
||||
Indicates the type of caller that issued the set attribute request. The only types to be used are eSupervisorySetAttribute, eUserSetAttribute, and eInternalSetAttribute. SupervisorySet indicates another object performed the set. InternalSet indicates this object performed the set. UserSet indicates a user performed the set.
|
||||
@@ -0,0 +1,19 @@
|
||||
# EPACKAGESTATUS Enumeration
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
enum EPACKAGESTATUS
|
||||
{
|
||||
ePackageUnknownStatus = -1,
|
||||
ePackageGood = 0,
|
||||
ePackageBad = 1,
|
||||
ePackageWarning = 2,
|
||||
}
|
||||
```
|
||||
|
||||
**Remarks**
|
||||
|
||||
This enumeration indicates the status of a package configuration. Bad packages cannot be deployed, whereas Good and Warning packages can be deployed.
|
||||
@@ -0,0 +1,27 @@
|
||||
# EPRIMITIVEOPSTATUS Enumeration
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
enum EPRIMITIVEOPSTATUS
|
||||
{
|
||||
eSuccess = 0,
|
||||
eUndefinedError = 1,
|
||||
ePrimitiveNotFound = 2,
|
||||
ePrimitiveDefinitionNotFound = 3,
|
||||
eHasLockedAttributes = 4,
|
||||
eNotDynamicPrimitive = 5,
|
||||
eOperationCausesNameConflict = 6,
|
||||
eInvalidPrimitiveName = 7,
|
||||
eNotVirtualPrimitive = 8,
|
||||
eCanNotFindParentPrimitive = 9,
|
||||
eParentPrimitiveIsVirtual = 10,
|
||||
eConflictWithExtensionPrimitive = 11,
|
||||
}
|
||||
```
|
||||
|
||||
**Remarks**
|
||||
|
||||
This enumeration indicates the status of a virtual primitive operation within the package.
|
||||
@@ -0,0 +1,21 @@
|
||||
# ESTARTUPCONTEXT Enumeration
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
enum ESTARTUPCNTEXT
|
||||
{
|
||||
eStartupContextUnknown = 0,
|
||||
eStartingAfterDeployment = 1,
|
||||
eStartingFromCheckpoint = 2,
|
||||
eStartingFromStandby,
|
||||
}
|
||||
```
|
||||
|
||||
### Members
|
||||
|
||||
eStartingAfterDeployment
|
||||
|
||||
Indicates the object instance has just been deployed and is starting for the first time.
|
||||
@@ -0,0 +1,45 @@
|
||||
# EnumText Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
EnumText is a utility class within CMxCustomEnumArray. It provides a method to access the value of an element of the array as a string by specifying its ordinal value.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class EnumText
|
||||
```
|
||||
|
||||
## EnumText Property
|
||||
|
||||
### Property to get and set the value of an element of the Enum Array
|
||||
|
||||
Provides a property to get and set the value of an element of the Enum Array as a string.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public string this[short i] { get; set; }
|
||||
```
|
||||
|
||||
**Returns**
|
||||
|
||||
string
|
||||
|
||||
## EnumText Method
|
||||
|
||||
### EnumText Constructor
|
||||
|
||||
Provides a constructor that takes the owning CMxCustomEnumArray.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public EnumText(CMxCustomEnumArray _owner);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`_owner`**
|
||||
|
||||
[in] CMxCustomEnumArray value to be set.
|
||||
@@ -0,0 +1,17 @@
|
||||
# MigrateHandler Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
The migrate handler contains the information on the current migrate event.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class MigrateHandler
|
||||
```
|
||||
|
||||
## MigrateHandler Properties
|
||||
|
||||
## MigrateHandler Constructor
|
||||
|
||||
## MigrateHandler Methods
|
||||
@@ -0,0 +1,29 @@
|
||||
# MxCustomStruct Enumeration
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
**Syntax**
|
||||
|
||||
class MxCustomStruct
|
||||
|
||||
```csharp
|
||||
{
|
||||
public byte[] Data;
|
||||
public int Guid;
|
||||
|
||||
public MxCustomStruct();
|
||||
public MxCustomStruct(int guid);
|
||||
|
||||
public static bool operator !=(MxCustomStruct x, MxCustomStruct y);
|
||||
public static bool operator ==(MxCustomStruct source, MxCustomStruct result);
|
||||
|
||||
public override bool Equals(object obj);
|
||||
public override int GetHashCode();
|
||||
}
|
||||
```
|
||||
|
||||
### Members
|
||||
|
||||
Guid
|
||||
|
||||
Unique type identifier for the custom structure for type-checking.
|
||||
@@ -0,0 +1,34 @@
|
||||
# MxDataType Enumeration
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
enum MxDataType
|
||||
{
|
||||
MxDataTypeUnknown = -1,
|
||||
MxNoData = 0,
|
||||
MxBoolean = 1,
|
||||
MxInteger = 2,
|
||||
MxFloat = 3,
|
||||
MxDouble = 4,
|
||||
MxString = 5,
|
||||
MxTime = 6,
|
||||
MxElapsedTime = 7,
|
||||
MxReferenceType = 8,
|
||||
MxStatusType = 9,
|
||||
MxDataTypeEnum = 10,
|
||||
MxSecurityClassificationEnum = 11,
|
||||
MxDataQualityType = 12,
|
||||
MxQualifiedEnum = 13,
|
||||
MxQualifiedStruct = 14,
|
||||
MxInternationalizedString = 15,
|
||||
MxBigString = 16,
|
||||
MxDataTypeEND = 17,
|
||||
}
|
||||
```
|
||||
|
||||
**Remarks**
|
||||
|
||||
Indicates the datatype of an attribute.
|
||||
@@ -0,0 +1,20 @@
|
||||
# MxPropertyLockedEnum Enumeration
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
enum MxPropertyLockedEnum
|
||||
{
|
||||
MxUndefinedLockedStatus = -1,
|
||||
MxUnLocked = 0,
|
||||
MxLockedInMe = 1,
|
||||
MxLockedInParent = 2,
|
||||
MxPropertyLockedEnumEND = 3,
|
||||
}
|
||||
```
|
||||
|
||||
**Remarks**
|
||||
|
||||
This enumeration indicates the lock status of an attribute in a package. Attributes that are MxUnLocked and MxLockedInMe can be modified in the package, whereas attributes that are MxLockedInParent cannot be modified in the package.
|
||||
@@ -0,0 +1,23 @@
|
||||
# MxSecurityClassification Enumeration
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
enum MxSecurityClassification
|
||||
{
|
||||
MxSecurityUndefined = -1,
|
||||
MxSecurityFreeAccess = 0,
|
||||
MxSecurityOperate = 1,
|
||||
MxSecuritySecuredWrite = 2,
|
||||
MxSecurityVerifiedWrite = 3,
|
||||
MxSecurityTune = 4,
|
||||
MxSecurityConfigure = 5,
|
||||
MxSecurityViewOnly = 6,
|
||||
}
|
||||
```
|
||||
|
||||
**Remarks**
|
||||
|
||||
Indicates the security classification of an attribute.
|
||||
@@ -0,0 +1,21 @@
|
||||
# MxStatus Enumeration
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
struct MxStatus
|
||||
{
|
||||
public MxStatusCategory Category;
|
||||
public short detail;
|
||||
public MxStatusSource detectedBy;
|
||||
public short success;
|
||||
}
|
||||
```
|
||||
|
||||
### Members
|
||||
|
||||
success
|
||||
|
||||
Indicates whether the operation succeeded, pending, or failed.
|
||||
@@ -0,0 +1,25 @@
|
||||
# MxStatusCategory Enumeration
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
enum MxStatusCategory
|
||||
{
|
||||
MxStatusCategoryUnknown = -1,
|
||||
MxCategoryOk = 0,
|
||||
MxCategoryPending = 1,
|
||||
MxCategoryWarning = 2,
|
||||
MxCategoryCommunicationError = 3,
|
||||
MxCategoryConfigurationError = 4,
|
||||
MxCategoryOperationalError = 5,
|
||||
MxCategorySecurityError = 6,
|
||||
MxCategorySoftwareError = 7,
|
||||
MxCategoryOtherError = 8,
|
||||
}
|
||||
```
|
||||
|
||||
**Remarks**
|
||||
|
||||
Indicates a category of success or error for a Message Exchange call. Used in the Set handler context for objects. Return MxCategoryOk if the set succeeded. Objects may also return MxCategoryWarning when the set completed with a warning. For errors, MxCategoryOperationalError is used to indicate an invalid operation was attempted. MxCategoryConfigurationError is used to indicate the object is not configured to support the set requested.
|
||||
@@ -0,0 +1,22 @@
|
||||
# MxStatusSource Enumeration
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
enum MxStatusSource
|
||||
{
|
||||
MxSourceUnknown = -1,
|
||||
MxSourceRequestingLmx = 0,
|
||||
MxSourceRespondingLmx = 1,
|
||||
MxSourceRequestingNmx = 2,
|
||||
MxSourceRespondingNmx = 3,
|
||||
MxSourceRequestingAutomationObject = 4,
|
||||
MxSourceRespondingAutomationObject = 5,
|
||||
}
|
||||
```
|
||||
|
||||
**Remarks**
|
||||
|
||||
Indicates the source of an error for a Message Exchange get or set call. Lmxmeans Local Message Exchange, the in-process component for ArchestrA data communications. Nmx means Network Message Exchange, the network component of ArchestrA data communications.
|
||||
@@ -0,0 +1,89 @@
|
||||
# ArchestrA Object Toolkit Reference
|
||||
|
||||
Auto-converted from the AVEVA *ArchestrA Object Toolkit Reference Guide* CHM.
|
||||
Single namespace: `ArchestrA.Toolkit`.
|
||||
|
||||
Layout: one Markdown file per top-level type (class / struct / enumeration / interface).
|
||||
Member overloads are inlined as `###` subsections inside the parent type page.
|
||||
|
||||
## Namespace Overview
|
||||
|
||||
ArchestrA.Toolkit is the common namespace for all the classes in the toolkit.
|
||||
|
||||
## Core Types
|
||||
|
||||
- [AObjectBase Class](AObjectBase.md)
|
||||
- [ConfigtimeBase Class](ConfigtimeBase.md)
|
||||
- [RuntimeBase Class](RuntimeBase.md)
|
||||
- [aaBaseEditorForm Class](aaBaseEditorForm.md)
|
||||
- [CMxValue Class](CMxValue.md)
|
||||
- [CMxType Class](CMxType.md)
|
||||
- [CMxCommon Class](CMxCommon.md)
|
||||
- [CMxArrayBase Class](CMxArrayBase.md)
|
||||
- [CMxArray<T> Class](CMxArrayT.md)
|
||||
- [CMxBoolean Class](CMxBoolean.md)
|
||||
- [CMxBooleanArray Class](CMxBooleanArray.md)
|
||||
- [CMxFloat Class](CMxFloat.md)
|
||||
- [CMxFloatArray Class](CMxFloatArray.md)
|
||||
- [CMxDouble Class](CMxDouble.md)
|
||||
- [CMxDoubleArray Class](CMxDoubleArray.md)
|
||||
- [CMxInteger Class](CMxInteger.md)
|
||||
- [CMxIntegerArray Class](CMxIntegerArray.md)
|
||||
- [CMxCustomEnum Class](CMxCustomEnum.md)
|
||||
- [EnumText Class](EnumText.md)
|
||||
- [CMxCustomEnumArray Class](CMxCustomEnumArray.md)
|
||||
- [CMxCustomStruct Class](CMxCustomStruct.md)
|
||||
- [CMxCustomStructArray Class](CMxCustomStructArray.md)
|
||||
- [CMxDataType Class](CMxDataType.md)
|
||||
- [CMxDataTypeArray Class](CMxDataTypeArray.md)
|
||||
- [CMxElapsedTime Class](CMxElapsedTime.md)
|
||||
- [CMxElapsedTimeArray Class](CMxElapsedTimeArray.md)
|
||||
- [CMxInternationalizedString Class](CMxInternationalizedString.md)
|
||||
- [CMxInternationalizedStringArray Class](CMxInternationalizedStringArray.md)
|
||||
- [CMxReference Class](CMxReference.md)
|
||||
- [CMxReferenceArray Class](CMxReferenceArray.md)
|
||||
- [CMxStatus Class](CMxStatus.md)
|
||||
- [CMxStatusArray Class](CMxStatusArray.md)
|
||||
- [CMxString Class](CMxString.md)
|
||||
- [CMxStringArray Class](CMxStringArray.md)
|
||||
- [CMxTime Class](CMxTime.md)
|
||||
- [CMxTimeArray Class](CMxTimeArray.md)
|
||||
- [CMxVariant Class](CMxVariant.md)
|
||||
- [CMxVariantArray Class](CMxVariantArray.md)
|
||||
- [CMxBigString Class](CMxBigString.md)
|
||||
- [CMxBigStringArray Class](CMxBigStringArray.md)
|
||||
- [CMxInternalDumpLoadData Class](CMxInternalDumpLoadData.md)
|
||||
- [CMxInternalFailoverData Class](CMxInternalFailoverData.md)
|
||||
- [CMxDataQuality Class](CMxDataQuality.md)
|
||||
- [CMxIndirectBase Class](CMxIndirectBase.md)
|
||||
- [CMxIndirectWriteOnly Class](CMxIndirectWriteOnly.md)
|
||||
- [CMxIndirect Class](CMxIndirect.md)
|
||||
- [VtqBufferReader Class](VtqBufferReader.md)
|
||||
- [VtqBufferWriter Class](VtqBufferWriter.md)
|
||||
|
||||
## Event Arguments
|
||||
|
||||
- [SetHandlerEventArgs Class](SetHandlerEventArgs.md)
|
||||
- [ConfigtimeSetHandlerEventArgs Class](ConfigtimeSetHandlerEventArgs.md)
|
||||
- [MigrateHandler Class](MigrateHandler.md)
|
||||
- [RuntimeSetHandlerEventArgs Class](RuntimeSetHandlerEventArgs.md)
|
||||
- [RuntimeGetStatusDescEventArgs Class](RuntimeGetStatusDescEventArgs.md)
|
||||
- [RuntimeSetScanStateEventArgs Class](RuntimeSetScanStateEventArgs.md)
|
||||
- [RuntimeStartupEventArgs Class](RuntimeStartupEventArgs.md)
|
||||
|
||||
## Enumerations
|
||||
|
||||
- [ESTARTUPCONTEXT Enumeration](ESTARTUPCONTEXT.md)
|
||||
- [StartupInfo Enumeration](StartupInfo.md)
|
||||
- [ECALLCONTEXTFLAG Enumeration](ECALLCONTEXTFLAG.md)
|
||||
- [SetInfo Enumeration](SetInfo.md)
|
||||
- [MxStatus Enumeration](MxStatus.md)
|
||||
- [MxStatusCategory Enumeration](MxStatusCategory.md)
|
||||
- [MxStatusSource Enumeration](MxStatusSource.md)
|
||||
- [DataQuality Enumeration](DataQuality.md)
|
||||
- [MxSecurityClassification Enumeration](MxSecurityClassification.md)
|
||||
- [MxCustomStruct Enumeration](MxCustomStruct.md)
|
||||
- [MxDataType Enumeration](MxDataType.md)
|
||||
- [EPACKAGESTATUS Enumeration](EPACKAGESTATUS.md)
|
||||
- [EPRIMITIVEOPSTATUS Enumeration](EPRIMITIVEOPSTATUS.md)
|
||||
- [MxPropertyLockedEnum Enumeration](MxPropertyLockedEnum.md)
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,15 @@
|
||||
# RuntimeGetStatusDescEventArgs Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
This class is the argument to the GetStatusDescription event.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class RuntimeGetStatusDescEventArgs : EventArgs
|
||||
```
|
||||
|
||||
## RuntimeGetStatusDescEventArgs Constructor
|
||||
|
||||
## RuntimeGetStatusDescEventArgs Members
|
||||
@@ -0,0 +1,15 @@
|
||||
# RuntimeSetHandlerEventArgs Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
RuntimeSetHandlerEventArgs is a class that provides runtime set handlers with the information they need when called.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class RuntimeRuntimeSetHandlerEventArgs : RuntimeSetHandlerEventArgs
|
||||
```
|
||||
|
||||
## RuntimeSetHandlerEventArgs Constructor
|
||||
|
||||
## RuntimeSetHandlerEventArgs Members
|
||||
@@ -0,0 +1,13 @@
|
||||
# RuntimeSetScanStateEventArgs Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
This class is the argument to the set scan state event.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class RuntimeSetScanStateEventArgs : EventArgs
|
||||
```
|
||||
|
||||
## RuntimeSetScanStateEventArgs Constructor
|
||||
@@ -0,0 +1,13 @@
|
||||
# RuntimeStartupEventArgs Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
This class is the argument for the startup event.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class RuntimeStartupEventArgs : EventArgs
|
||||
```
|
||||
|
||||
## RuntimeStartupEventArgs Constructor
|
||||
@@ -0,0 +1,17 @@
|
||||
# SetHandlerEventArgs Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
SetHandlerEventArgs is an inherited class that provides properties that are common to all SetHandlers.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class SetHandlerEventArgs : EventArgs
|
||||
```
|
||||
|
||||
## SetHandlerEventArgs Property
|
||||
|
||||
## SetHandlerEventArgs Constructor
|
||||
|
||||
## SetHandlerEventArgs Members
|
||||
@@ -0,0 +1,23 @@
|
||||
# SetInfo Enumeration
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
struct SetInfo
|
||||
{
|
||||
public ECALLCONTEXTFLAG callContext;
|
||||
public string engineName;
|
||||
public int responseId;
|
||||
public VBGUID userId;
|
||||
public VBGUID userIdVerifier;
|
||||
```
|
||||
|
||||
}
|
||||
|
||||
### Members
|
||||
|
||||
UserId
|
||||
|
||||
For internal use only.
|
||||
@@ -0,0 +1,19 @@
|
||||
# StartupInfo Enumeration
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
struct StartupInfo
|
||||
{
|
||||
public VB_LARGE_INTEGER checkpointFiletime;
|
||||
public ESTARTUPCONTEXT startupContext;
|
||||
}
|
||||
```
|
||||
|
||||
### Members
|
||||
|
||||
startupContext
|
||||
|
||||
Indicates whether object has just been deployed or restarted from checkpoint.
|
||||
@@ -0,0 +1,25 @@
|
||||
# VtqBufferReader Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
VtqBufferReader class reads the run-time data of an attribute which is passed as a second argument in the constructor. VtqBufferReader class is derived from IEnumerable, which allows it to be used in a C# foreach statement.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class VtqBufferReader : IEnumerable, IDisposable
|
||||
```
|
||||
|
||||
## VtqBufferReader Constructor
|
||||
|
||||
## VtqBufferReader Method
|
||||
|
||||
### GetEnumerator Method
|
||||
|
||||
GetEnumerator returns an enumerator of ValueTimeQuality (VTQ). This function is called implicitly via the C# foreach syntax and provides a standard implementation of IEnumerator.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public virtual IEnumerator GetEnumerator();
|
||||
```
|
||||
@@ -0,0 +1,49 @@
|
||||
# VtqBufferWriter Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
The VtqBufferWriter class provides an assortment of AddVtq overloads, one of which is called multiple times to build a buffer of VTQs. The GetBuffer method is then called to retrieve the buffer.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class VtqBufferWriter : IDisposable
|
||||
```
|
||||
|
||||
## VtqBufferWriter Constructor
|
||||
|
||||
## VtqBufferWriter Methods
|
||||
|
||||
### AddVtq Method
|
||||
|
||||
VtqBufferWriter method for Boolean data type
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void AddVtq(bool value, DateTime dt, CMxDataQuality quality);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`value`**
|
||||
|
||||
[in] Boolean value to be added into VtqBufferWriter
|
||||
|
||||
**`dt`**
|
||||
|
||||
[in] Timestamp of the value
|
||||
|
||||
**`quality`**
|
||||
|
||||
[in] Quality of the value
|
||||
|
||||
### GetBuffer Method
|
||||
|
||||
Call GetBuffer to retrieve the accumulated buffer from the VtqBufferWriter. The buffer is returned as a custom structure contained in a CMxValue. Calling GetBuffer empties the buffer in the underlying buffer writer.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public CMxValue GetBuffer();
|
||||
```
|
||||
@@ -0,0 +1,141 @@
|
||||
# aaBaseEditorForm Class
|
||||
|
||||
Namespace: `ArchestrA.Toolkit`
|
||||
|
||||
aaBaseEditorForm is an User Control and it is the base class of the object Editor project.
|
||||
|
||||
aaBaseEditorForm provides functionality like adding custom tabs to the object editor, Attribute data access, Dictionary access, and ArchestrA logger access.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public class aaBaseEditorForm : UserControl, IaaEditorForm, IaaEditorFormInternal, IaaControl
|
||||
```
|
||||
|
||||
## aaBaseEditorForm Methods
|
||||
|
||||
### GetData Method (string)
|
||||
|
||||
Provides a method to access attribute value from the Editor project.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public object GetData(string sAttribute);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`sAttribute`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**Returns**
|
||||
|
||||
object
|
||||
|
||||
User should typecast the return value to the corresponding datatype. Returns null if the attribute is not found.
|
||||
|
||||
### GetData Method (string, string)
|
||||
|
||||
Provides a method to access attribute information from the Editor project.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public object GetData(string sAttribute, string sProperty);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`sAttribute`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**`sProperty`**
|
||||
|
||||
Property to access:
|
||||
|
||||
"Value" to access the attribute's Value.
|
||||
|
||||
"Lock" to access the attribute's Lock status.
|
||||
|
||||
"SecurityClassification" to access the attribute's SecurityClassification.
|
||||
|
||||
**Returns**
|
||||
|
||||
User should typecast the return value to the corresponding datatype. Returns null if the attribute is not found.
|
||||
|
||||
### GetLocalizedText Method (string, string)
|
||||
|
||||
Provides a method to get a string from the dictionary.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public object GetLocalizedText(string sPhraseID, string sDictionary);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`sPhraseID`**
|
||||
|
||||
PhraseID that exists in the dictionary.
|
||||
|
||||
**`sDictionary`**
|
||||
|
||||
Dictionary file path. The 'this.Dictionary' property of the Editor project contains the full path of the object dictionary file and should be used.
|
||||
|
||||
**Returns**
|
||||
|
||||
object
|
||||
|
||||
### SetData Method (string, object)
|
||||
|
||||
Provides a method to set the value of an Attribute by name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void SetData(string sAttribute, object sVal);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`sAttribute`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**`sVal`**
|
||||
|
||||
Value to set.
|
||||
|
||||
### SetData Method (string, string, object)
|
||||
|
||||
Provides a method to set the value of a property of an Attribute by attribute name.
|
||||
|
||||
**Syntax**
|
||||
|
||||
```csharp
|
||||
public void SetData(string sAttribute, string sProperty, object sVal);
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
**`sAttribute`**
|
||||
|
||||
Attribute external name.
|
||||
|
||||
**`sProperty`**
|
||||
|
||||
Property type:
|
||||
|
||||
"Value" in case of Value property.
|
||||
|
||||
"Lock" in case of Lock property.
|
||||
|
||||
"SecurityClassification" in case of SecurityClassification property.
|
||||
|
||||
**`sVal`**
|
||||
|
||||
Value to set.
|
||||
Reference in New Issue
Block a user