Sunteți pe pagina 1din 474

ArchestrA™ Object Toolkit

Reference Guide

Invensys Systems, Inc.

Revision A
Last Revision: 10/20/08
Copyright
© 2008 Invensys Systems, Inc. All Rights Reserved.
All rights reserved. No part of this documentation shall be reproduced, stored in a
retrieval system, or transmitted by any means, electronic, mechanical,
photocopying, recording, or otherwise, without the prior written permission of
Invensys Systems, Inc. No copyright or patent liability is assumed with respect to
the use of the information contained herein. Although every precaution has been
taken in the preparation of this documentation, the publisher and the author
assume no responsibility for errors or omissions. Neither is any liability assumed
for damages resulting from the use of the information contained herein.
The information in this documentation is subject to change without notice and does
not represent a commitment on the part of Invensys Systems, Inc. The software
described in this documentation is furnished under a license or nondisclosure
agreement. This software may be used or copied only in accordance with the terms
of these agreements.

Invensys Systems, Inc.


26561 Rancho Parkway South
Lake Forest, CA 92630 U.S.A.
(949) 727-3200
http://www.wonderware.com
For comments or suggestions about the product documentation, send an e-mail
message to productdocs@wonderware.com.

Trademarks
All terms mentioned in this documentation that are known to be trademarks or
service marks have been appropriately capitalized. Invensys Systems, Inc. cannot
attest to the accuracy of this information. Use of a term in this documentation
should not be regarded as affecting the validity of any trademark or service mark.
Alarm Logger, ActiveFactory, ArchestrA, Avantis, DBDump, DBLoad, DT Analyst,
Factelligence, FactoryFocus, FactoryOffice, FactorySuite, FactorySuite A2, InBatch,
InControl, IndustrialRAD, IndustrialSQL Server, InTouch, MaintenanceSuite,
MuniSuite, QI Analyst, SCADAlarm, SCADASuite, SuiteLink, SuiteVoyager,
WindowMaker, WindowViewer, Wonderware, Wonderware Factelligence, and
Wonderware Logger are trademarks of Invensys plc, its subsidiaries and affiliates.
All other brands may be trademarks of their respective owners.
3

Contents

Welcome.......................................... 11
Documentation Conventions.............................................11
Technical Support .............................................................12

Chapter 1 Class Reference.................................. 13


ArchestrA.Toolkit ..............................................................13
AObjectBase Class.............................................................13
AObjectBase Properties .................................................13
AObjectBase Methods ....................................................15
ConfigtimeBase Class .......................................................30
ConfigtimeBase Properties ............................................30
ConfigtimeBase Methods ...............................................32
ConfigtimeBase Attributes ............................................44
ConfigtimeBase Events ..................................................45
InputOutputPrimitive Class..........................................51
InputPrimitive Class ......................................................53
OutputPrimitive Class ...................................................54
PrimitiveWrapper Class.................................................56
AttrOpStatus Struct.......................................................57
PrimOpStatus Struct .....................................................58
RuntimeBase Class ...........................................................59
RuntimeBase Properties ................................................59
RuntimeBase Constructor..............................................60
RuntimeBase Events......................................................61

ArchestrA Object Toolkit Reference Guide


4 Contents

RuntimeBase Methods ...................................................63


InputOutputPrimitive Class........................................ 246
InputPrimitive Class.................................................... 250
OutputPrimitive Class ................................................. 252
PrimitiveWrapper Class .............................................. 255
aaBaseEditorForm Class ................................................ 256
aaBaseEditorForm Methods ........................................ 256
Event Arguments ............................................................ 259
SetHandlerEventArgs Class........................................ 259
ConfigtimeSetHandlerEventArgs Class ..................... 261
MigrateHandler Class.................................................. 262
RuntimeSetHandlerEventArgs Class ......................... 266
RuntimeGetStatusDescEventArgs Class.................... 268
RuntimeSetScanStateEventArgs Class ...................... 269
RuntimeStartupEventArgs Class................................ 269
Enumerations .................................................................. 270
ESTARTUPCONTEXT Enumeration ......................... 270
StartupInfo Enumeration ............................................ 271
ECALLCONTEXTFLAG Enumeration....................... 272
SetInfo Enumeration.................................................... 272
MxStatus Enumeration ............................................... 273
MxStatusCategory Enumeration ................................ 274
MxStatusSource Enumeration ....................................275
DataQuality Enumeration ........................................... 275
MxSecurityClassification Enumeration...................... 276
MxCustomStruct Enumeration ................................... 276
MxDataType Enumeration .......................................... 277
EPACKAGESTATUS Enumeration ............................ 278
EPRIMITIVEOPSTATUS Enumeration..................... 278
MxPropertyLockedEnum Enumeration...................... 279
Compatible Interface Classes ......................................... 279
CMxValue Class .............................................................. 283
CMxValue Properties ................................................... 283
CMxValue Constructors............................................... 284
CMxValue Methods...................................................... 285
CMxValue Operator Overloads ................................... 307
CMxType Class................................................................ 315
CMxType Properties .................................................... 315
CMxType Constructor .................................................. 320
CMxType Methods ....................................................... 320

ArchestrA Object Toolkit Reference Guide


Contents 5

CMxCommon Class .........................................................322


CMxCommon Property.................................................322
CMxCommon Constructors..........................................322
CMxArrayBase Class ......................................................323
CMxArrayBase Properties ...........................................323
CMxArrayBase Constructors.......................................323
CMxArray<T> Class .......................................................324
CMxArray<T> Constructor..........................................324
CMxBoolean Class...........................................................325
CMxBoolean Property ..................................................325
CMxBoolean Constructors ...........................................325
CMxBoolean Method ....................................................326
CMxBoolean Operator Overloads ................................326
CMxBooleanArray Class .................................................328
CMxBooleanArray Properties......................................328
CMxBooleanArray Constructors .................................329
CMxBooleanArray Method ..........................................330
CMxBooleanArray Operator Overloads ......................330
CMxFloat Class ...............................................................332
CMxFloat Property.......................................................332
CMxFloat Constructors................................................332
CMxFloat Method.........................................................333
CMxFloat Operator Overloads ....................................333
CMxFloatArray Class .....................................................335
CMxFloatArray Properties ..........................................335
CMxFloatArray Constructors ......................................335
CMxFloatArray Method ...............................................336
CMxFloatArray Operator Overloads...........................337
CMxDouble Class ............................................................338
CMxDouble Property....................................................338
CMxDouble Constructors.............................................339
CMxDouble Method......................................................340
CMxDouble Operator Overloads .................................340
CMxDoubleArray Class...................................................342
CMxDoubleArray Properties .......................................342
CMxDoubleArray Constructors ...................................342
CMxDoubleArray Method ............................................343
CMxDoubleArray Operator Overloads........................344

ArchestrA Object Toolkit Reference Guide


6 Contents

CMxInteger Class............................................................ 345


CMxInteger Property ................................................... 345
CMxInteger Constructors ............................................ 346
CMxInteger Method ..................................................... 347
CMxInteger Operator Overloads ................................. 347
CMxIntegerArray Class .................................................. 349
CMxIntegerArray Properties....................................... 349
CMxIntegerArray Constructors .................................. 350
CMxIntegerArray Method ........................................... 351
CMxIntegerArray Operator Overloads ....................... 351
CMxCustomEnum Class................................................. 353
CMxCustomEnum Properties...................................... 353
CMxCustomEnum Constructors ................................. 354
CMxCustomEnum Method .......................................... 355
CMxCustomEnum Operator Overloads ...................... 356
EnumText Class .............................................................. 357
EnumText Property...................................................... 357
EnumText Method ....................................................... 358
CMxCustomEnumArray Class ....................................... 358
CMxCustomEnumArray Properties ............................ 358
CMxCustomEnumArray Constructors........................ 359
CMxCustomEnumArray Methods............................... 361
CMxCustomEnumArray Operator Overloads ............ 362
CMxCustomStruct Class................................................. 363
CMxCustomStruct Property ........................................ 363
CMxCustomStruct Constructors ................................. 364
CMxCustomStruct Method .......................................... 365
CMxCustomStruct Operator Overloads...................... 366
CMxCustomStructArray Class....................................... 367
CMxCustomStructArray Properties............................ 368
CMxCustomStructArray Constructors ....................... 368
CMxCustomStructArray Method ................................ 370
CMxCustomStructArray Operator Overloads ............ 370
CMxDataType Class ....................................................... 372
CMxDataType Property ............................................... 372
CMxDataType Constructors ........................................ 372
CMxDataType Method ................................................. 373
CMxDataType Operator Overloads............................. 373

ArchestrA Object Toolkit Reference Guide


Contents 7

CMxDataTypeArray Class..............................................375
CMxDataTypeArray Properties...................................375
CMxDataTypeArray Constructors ..............................376
CMxDataTypeArray Method .......................................377
CMxDataTypeArray Operator Overloads ...................377
CMxElapsedTime Class ..................................................379
CMxElapsedTime Property..........................................379
CMxElapsedTime Constructors...................................379
CMxElapsedTime Method............................................380
CMxElapsedTime Operator Overloads .......................381
CMxElapsedTimeArray Class ........................................386
CMxElapsedTimeArray Properties .............................386
CMxElapsedTimeArray Constructors .........................387
CMxElapsedTimeArray Method..................................388
CMxElapsedTimeArray Operator Overloads..............389
CMxInternationalizedString Class ................................390
CMxInternationalizedString Properties .....................390
CMxInternationalizedString Constructors .................391
CMxInternationalizedString Methods ........................392
GetString Method.........................................................392
SetString Method .........................................................393
Set Method....................................................................393
CMxInternationalizedString Operator Overloads......393
CMxInternationalizedStringArray Class.......................396
CMxInternationalizedStringArray Properties ...........396
CMxInternationalizedStringArray Constructors .......397
CMxInternationalizedStringArray Methods ..............398
CMxInternationalizedStringArray Operator
Overloads..................................................................399
CMxReference Class........................................................402
CMxReference Property ...............................................402
CMxReference Constructors ........................................402
CMxReference Method .................................................403
CMxReference Operator Overloads.............................403
CMxReferenceArray Class..............................................405
CMxReferenceArray Properties...................................405
CMxReferenceArray Constructors ..............................406
CMxReferenceArray Method .......................................407
CMxReferenceArray Operator Overloads ...................407

ArchestrA Object Toolkit Reference Guide


8 Contents

CMxStatus Class ............................................................. 409


CMxStatus Property .................................................... 409
CMxStatus Constructors ............................................. 409
CMxStatus Method ...................................................... 410
CMxStatus Operator Overloads .................................. 410
CMxStatusArray Class ................................................... 412
CMxStatusArray Properties ........................................ 412
CMxStatusArray Constructors....................................413
CMxStatusArray Method............................................. 414
CMxStatusArray Operator Overloads ........................ 414
CMxString Class ............................................................. 416
CMxString Property..................................................... 416
CMxString Constructors .............................................. 416
CMxString Method....................................................... 417
CMxString Operator Overloads................................... 417
CMxStringArray Class.................................................... 419
CMxStringArray Properties ........................................ 419
CMxStringArray Constructors ....................................420
CMxStringArray Method ............................................. 421
CMxStringArray Operator Overloads......................... 421
CMxTime Class ............................................................... 423
CMxTime Property....................................................... 423
CMxTime Constructors ................................................ 423
CMxTime Method.........................................................424
CMxTime Operator Overloads..................................... 425
CMxTimeArray Class...................................................... 430
CMxTimeArray Properties .......................................... 430
CMxTimeArray Constructors ...................................... 430
CMxTimeArray Method ............................................... 432
CMxTimeArray Operator Overloads........................... 432
CMxVariant Class ........................................................... 434
CMxVariant Property .................................................. 434
CMxVariant Constructors ........................................... 434
CMxVariant Methods................................................... 435
CMxVariant Operator Overloads ................................ 436
CMxVariantArray Class ................................................. 436
CMxVariantArray Properties ...................................... 437
CMxVariantArray Constructors.................................. 437
CMxVariantArray Methods ......................................... 438
CMxVariantArray Operator Overloads ...................... 439

ArchestrA Object Toolkit Reference Guide


Contents 9

CMxBigString Class........................................................440
CMxBigString Constructors ........................................440
CMxBigString Operator Overloads .............................441
CMxBigStringArray Class ..............................................442
CMxBigStringArray Constructors...............................442
CMxBigStringArray Operator Overloads ...................443
CMxInternalDumpLoadData Class ...............................445
CMxInternalDumpLoadData Property .......................445
CMxInternalDumpLoadData Constructors ................445
CMxInternalFailoverData Class ....................................446
CMxInternalFailoverData Property............................446
CMxInternalFailoverData Constructors.....................446
CMxDataQuality Class ...................................................447
CMxDataQuality Property...........................................447
CMxDataQuality Constructors....................................448
CMxDataQuality Methods ...........................................449
CMxDataQuality Operator Overloads ........................450
CMxIndirectBase Class...................................................451
CMxIndirectBase Properties .......................................452
CMxIndirectBase Constructor .....................................454
CMxIndirectBase Methods ..........................................455
CMxIndirectWriteOnly Class .........................................457
CMxIndirectWriteOnly Property.................................457
CMxIndirectWriteOnly Constructor ...........................457
CMxIndirect Class...........................................................458
CMxIndirect Properties................................................458
CMxIndirect Constructor .............................................460
CMxIndirect Method ....................................................461

Index ............................................. 463

ArchestrA Object Toolkit Reference Guide


10 Contents

ArchestrA Object Toolkit Reference Guide


11

Welcome

This guide describes the class reference for the ArchestrA


Object Toolkit.
You can view this document online or you can print it, in part
or whole, by using the print feature in Adobe Acrobat Reader.

Documentation Conventions
This documentation uses the following conventions:

Convention Used for

Initial Capitals Paths and file names.


Bold Menus, commands, dialog box names,
and dialog box options.
Monospace Code samples and display text.

ArchestrA Object Toolkit Reference Guide


12 Welcome

Technical Support
Wonderware Technical Support offers a variety of support
options to answer any questions on Wonderware products
and their implementation.
Before you contact Technical Support, refer to the relevant
section(s) in this documentation for a possible solution to the
problem. If you need to contact technical support for help,
have the following information ready:
• The type and version of the operating system you are
using.

• Details of how to recreate the problem.

• The exact wording of the error messages you saw.

• Any relevant output listing from the Log Viewer or any


other diagnostic applications.
• Details of what you did to try to solve the problem(s) and
your results.

• If known, the Wonderware Technical Support case


number assigned to your problem, if this is an ongoing
problem.

ArchestrA Object Toolkit Reference Guide


13

Chapter 1

Class Reference

ArchestrA.Toolkit
ArchestrA.Toolkit is the common namespace for all the
classes in the toolkit.

AObjectBase Class
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
public class AObjectBase : _APrimitiveBase

AObjectBase Properties
The following are the properties of the AObjectBase class.
• AObjectInstance Property

• ClassName Property

• DictionaryInstance Property

• MajorVersion Property

• MinorVersion Property

• Runtime Property

• Tagname Property

ArchestrA Object Toolkit Reference Guide


14 Chapter 1 Class Reference

AObjectInstance Property
Provides access to set/get the instance of the object class.
Syntax
public object AObjectInstance { get; set; }
Return Value
object

ClassName Property
Provides access to the name of the object class.
Syntax
public string ClassName { get; }
Return Value
string

DictionaryInstance Property
Provides access to the Dictionary for this object.
Syntax
public Dictionary DictionaryInstance { get; }
Return Value
Dictionary

MajorVersion Property
Provides access to the major version of this object.
Syntax
public string MajorVersion { get; }
Return Value
string

MinorVersion Property
Provides access to the minor version of this object.
Syntax
public string MinorVersion { get; }
Return Value
string

ArchestrA Object Toolkit Reference Guide


AObjectBase Class 15

Runtime Property
Provides indication if the object is currently in runtime or
configtime.
Syntax
public bool Runtime { get; }
Return Value
bool
true: when executing in runtime code.
false: when executing in configtime code.

Tagname Property
Provides access to the Tagname of the object.
Syntax
public string Tagname { get; }
Return Value
string

AObjectBase Methods
The following are the methods of the AObjectBase class.
• AddErrorMessage Method

• AddWarningMessage Method

• AttributeExists Method

• FormatError Method (Exception)

• FormatError Method (string, Exception)

• Get Method (string, EATTRIBUTEPROPERTY)

• Get Method (short, short, EATTRIBUTEPROPERTY)

• GetAttributeHandle Method
• GetIsLocked Method (string)

• GetIsLocked Method (short, short)

• GetName Method

• GetNumElements Method (string)

• GetNumElements Method (short, short)

• GetPrimitiveID Method

• GetSecurityClassification Method (string)

• GetSecurityClassification Method (short, short)

ArchestrA Object Toolkit Reference Guide


16 Chapter 1 Class Reference

• GetText Method (int)

• GetText Method (string)

• GetType Method (string)


• GetType Method (short, short)

• GetValue Method (string)

• GetValue Method (short, short)

• LogError Method

• LogException Method
• LogInfo Method

• LogTrace Method

• LogWarning Method

• RegisterConfigtimeSetHandler Method

• RegisterRuntimeSetHandler Method

• Set Method (string, EATTRIBUTEPROPERTY, object)

• Set Method (short, short, EATTRIBUTEPROPERTY,


CMxValue)

• SetNumElements Method (string, int)

• SetNumElements Method (short, short, int)

• SetValue Method (string, object)

• SetValue Method (short, short, CMxValue)

• StoreObject Method

• UnregisterConfigtimeSetHandler Method

• UnregisterRuntimeSetHandler Method

AddErrorMessage Method
Provides a method to add an error message to the site.
Syntax
public void AddErrorMessage(string message);
Parameter
message
string value that holds the message.

ArchestrA Object Toolkit Reference Guide


AObjectBase Class 17

AddWarningMessage Method
Provides a method to add a warning message to the site.
Syntax
public void AddWarningMessage(string message);
Parameter
message
string value that holds the message.

AttributeExists Method
Provides a method to check the existence of an Attribute by
name.
Syntax
public bool AttributeExists(string fullName);
Parameter
fullName
Attribute external name.
Return Value
bool

FormatError Method (Exception)


Provides a method to generate a formatted exception string
from an exception.
Syntax
protected string FormatError(Exception ex);
Parameter
ex
Exception value to be formatted.
Return Value
string

ArchestrA Object Toolkit Reference Guide


18 Chapter 1 Class Reference

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
protected string FormatError(
string localMessage,
Exception ex
);

Parameters
localMessage
Additional information to add to the exception message.
ex
Exception value to be formatted.
Return Value
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
public CMxValue Get(
string fullName,
EATTRIBUTEPROPERTY property
);

Parameters
fullName
Attribute external name.
property
Attribute property to access.
Return Value
CMxValue

ArchestrA Object Toolkit Reference Guide


AObjectBase Class 19

Get Method (short, short, EATTRIBUTEPROPERTY)


Provides a method to get the value of an Attribute’s property
by ID and primitive ID.
Syntax
public CMxValue Get(
short attributeId,
short primitiveId,
EATTRIBUTEPROPERTY propertyId
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID.
propertyId
Attribute property to access.
Return Value
CMxValue

GetAttributeHandle Method
Provides a method to get an Attribute handle by name.
Syntax
public AttributeHandle GetAttributeHandle(string
fullName);
Parameter
fullName
Attribute external name.
Return Value
AttributeHandle

GetIsLocked Method (string)


Provides a method to get the Lock Status of an attribute by
name.
Syntax
public bool GetIsLocked(string fullName);
Parameter
fullName
Attribute external name.
Return Value
bool
true: if the attribute is locked.
false: if the attribute is unlocked.

ArchestrA Object Toolkit Reference Guide


20 Chapter 1 Class Reference

GetIsLocked Method (short, short)


Provides a method to get the Lock Status of an attribute by
ID and primitive ID.
Syntax
public bool GetIsLocked(
short attributeId,
short primitiveId
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID.
Return Value
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
public string GetName(
short attributeId,
short primitiveId
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID.
Return Value
string

ArchestrA Object Toolkit Reference Guide


AObjectBase Class 21

GetNumElements Method (string)


Provides a method to get the number of elements of an
attribute by name.
Syntax
public int GetNumElements(string fullName);
Parameter
fullName
Attribute external name.
Return Value
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
public int GetNumElements(
short attributeId,
short primitiveId
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID.
Return Value
int
Returns -1 in case of a non-array attribute.

GetPrimitiveID Method
Provides a method to get a primitive ID by name.
Syntax
public short GetPrimitiveID(string primName);
Parameter
primName
Primitive internal name.
Return Value
short

ArchestrA Object Toolkit Reference Guide


22 Chapter 1 Class Reference

GetSecurityClassification Method (string)


Provides a method to get the Security Classification of an
attribute by name.
Syntax
public MxSecurityClassification
GetSecurityClassification(string fullName);
Parameter
fullName
Attribute external name.
Return Value
MxSecurityClassification

GetSecurityClassification Method (short, short)


Provides a method to get the Security Classification of an
attribute by ID and primitive ID.
Syntax
public MxSecurityClassification
GetSecurityClassification(
short attributeId,
short primitiveId
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID.
Return Value
MxSecurityClassification

GetText Method (int)


Provides a method to get a string from the dictionary by int
ID.
Syntax
public string GetText(int phraseId);
Parameter
phraseId
PhraseId that exists in the dictionary.
Return Value
string

ArchestrA Object Toolkit Reference Guide


AObjectBase Class 23

GetText Method (string)


Provides a method to get a string from the dictionary by
string ID.
Syntax
public string GetText(string phraseId);
Parameter
phraseId
PhraseId that exists in the dictionary.
Return Value
string

GetType Method (string)


Provides a method to get the type of an attribute by name.
Syntax
public MxDataType GetType(string fullName);
Parameter
fullName
Attribute external name.
Return Value
MxDataType

GetType Method (short, short)


Provides a method to get the type of an attribute by ID and
primitive ID.
Syntax
public MxDataType GetType(
short attributeId,
short primitiveId
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID.
Return Value
MxDataType

ArchestrA Object Toolkit Reference Guide


24 Chapter 1 Class Reference

GetValue Method (string)


Provides a method to get the value of an Attribute by name.
Syntax
public CMxValue GetValue(string fullName);
Parameter
fullName
Attribute external name.
Return Value
CMxValue

GetValue Method (short, short)


Provides a method to get the value of an Attribute by
attribute ID and primitive ID.
Syntax
public CMxValue GetValue(
short attributeId,
short primitiveId
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID.
Return Value
CMxValue

LogError Method
Provides a method to write an error message to the logger.
Syntax
public void LogError(string _message);
Parameter
_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
public void LogException(Exception ex);
Parameter
ex
Exception value to be logged.

ArchestrA Object Toolkit Reference Guide


AObjectBase Class 25

LogInfo Method
Provides a method to write an information message to the
logger.
Syntax
public void LogInfo(string _message);
Parameter
_message
string value that holds information to be logged.

LogTrace Method
Provides a method to write a trace message to the logger.
Syntax
public void LogTrace(string _message);
Parameter
_message
string value that holds trace message to be logged.

LogWarning Method
Provides a method to write a warning message to the logger.
Syntax
public void LogWarning(string _message);
Parameter
_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
public void RegisterConfigtimeSetHandler(
string _attrName,
ConfigtimeSetHandlerDelegate _handler
);

Parameters
_attrName
Attribute external name.
_handler
Handle of configtime set handler delegate.

ArchestrA Object Toolkit Reference Guide


26 Chapter 1 Class Reference

RegisterRuntimeSetHandler Method
Provides a method to register a runtime set handler to an
Attribute by name.
Syntax
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
public void Set(
string fullName,
EATTRIBUTEPROPERTY property,
object value
);

Parameters
fullName
Attribute external name.
property
Property type.
value
Value to set.

ArchestrA Object Toolkit Reference Guide


AObjectBase Class 27

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
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
public void SetNumElements(
string fullName,
int numElements
);

Parameters
fullName
Attribute external name.
numElements
Number of elements to set.

ArchestrA Object Toolkit Reference Guide


28 Chapter 1 Class Reference

SetNumElements Method (short, short, int)


Provides a method to set the number of elements of an
Attribute by ID and primitive ID.
Syntax
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
public void SetValue(
string fullName,
object value
);

Parameters
fullName
Attribute external name.
value
Value to set.

ArchestrA Object Toolkit Reference Guide


AObjectBase Class 29

SetValue Method (short, short, CMxValue)


Provides a method to set the value of an Attribute by
attribute Id and primitive Id.
Syntax
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
public MxCustomStruct StoreObject(
int id,
object obj
);

Parameters
id
ID of the CustomStruct.
obj
C# object to be stored.
Return Value
MxCustomStruct

ArchestrA Object Toolkit Reference Guide


30 Chapter 1 Class Reference

UnregisterConfigtimeSetHandler Method
Provides a method to unregister the configtime set handler of
an Attribute by name.
Syntax
public void UnregisterConfigtimeSetHandler(string
_attrName);
Parameter
_attrName
Attribute external name.

UnregisterRuntimeSetHandler Method
Provides a method to unregister the runtime set handler of
an Attribute by name.
Syntax
public void UnregisterRuntimeSetHandler(string
attrName);
Parameter
attrName
Attribute external name.

ConfigtimeBase Class
This class provides functionality such as Configtime events
handling, Migrate, Dumpload, Primitive wrappers(for
Input,Output, and InputOutput primitives), Virtual
primitives and Dynamic attributes management.
Syntax
public class ConfigtimeBase : AObjectBase,
IObjectEvent2, IObjectEvent, IMigratePrimitive,
IPrimitivePackage, IValueSupport
Remarks
ConfigtimeBase class is derived from AObjectBase class
which is part of the ArchestrA.Toolkit namespace.

ConfigtimeBase Properties
The following are the properties of the ConfigtimeBase class.
• AutoRecoverySupported Property

• IsTemplate Property

• ParentPrimitive Property

• Site Property

• ThisPrimitive Property

ArchestrA Object Toolkit Reference Guide


ConfigtimeBase Class 31

AutoRecoverySupported Property
Provides indication of support for recovery of Dynamic
Attributes and Virtual Primitives during dump/load.
Syntax
public bool AutoRecoverySupported { get; }
Return Value
bool

IsTemplate Property
Provides indication that a template or an instance is
executing the code.
Syntax
public bool IsTemplate { get; }
Return Value
bool
true if template is executing the code.
false if instance is executing the code.

ParentPrimitive Property
Provides access to the parent Primitive ID.
Syntax
public short ParentPrimitive { get; }
Return Value
short

Site Property
Provides access to the ConfigtimeSite.
Syntax
public IPrimitivePackageSite5 Site { get; }
Return Value
IPrimitivePackageSite5
Remarks
The toolkit provides wrappers for most of the commonly used
functions such as AddAttribute and so on.
An advanced user can access additional functions from
IPrimitivePackageSite5 using the Site Property.
Example to access a primitive's execution order from
configtime code:
Site.GetPrimitivesExecutionOrder(sPrimitiveId, out
pExecutionOrderInfo);

ArchestrA Object Toolkit Reference Guide


32 Chapter 1 Class Reference

ThisPrimitive Property
Provides access to the current Primitive ID.
Syntax
public short ThisPrimitive { get; }
Return Value
short

ConfigtimeBase Methods
The following are the methods of the ConfigtimeBase class.
• AddAttribute Method (string, MxAttributeCategory,
MxDataType, bool, bool)
• AddAttribute Method (string, MxAttributeCategory,
MxDataType, int, bool, bool)
• AddAttribute Method (string, MxAttributeCategory,
MxDataType, MxPropertyLockedEnum,
MxSecurityClassification, bool, bool, bool, short)
• AddAttribute Method (string, MxAttributeCategory,
MxDataType, MxPropertyLockedEnum,
MxSecurityClassification, int, bool, bool, bool, short)

• AddPrimitive Method (string, string, string)

• AddPrimitive Method (string, string, string, bool, short)

• DeleteAttribute Method

• DeletePrimitive Method

• GetHeirarchialName Method

• GetVirtualPrimitiveIdByInternalName Method

• IsDynamicPrimitive Method
• IsStaticPrimitive Method

• IsVirtualPrimitive Method

• RecoverAttributes Method

• RenamePrimtive Method

• UpdateRecoveryData Method

• UpdateRecoveryData Method

• CanRenamePrimtive Method

• CanDeletePrimitive Method

• CanAddPrimitive Method

ArchestrA Object Toolkit Reference Guide


ConfigtimeBase Class 33

AddAttribute Method (string, MxAttributeCategory,


MxDataType, bool, bool)
Provides a method to add a Dynamic Attribute. Use this
function if you are adding a non-array attribute.
Syntax
public bool AddAttribute(
string name,
MxAttributeCategory category,
MxDataType type,
bool cfgSetHandler,
bool rtSetHandler
);

Parameters
Refer to the section AddAttribute Method Parameters and
Return Value.
Return Value
Refer to the section AddAttribute Method Parameters and
Return Value.

AddAttribute Method (string, MxAttributeCategory,


MxDataType, int, bool, bool)
Provides a method to add a Dynamic Attribute Array.
Syntax
public bool AddAttribute(
string name,
MxAttributeCategory category,
MxDataType type,
int length,
bool cfgSetHandler,
bool rtSetHandler
);

Parameters
Refer to the section AddAttribute Method Parameters and
Return Value.
Return Value
Refer to the section AddAttribute Method Parameters and
Return Value.

ArchestrA Object Toolkit Reference Guide


34 Chapter 1 Class Reference

AddAttribute Method (string, MxAttributeCategory,


MxDataType, MxPropertyLockedEnum,
MxSecurityClassification, bool, bool, bool, short)
Provides a detailed method to add a Dynamic Attribute. Use
this function to add a non-array attribute that you want to
exclude from Dump/Load.
Syntax
public bool AddAttribute(
string name,
MxAttributeCategory category,
MxDataType type,
MxPropertyLockedEnum lockType,
MxSecurityClassification security,
bool cfgSetHandler,
bool rtSetHandler,
bool excludeFromDumpLoad,
out short id
);

Parameters
Refer to the section AddAttribute Method Parameters and
Return Value.
Return Value
Refer to the section AddAttribute Method Parameters and
Return Value.

AddAttribute Method (string, MxAttributeCategory,


MxDataType, MxPropertyLockedEnum,
MxSecurityClassification, int, bool, bool, bool, short)
Provides a detailed method to add a Dynamic Attribute
Array. Use this function to add a array attribute that you
want to exclude from Dump/Load.
Syntax
public bool AddAttribute(
string name,
MxAttributeCategory category,
MxDataType type,
MxPropertyLockedEnum lockType,
MxSecurityClassification security,
int length,
bool cfgSetHandler,
bool rtSetHandler,
bool excludeFromDumpLoad,
out short id
);

Parameters
Refer to the section AddAttribute Method Parameters and
Return Value.

ArchestrA Object Toolkit Reference Guide


ConfigtimeBase Class 35

Return Value
Refer to the section AddAttribute Method Parameters and
Return Value.

AddAttribute Method Parameters and Return Value


name
External name of the attribute.
category
The following categories are supported.
• MxCategory_Constant

• MxCategory_SystemInternal
• MxCategory_SystemSetsOnly

• MxCategory_SystemWriteable

• MxCategoryCalculated

• MxCategoryCalculatedRetentive

• MxCategoryWriteable_C_Lockable

• MxCategoryWriteable_S

• MxCategoryWriteable_U

• MxCategoryWriteable_UC

• MxCategoryWriteable_UC_Lockable

• MxCategoryWriteable_US

• MxCategoryWriteable_USC

• MxCategoryWriteable_USC_Lockable
type
The following data types are supported.
• MxBigString

• MxBoolean

• MxDataQualityType

• MxDataTypeEnum

• MxDouble

• MxElapsedTime

• MxFloat

• MxInteger

• MxInternationalizedString

ArchestrA Object Toolkit Reference Guide


36 Chapter 1 Class Reference

• MxNoData

• MxQualifiedEnum

• MxQualifiedStruct
• MxReferenceType

• MxSecurityClassificationEnum

• MxStatusType

• MxString

• MxTime
cfgSetHandler
true: Enables the configtime dynamic set handler. The user
should add a case for the dynamic attribute in the
<objectname>Configtime_ConfigtimeDynamic function, as
the attribute will not be set by default, when this parameter
is marked as true.
rtSetHandler
true: Enables the runtime dynamic set handler. The user
should add a case for the dynamic attribute in the
<objectname>Runtime_RuntimeDynamic function, as the
attribute will not be set by default, when this parameter is
marked as true.
length
Indicates the length of the array, pass 0 in case of non-array
attribute.
lockType
The following lock types are supported.
• MxLockedInMe
• MxLockedInParent

• MxPropertyLockedEnumEND

• MxPropertyLockedEnumEND

• MxUndefinedLockedStatus

• MxUnLockedsecurity
security
The following security classifications are supported.
• MxSecurityConfigure

• MxSecurityFreeAccess

• MxSecurityOperate

• MxSecuritySecuredWrite

ArchestrA Object Toolkit Reference Guide


ConfigtimeBase Class 37

• MxSecurityTune

• MxSecurityUndefined

• MxSecurityVerifiedWrite
• MxSecurityViewOnly
excludeFromDumpLoad
If true, excludes the attribute from Dumpload.
id
Fills the out parameter with the attribute ID of newly
created dynamic attribute.
Return Value
true if the attribute is successfully added.
false if the attribute with the provided name already exists,
or if the user tries to add an attribute with unsupported
category or data type.

AddPrimitive Method (string, string, string)


Provides a method to add a Virtual Primitive instance from a
Virtual Primitive using the Primitives Internal Name.
This method can be used to add a virtual instance of child
primitive, reusable primitive and utility (Input/Output)
primitives.
Syntax
public bool AddPrimitive(
string virtualPrimitiveName,
string internalName,
string externalName
);

Parameters
virtualPrimitiveName
Name of the virtual primitive.
internalName
New internal name of the instance.
externalName
New External name of the instance.
Return Value
true if the Primitive instance addition is successful.
false if the user tries to add a primitive with the same name
of an existing primitive or if the user tries to create an
instance of the non-virtual primitive.

ArchestrA Object Toolkit Reference Guide


38 Chapter 1 Class Reference

AddPrimitive Method (string, string, string, bool,


short)
Detailed method to add a virtual primitive instance at
configtime.This method can be used to add a virtual instance
of child primitive, reusable primitive and Input/Output
primitives.
Use this function in case if the ID of the newly created
primitive is required and/or you need to exclude the primitive
from Dump/Load.
Syntax
public bool AddPrimitive(
string virtualPrimitiveName,
string internalName,
string externalName,
bool excludeFromDumpLoad,
out short id
);

Parameters
virtualPrimitiveName
Name of the virtual primitive.
internalName
New internal name of the instance.
externalName
New External name of the instance.
excludeFromDumpLoad
true excludes the virtual Primitive from Dumpload.
id
fills the out parameter with the primitive ID of newly
created virtual primitive.
Return Value
bool
true if the Primitive instance addition is successful.
false if the Primitive instance addition fails.

ArchestrA Object Toolkit Reference Guide


ConfigtimeBase Class 39

DeleteAttribute Method
Provides a method to delete a dynamic attribute by name.
Syntax
public bool DeleteAttribute(string name);
Parameter
name
Name of the dynamic attribute.
Return Value
bool
true if the dynamic attribute deletion is successful.
false if the user tries to delete a non-existing dynamic
attribute.

DeletePrimitive Method
Provides a method to delete a Virtual Primitive instance by
the Primitives Internal Name.
Syntax
public bool DeletePrimitive(string internalName);
Parameter
internalName
Internal name of the virtual primitive instance.
Return Value
bool
true if Primitive instance deletion is successful.
false if the user tries to delete a non-existing primitive
instance or the user tries to delete a non-virtual primitive.

GetHeirarchialName Method
Provides a method to get the Hierarchical Name of the
primitive.
Syntax
public string GetHeirarchialName(short primitiveId);
Parameter
primitiveId
Primitive Id.
Return Value
string
Remarks
For an object, the method returns null.

ArchestrA Object Toolkit Reference Guide


40 Chapter 1 Class Reference

GetVirtualPrimitiveIdByInternalName Method
Provides a method to get the ID of a child Virtual Primitive
using the Primitives Internal Name. If more than one child
primitive is found the first one is returned.
Syntax
public short GetVirtualPrimitiveIdByInternalName(string
internalName);
Parameter
internalName
internal name of the virtual primitive instance.
Return Value
short
Returns the primitive ID of the virtual primitive.
Remarks
This method finds child primitives.

IsDynamicPrimitive Method
Determines if the primitive is an instance of a virtual
primitive.
Syntax
public bool IsDynamicPrimitive(short id);
Parameter
id
Primitive ID.
Return Value
bool
true if the primitive is of type dynamic otherwise false.

IsStaticPrimitive Method
Determines if the primitive is static.
Syntax
public bool IsStaticPrimitive(short id);
Parameter
id
Primitive ID.
Return Value
bool
true if the primitive is of type static otherwise false.

ArchestrA Object Toolkit Reference Guide


ConfigtimeBase Class 41

IsVirtualPrimitive Method
Determines if the primitive is virtual.
Syntax
public bool IsVirtualPrimitive(short id);
Parameter
id
Primitive ID.
Return Value
bool
true if the primitive is of type virtual, otherwise false.

RecoverAttributes Method
Provides a method to recreate dynamic attributes and
Virtual Primitives Instances from information stored in the
value.This is not typically used by the Object Developer and
is added in auto-generated code by the toolkit when
Dump/Load Support option is enabled.
An automatically inserted Set Handler associated with the
CMxInternalDumpLoadData Attribute calls the
RecoverAttributes method. The Set Handler executes during
Galaxy Load.The Set Handler is inserted by the toolkit for all
Attributes of type CMxInternalDumpLoadData.
RecoverAttributes recreates the Dynamic Attributes and
Primitives stored in the CMxInternalDumpLoadData
Attribute. The values associated with the Dynamic
Attributes are recovered from the Dump/Load CSV file.
Syntax
public void RecoverAttributes(CMxValue value);
Parameter
value
The value contains the stored Attribute information
(Name/DataType) for the Attributes.

ArchestrA Object Toolkit Reference Guide


42 Chapter 1 Class Reference

RenamePrimtive Method
Provides a method to rename a Virtual Primitive instance
using the Primitives Internal Name.
Syntax
public bool RenamePrimtive(
string primitiveInternalName,
string newInternalName,
string newExternalName
);

Parameters
primitiveInternalName
Internal name of the virtual primitive instance.
newInternalName
New Internal name of the virtual primitive instance.
newExternalName
New External name of the virtual primitive instance.
Return Value
bool
true if the primitive internal and external names are
renamed.
Remarks
The user can rename an instance of a Virtual Primitive at
Configtime and check the result using
PrimitiveResult.message and PrimitiveResult.status.

UpdateRecoveryData Method
Provides a method to update dynamic attributes name,
category, security, type, cfgSetHandler, and runtime
SetHandler information for Dump/Load. Also updates Child
Primitives external and internal names for Dump/Load.
The user should call this method each time a dynamic
attribute's shape (name, category, security, type,
cfgSetHandler and runtime SetHandler information) is
changed.
Syntax
public void UpdateRecoveryData();
Remarks
Example of the usage of UpdateRecoveryData in configtime
code:
Set("DynamicAttributeName",
EATTRIBUTEPROPERTY.idxAttribPropSecurityClassificati
on, MxSecurityClassification.MxSecurityTune);
UpdateRecoveryData();

ArchestrA Object Toolkit Reference Guide


ConfigtimeBase Class 43

CanRenamePrimtive Method
Provides a method to check if a virtual primitive instance can
be renamed.
Syntax
public bool CanRenamePrimtive(string
primitiveInternalName, string newExternalName)
Parameter
primitiveInternalName
Internal name of the virtual primitive instance.
newExternalName
New External name of the virtual primitive instance.
Return Value
bool
true if the primitive instance can be renamed with the
External name.

CanDeletePrimitive Method
Provides a method to check if a virtual primitive instance can
be deleted.
Syntax
public bool CanDeletePrimitive(string internalName)
Parameter
internalName
Internal name of the virtual primitive instance.
Return Value
bool
true if the primitive instance can be deleted with the Internal
name.

ArchestrA Object Toolkit Reference Guide


44 Chapter 1 Class Reference

CanAddPrimitive Method
Provides a method to check if a virtual primitive instance can
be added.
Syntax
public bool CanAddPrimitive(string
virtualPrimitiveName, string internalName, string
externalName)
Parameter
virtualPrimitiveName
Internal name of the virtual primitive.
internalName
New Internal name of the virtual primitive instance.
externalName
New External name of the virtual primitive instance.
Return Value
bool
true if the primitive instance can be added with the Internal
and External names.

ConfigtimeBase Attributes
The following are the attributes of the ConfigtimeBase class.
• AttributeResult Attribute

• PrimitiveResult Attribute

AttributeResult Attribute
Holds the result of the last Attribute Action.
Syntax
public ConfigtimeBase.AttrOpStatus AttributeResult;
Remarks
AttributeResult.status.bstrReason,
AttributeResult.status.eResult will give the information on
last Attribute Action.

PrimitiveResult Attribute
Holds the result of the last Primitive Action.
Syntax
public ConfigtimeBase.PrimOpStatus PrimitiveResult;
Remarks
PrimitiveResult.message, PrimitiveResult.status will give
the information on last Primitive Action.

ArchestrA Object Toolkit Reference Guide


ConfigtimeBase Class 45

ConfigtimeBase Events
The following are the events of the ConfigtimeBase class.
• ConfigtimeDynamic Event
• ConfigtimeInitialize Event

• ConfigtimeMigrate Event

• ConfigtimeValidate Event

• PostAssign Event

• PostAssignTo Event

• PostCheckIn Event
• PostCreate Event

• PostDelete Event

• PostDeploy Event

• PostRename Event

• PostUnassign Event

• PostUnassignFrom Event

• PostUndeploy Event

• PreAssignTo Event

• PreCheckIn Event

• PreDelete Event

• PreDeploy Event
• PreRename Event
• PreUnassign Event

• PreUndeploy Event

• PreValidate Event

ArchestrA Object Toolkit Reference Guide


46 Chapter 1 Class Reference

ConfigtimeDynamic Event
This event fires when the value of a dynamic attribute is
changed at configtime.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_ConfigtimeDynamic for
this event.
Add a separate case to implement set handler code for each
your dynamic attributes in this delegate.
Syntax
public event ConfigtimeDynamicSetHandlerDelegate
ConfigtimeDynamic;
Remarks
This is a common set handler for all the configtime dynamic
attributes. Object developer has to handle code separately for
each dynamic attribute as required.

ConfigtimeInitialize Event
This event fires at the time of Object Initialization.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_ConfigtimeInitialize for
this event.
Any custom initialization can be done here, including caching
of attribute values, primitive IDs and so on.
Syntax
public event ConfigtimeInitializeDelegate
ConfigtimeInitialize;

ConfigtimeMigrate Event
ConfigtimeMigrate event is fired when importing a template
into a Galaxy that contains a previous version of the
template. The template of the previous version must be
derived or instantiated for migrate to execute.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_ConfigtimeMigrate for
this event.
Using the MigrateHandler parameter, user can access the
previous version's attribute information in this delegate.
Syntax
public event MigrateDelegate ConfigtimeMigrate;

ArchestrA Object Toolkit Reference Guide


ConfigtimeBase Class 47

ConfigtimeValidate Event
ConfigtimeValidate event is fired when the Object is
validated.
Validate sets the warning or error text for the object. It is
used to check conditions that would not be checked using a
SetHandler, such as reporting that an object was not
configured, or that combinations of attributes are illegal.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_ConfigtimeValidate for
this event.
Syntax
public event ConfigtimeValidateDelegate
ConfigtimeValidate;

PostAssign Event
PostAssign event will be fired for a child object after it is
assigned to a parent node. The Child node has to be
configured to support the PostAssign event.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PostAssign for this event.
Syntax
public event GeneralDelegate PostAssign;

PostAssignTo Event
PostAssignTo event will be fired for a parent object after a
child node is assigned to it. The Parent node has to be
configured to support the PostAssignTo event.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PostAssignTo for this
event.
Syntax
public event GeneralDelegate PostAssignTo;

PostCheckIn Event
PostCheckIn event is fired after an Object is checked-in.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PostCheckIn for this
event.
Syntax
public event SupportEventDelegate PostCheckIn;

ArchestrA Object Toolkit Reference Guide


48 Chapter 1 Class Reference

PostCreate Event
PostCreate event is fired after an object (or derived template)
is created.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PostCreate for this event.
One purpose for implementing this method is to ensure that
the initial state of the primitive is valid.
Syntax
public event ObjectEventDelegate PostCreate;

PostDelete Event
PostDelete event is fired after the object is deleted.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PostDelete for this event.
Syntax
public event SupportEventDelegate PostDelete;

PostDeploy Event
PostDeploy event is fired after the object is deployed.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PostDeploy for this event.
Syntax
public event SupportEventDelegate PostDeploy;

PostRename Event
PostRename event is fired after the object is renamed.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PostRename for this
event.
Syntax
public event RenameDelegate PostRename;

PostUnassign Event
PostUnassign event will be fired on the child object after it is
unassigned from its parent.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PostUnassign for this
event.
Syntax
public event GeneralDelegate PostUnassign;

ArchestrA Object Toolkit Reference Guide


ConfigtimeBase Class 49

PostUnassignFrom Event
PostUnassignFrom event will be fired on the parent object
after a child object is unassigned from it.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PostUnassignFrom for
this event.
Syntax
public event GeneralDelegate PostUnassignFrom;

PostUndeploy Event
PostUndeploy will be fired after the object is undeployed.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PostUndeploy for this
event.
Syntax
public event SupportEventDelegate PostUndeploy;

PreAssignTo Event
PreAssignTo will be fired on a parent object before the child
object is assigned to it.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PreAssignTo for this
event.
Syntax
public event GeneralDelegate PreAssignTo;

PreCheckIn Event
PreCheckIn event will be fired before the object is checked-in.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PreCheckIn for this
event.
Syntax
public event SupportEventDelegate PreCheckIn;

PreDelete Event
PreDelete event is fired before the object is deleted.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PreDelete for this event.
Syntax
public event SupportEventDelegate PreDelete;

ArchestrA Object Toolkit Reference Guide


50 Chapter 1 Class Reference

PreDeploy Event
PreDeploy event is fired before the object is deployed.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PreDeploy for this event.
Syntax
public event DeployDelegate PreDeploy;

PreRename Event
PreRename event is fired before the object is renamed.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PreRename for this event.
Syntax
public event RenameDelegate PreRename;

PreUnassign Event
PreUnassign event is fired before the object is unassigned.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PreUnassign for this
event.
Syntax
public event GeneralDelegate PreUnassign;

PreUndeploy Event
PreUndeploy event is fired before the object is undeployed.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PreUndeploy for this
event.
Syntax
public event ConfigtimeValidateDelegate
ConfigtimeValidate;

PreValidate Event
PreValidate event is fired before the object is validated.
The toolkit automatically generates code to register the
delegate <objectname>Configtime_PreValidate for this
event.
Syntax
public event ObjectEventDelegate PreValidate;

ArchestrA Object Toolkit Reference Guide


ConfigtimeBase Class 51

InputOutputPrimitive Class
This class provides a wrapper for InputOutput Primitive.
Syntax
public class InputOutputPrimitive :
ConfigtimeBase.PrimitiveWrapper

InputOutputPrimitive Properties
The following are the properties of the InputOutputPrimitive
class.
• DataType Property

• Reference Property

• ReferenceSecondary Property

DataType Property
Provides access to set/get the Data Type.
Syntax
public MxDataType DataType { get; set; }
Return Value
MxDataType

Reference Property
Provides access to set/get the Reference as a reference string.
Identifies the target attribute to which the value is to be
written.
Syntax
public string Reference { get; set; }
Return Value
string

ReferenceSecondary Property
Provides access to set/get the Secondary Reference as a
reference string. ReferenceSecondary identifies the source
attribute from which the value and quality are to be read.
Syntax
public string ReferenceSecondary { get; set; }
Return Value
string

ArchestrA Object Toolkit Reference Guide


52 Chapter 1 Class Reference

InputOutputPrimitive Constructor
The following is the constructor of the InputOutputPrimitive
class.
• InputOutputPrimitive Constructor

InputOutputPrimitive Constructor
Syntax
public InputOutputPrimitive(ConfigtimeBase
_parentPrimitive);
Parameter
_parentPrimitive
Instance of ConfigtimeBase.

InputOutputPrimitive Methods
The following are the methods of the InputOutputPrimitive
class.
• Initialize Method (short)

• Initialize Method (string)

Initialize Method (short)


Initializes the wrapper to a primitive by ID.
Syntax
public override void Initialize(short _primitiveID);
Parameter
_primitiveID
Primitive ID of an InputOutput Primitive instance.

Initialize Method (string)


Provides a method to initialize the wrapper to a primitive by
internal name.
Syntax
public void Initialize(string _primitiveInternalName);
Parameter
_primitiveInternalName
Primitive internal name of an IO Primitive instance.

ArchestrA Object Toolkit Reference Guide


ConfigtimeBase Class 53

InputPrimitive Class
This class provides a wrapper for Input Primitive.
Syntax
public class InputPrimitive :
ConfigtimeBase.PrimitiveWrapper

InputPrimitive Properties
The following are the properties of the InputPrimitive class.
• DataType Property

• InputSource Property

DataType Property
Provides access to set/get the DataType.
Syntax
public MxDataType DataType { get; set; }
Return Value
MxDataType

InputSource Property
Provides access to set/get the Input Source as a reference
string.
Syntax
public string InputSource { get; set; }
Return Value
string

InputPrimitive Constructor
The following is the constructor of the InputPrimitive class.
• InputPrimitive Constructor

InputPrimitive Constructor
Syntax
public InputPrimitive(ConfigtimeBase _parentPrimitive);
Parameter
_parentPrimitive
Instance of ConfigtimeBase.

ArchestrA Object Toolkit Reference Guide


54 Chapter 1 Class Reference

InputPrimitive Methods
The following are the methods of the InputPrimitive class.
• Initialize Method (short)

• Initialize Method (string)

Initialize Method (short)


Provide a method to initialize the wrapper to a primitive by
ID.
Syntax
public override void Initialize(short _primitiveID);
Parameter
_primitiveID
Primitive ID of an Input Primitive instance.

Initialize Method (string)


Provides a method to initialize the wrapper to a primitive by
internal name.
Syntax
public void Initialize(string _primitiveInternalName);
Parameter
_primitiveInternalName
Primitive internal name of an IO Primitive instance.

OutputPrimitive Class
This class provides a wrapper for Output Primitive.
Syntax
public class OutputPrimitive :
ConfigtimeBase.PrimitiveWrapper

OutputPrimitive Properties
The following are the properties of the OutputPrimitive
class.
• DataType Property

• OutputDest Property

DataType Property
Provides access to set/get the Data Type.
Syntax
public MxDataType DataType { get; set; }
Return Value
MxDataType

ArchestrA Object Toolkit Reference Guide


ConfigtimeBase Class 55

OutputDest Property
Provides access to set/get the Output Destination as a
reference string.
Syntax
public string OutputDest { get; set; }
Return Value
string

OutputPrimitive Constructor
The following is the constructor of the OutputPrimitive class.
• OutputPrimitive Constructor

OutputPrimitive Constructor
Syntax
public OutputPrimitive(ConfigtimeBase
_parentPrimitive);
Parameter
_parentPrimitive
Instance of ConfigtimeBase.

OutputPrimitive Methods
The following are the methods of the OutputPrimitive class.
• Initialize Method (short)

• Initialize Method (string)

Initialize Method (short)


Provides a method to initialize the wrapper to a primitive by
ID.
Syntax
public override void Initialize(short _primitiveID);
Parameter
_primitiveID
Primitive ID of an Output Primitive instance.

ArchestrA Object Toolkit Reference Guide


56 Chapter 1 Class Reference

Initialize Method (string)


Provides a method to initialize the wrapper to a primitive by
internal name.
Syntax
public override void Initialize(string
primitiveInternalName);
Parameter
_primitiveInternalName
Primitive internal name of an IO Primitive instance.

PrimitiveWrapper Class
Base class of all IO Wrappers.
Syntax
public class PrimitiveWrapper

PrimitiveWrapper Property
The following is the property of the PrimitiveWrapper class.
• IsGood Property

IsGood Property
Provides indication that the wrapper has been initialized
successfully.
Syntax
public bool IsGood { get; }
Return Value
bool

PrimitiveWrapper Constructor
The following is the constructor of the PrimitiveWrapper
class.
• PrimitiveWrapper Constructor

PrimitiveWrapper Constructor
Syntax
public PrimitiveWrapper(ConfigtimeBase
_parentPrimitive);
Parameter
_parentPrimitive
Instance of the parent (ConfigtimeBase.)

ArchestrA Object Toolkit Reference Guide


ConfigtimeBase Class 57

PrimitiveWrapper Methods
The following are the methods of the PrimitiveWrapper class.
• Initialize Method (short)
• Initialize Method (string)

Initialize Method (short)


Provides a method to initialize the wrapper to a primitive by
ID.
Syntax
public virtual void Initialize(short _primitiveId);
Parameter
_primitiveId
Primitive ID of an IO Primitive instance.

Initialize Method (string)


Provides a method to initialize the wrapper to a primitive by
internal name.
Syntax
public void Initialize(string _primitiveInternalName);
Parameter
_primitiveInternalName
Primitive internal name of an IO Primitive instance.

AttrOpStatus Struct
Provides access to the result value associated with the
following Attribute operations.
• AddAttribute
• DeleteAttribute
Syntax
public struct AttrOpStatus

AttrOpStatus Attributes
The following are the attributes of the AttrOpStatus Struct.
• message attribute

• status attribute

ArchestrA Object Toolkit Reference Guide


58 Chapter 1 Class Reference

message attribute
Contains description about the status of last attribute
operation.
Syntax
public string message;

status attribute
Contains the value of
ArchestrA.Core.AttributeOperationResult.eResult of last
attribute operation.
Syntax
public AttributeOperationResult status;

PrimOpStatus Struct
Provides access to the result value associated with the
following Primitive operations to remove the need to add
message parameters for each operation.
• AddPrimitive

• CanAddPrimitive

• CanRenamePrimitive

• GetVirtualPrimitiveIdByInternalName

• DeletePrimitive

• RenamePrimitive
Syntax
public struct PrimOpStatus

PrimOpStatus Attributes
The following are the attributes of the PrimOpStatus Struct.
• message attribute
• status attribute

message attribute
Contains description about the status of the last primitive
operation.
Syntax
public string message;

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 59

status attribute
Contains the value of ArchestrA.Core. EPRIMITIVEOPSTATUS
of the last primitive operation.
Syntax
public EPRIMITIVEOPSTATUS status;

RuntimeBase Class
This Class provides functionality such as, Support for
Runtime Events, Add / Remove attributes, Failover Support
for Dynamic Attributes, Advise Only Active support and get /
set of value, time and quality for attributes.
Syntax
public class RuntimeBase : AObjectBase,
IPrimitiveDeployment, IValueSupport,
IPrimitiveRuntimeScanOnDemandCS, IPrimitiveRuntime3,
IPrimitiveRuntime
Remarks
The Runtime Base class is derived from:
AObjectBase which is a part of the ArchestrA.Toolkit
namespace and IPrimitiveDeployment, IValueSupport,
IPrimitiveRuntimeScanOnDemandCS, IPrimitiveRuntime2
and IPrimitiveRuntime which are the parts of the
ArchestrA.Core namespace.

RuntimeBase Properties
The following are the properties of the RuntimeBase class.
• DynamicAttributeFailoverEnabled Property
• ScanOnDemandEnabled Property
• Site Property

• ThisPrimitive Property

DynamicAttributeFailoverEnabled Property
Indicates if fail-over support is enabled for runtime dynamic
attribute.
Syntax
public bool DynamicAttributeFailoverEnabled { get; }
Return Value
bool
Returns true if Failover support is enabled for the object.

ArchestrA Object Toolkit Reference Guide


60 Chapter 1 Class Reference

ScanOnDemandEnabled Property
Indicates if the “advise only active” support is enabled for the
Object. It returns true only if Advise Only Active is enabled
for both the Object and the Galaxy.
Syntax
public bool ScanOnDemandEnabled { get; }
Return Value
bool

Site Property
Provides access to the RuntimeSite.
Syntax
public IPrimitiveRuntimeSiteEx2 Site { get; }
Return Value
IPrimitiveRuntimeSiteEx2
Remarks
The toolkit provides wrappers for most of the commonly used
functions like AddAttribute and so on. An advanced user can
access additional functions from IPrimitiveRuntimeSiteEx2
using the Site Property.
Example to enable checkpoint for an attribute:
Site2.CheckpointAttribute(attrID,true);

ThisPrimitive Property
Provides access to the current Primitive ID.
Syntax
public short ThisPrimitive { get; }
Return Value
short

RuntimeBase Constructor
The following is the constructor of the RuntimeBase class.
• RuntimeBase Constructor

RuntimeBase Constructor
This is the default constructor for the RuntimeBase class.
This is not used by the Object Developer. The Object
Developer uses the <object>Runtime() constructor that is
automatically generated by the toolkit.
Syntax
public RuntimeBase();

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 61

RuntimeBase Events
Delegates added to the events are called when the
appropriate event is fired by Application Server.
• RuntimeDynamic Event

• RuntimeExecute Event

• RuntimeGetStatusDesc Event

• RuntimeInitialize Event

• RuntimeSetScanState Event

• RuntimeShutdown Event

• RuntimeStartup Event

RuntimeDynamic Event
Fired when the value of a runtime dynamic attribute is
changed. The toolkit automatically generates code to register
the delegate <objectname>Runtime_RuntimeDynamic for
this event.
Syntax
public event RuntimeDynamicSetHandlerDelegate
RuntimeDynamic;

RuntimeExecute Event
Fired on every scan cycle of the hosting AppEngine while the
object is OnScan. The toolkit automatically generates code to
register the delegate <objectname>_RuntimeExecute for this
event.
Syntax
public event RuntimeExecuteDelegate RuntimeExecute;

RuntimeGetStatusDesc Event
Occurs when the run time component requests a detailed
message for an error for example, after a set handler returns
a failure. The toolkit automatically generates code to register
the delegate <objectname>Runtime_RuntimeGetStatusDesc
for this event.
Syntax
public event RuntimeGetStatusDescDelegate
RuntimeGetStatusDesc;

ArchestrA Object Toolkit Reference Guide


62 Chapter 1 Class Reference

RuntimeInitialize Event
Occurs after the object is created in run time (usually after
deployment, but also after a failover or after the bootstrap is
restarted). Occurs before the Startup event. No attribute
information is available at this time. The toolkit
automatically generates code to register the delegate
<objectname>Runtime_RuntimeInitialize for this event.
Syntax
public event RuntimeInitializeDelegate
RuntimeInitialize;

RuntimeSetScanState Event
Occurs when the object's scan state (OnScan/OffScan) is
changed. The toolkit automatically generates code to register
the delegate <objectname>_ RuntimeSetScanState for this
event.
Syntax
public event RuntimeSetScanStateDelegate
RuntimeSetScanState;

RuntimeShutdown Event
Occurs when the object is shutting down (usually after the
object is set to OffScan, but during a failover OffScan may
not be set). This event does not occur if the object goes off the
network during a network failure. The toolkit automatically
generates code to register the delegate
<objectname>_RuntimeShutdown for this event.
Syntax
public event RuntimeShutdownDelegate RuntimeShutdown;

RuntimeStartup Event
Occurs when the object is started (after the Initialize event
and before it goes OnScan). You can use the event's startup
context to find out whether the object is starting up after a
failover or other reasons. The toolkit automatically generates
code to register the delegate <objectname>_RuntimeStartup
for this event.
Syntax
public event RuntimeStartupDelegate RuntimeStartup;

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 63

RuntimeBase Methods
The following are the methods of the RuntimeBase class.
• ActivateLocalAttribute Method (string)
• ActivateLocalAttribute Method (short, string)

• ActivatePrimitiveAttribute Method (string)

• ActivatePrimitiveAttribute Method (short, short)

• AddAttribute Method (string, MxAttributeCategory,


MxDataType, bool)

• AddAttribute Method (string, MxAttributeCategory,


MxDataType, bool)
• AddAttribute Method (string, MxAttributeCategory,
MxDataType, int, bool)
• AddAttribute Method (string, MxAttributeCategory,
MxDataType, MxSecurityClassification, DataQuality,
bool, bool, short)
• AddAttribute Method (string, MxAttributeCategory,
MxDataType, MxSecurityClassification, DataQuality,
int, bool, bool, short)

• AppendNames Method

• BindTo Method (string, string)

• BindTo Method (string, string, bool)

• BindToWriteOnly Method (string, string)

• BindToWriteOnly Method (string, string, bool)

• CheckpointDynamicAttributeData Method

• DeleteAttribute Method (string)


• DeleteAttribute Method (string, bool)

• GetAttributeName Method (short, short, string)

• GetAttributeProperties Method (string, MxDataType,


MxSecurityClassification, MxAttributeCategory,
MxPropertyLockedEnum, int, int, int, int, int, int, int,
int, int)
• GetAttributeProperties Method (short, short,
MxDataType, MxSecurityClassification,
MxAttributeCategory, MxPropertyLockedEnum, int, int,
int, int, int, int, int, int, int)
• GetBoolean Method (string, bool)

ArchestrA Object Toolkit Reference Guide


64 Chapter 1 Class Reference

• GetBoolean Method (short, short, bool)

• GetBoolean Method (string, int, bool)

• GetBoolean Method (string, bool, CMxDataQuality)


• GetBoolean Method (short, short, int, bool)

• GetBoolean Method (short, short, bool, CMxDataQuality)

• GetBoolean Method (string, bool, DateTime,


CMxDataQuality)

• GetBoolean Method (short, short, bool, DateTime,


CMxDataQuality)
• GetBooleanArrayQ Method (string, CMxDataQuality)

• GetBooleanArrayQ Method (short, short,


CMxDataQuality)
• GetCustomEnum Method (string, short)

• GetCustomEnum Method (short, short, short)

• GetCustomEnum Method (string, int, short)

• GetCustomEnum Method (string, short,


CMxDataQuality)

• GetCustomEnum Method (short, short, int, short)

• GetCustomEnum Method (short, short, short,


CMxDataQuality)
• GetCustomEnum Method (string, short, DateTime,
CMxDataQuality)
• GetCustomEnum Method (short, short, short, DateTime,
CMxDataQuality)

• GetCustomEnumArrayQ Method (string,


CMxDataQuality)

• GetCustomEnumArrayQ Method (short, short,


CMxDataQuality)
• GetCustomStruct Method (string, MxCustomStruct)

• GetCustomStruct Method (short, short,


MxCustomStruct)
• GetCustomStruct Method (string, int, MxCustomStruct)

• GetCustomStruct Method (string, MxCustomStruct,


CMxDataQuality)

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 65

• GetCustomStruct Method (short, short, int,


MxCustomStruct)

• GetCustomStruct Method (short, short,


MxCustomStruct, CMxDataQuality)
• GetCustomStruct Method (string, MxCustomStruct,
DateTime, CMxDataQuality)

• GetCustomStruct Method (short, short,


MxCustomStruct, DateTime, CMxDataQuality)

• GetCustomStructArrayQ Method (string,


CMxDataQuality)
• GetCustomStructArrayQ Method (short, short,
CMxDataQuality)
• GetDataFromFailoverField Method

• GetDefaultTimeStamp Method

• GetDouble Method (string, double)

• GetDouble Method (short, short, double)

• GetDouble Method (string, int, double)

• GetDouble Method (string, double, CMxDataQuality)

• GetDouble Method (short, short, int, double)

• GetDouble Method (short, short, double,


CMxDataQuality)

• GetDouble Method (string, double, DateTime,


CMxDataQuality)
• GetDouble Method (short, short, double, DateTime,
CMxDataQuality)
• GetDoubleArrayQ Method (string, CMxDataQuality)

• GetDoubleArrayQ Method (short, short,


CMxDataQuality)
• GetElapsedTime Method (string, TimeSpan)

• GetElapsedTime Method (short, short, TimeSpan)

• GetElapsedTime Method (string, int, TimeSpan)

• GetElapsedTime Method (string, TimeSpan,


CMxDataQuality)
• GetElapsedTime Method (short, short, int, TimeSpan)

ArchestrA Object Toolkit Reference Guide


66 Chapter 1 Class Reference

• GetElapsedTime Method (short, short, TimeSpan,


CMxDataQuality)

• GetElapsedTime Method (string, TimeSpan, DateTime,


CMxDataQuality)
• GetElapsedTime Method (short, short, TimeSpan,
DateTime, CMxDataQuality)

• GetElapsedTimeArrayQ Method (string,


CMxDataQuality)

• GetElapsedTimeArrayQ Method (short, short,


CMxDataQuality)
• GetFloat Method (string, float)

• GetFloat Method (short, short, float)


• GetFloat Method (string, int, float)

• GetFloat Method (string, float, CMxDataQuality)

• GetFloat Method (short, short, int, float)

• GetFloat Method (short, short, float, CMxDataQuality)

• GetFloat Method (string, float, DateTime,


CMxDataQuality)

• GetFloat Method (short, short, float, DateTime,


CMxDataQuality)

• GetFloatArrayQ Method (string, CMxDataQuality)

• GetFloatArrayQ Method (short, short, CMxDataQuality)

• GetInteger Method (string, int)

• GetInteger Method (short, short, int)

• GetInteger Method (string, int, int)


• GetInteger Method (string, int, CMxDataQuality)

• GetInteger Method (short, short, int, CMxDataQuality)

• GetInteger Method (string, int, DateTime,


CMxDataQuality)
• GetInteger Method (short, short, int, DateTime,
CMxDataQuality)
• GetIntegerArrayQ Method (string, CMxDataQuality)

• GetIntegerArrayQ Method (short, short,


CMxDataQuality)

• GetLockStatus Method (string, MxPropertyLockedEnum)

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 67

• GetLockStatus Method (short, short,


MxPropertyLockedEnum)

• GetMxDataType Method (string, MxDataType)

• GetMxDataType Method (short, short, MxDataType)

• GetMxDataType Method (string, int, MxDataType)

• GetMxDataType Method (string, MxDataType,


CMxDataQuality)
• GetMxDataType Method (short, short, int, MxDataType)

• GetMxDataType Method (short, short, MxDataType,


CMxDataQuality)
• GetMxDataType Method (string, MxDataType,
DateTime, CMxDataQuality)

• GetMxDataType Method (short, short, MxDataType,


DateTime, CMxDataQuality)
• GetMxDataTypeArrayQ Method (string,
CMxDataQuality)

• GetMxDataTypeArrayQ Method (short, short,


CMxDataQuality)

• GetMxStatus Method (string, MxStatus)

• GetMxStatus Method (string, MxStatus)

• GetMxStatus Method (short, short, MxStatus)

• GetMxStatus Method (string, int, MxStatus)

• GetMxStatus Method (string, MxStatus,


CMxDataQuality)
• GetMxStatus Method (short, short, int, MxStatus)

• GetMxStatus Method (short, short, MxStatus,


CMxDataQuality)

• GetMxStatus Method (string, MxStatus, DateTime,


CMxDataQuality)
• GetMxStatus Method (short, short, MxStatus, DateTime,
CMxDataQuality)
• GetMxStatusArrayQ Method (string, CMxDataQuality)

• GetMxStatusArrayQ Method (short, short,


CMxDataQuality)
• GetNormalChildID Method

ArchestrA Object Toolkit Reference Guide


68 Chapter 1 Class Reference

• GetNumElementsEx Method (string, int)

• GetNumElementsEx Method (short, short, int)

• GetPrimitiveIds Method
• GetPrimitiveInfo Method

• GetPrimitiveRuntimeSite2 Method

• GetQ Method (string)

• GetQ Method (short, short)

• GetQuality Method (string, MxDataType,


CMxDataQuality)

• GetQuality Method (short, short, MxDataType,


CMxDataQuality)
• GetReference Method (string, IMxReference)

• GetReference Method (short, short, IMxReference)

• GetReference Method (string, int, IMxReference)

• GetReference Method (string, IMxReference,


CMxDataQuality)

• GetReference Method (short, short, int, IMxReference)

• GetReference Method (short, short, IMxReference,


CMxDataQuality)

• GetReference Method (string, IMxReference, DateTime,


CMxDataQuality)
• GetReference Method (short, short, IMxReference,
DateTime, CMxDataQuality)
• GetReferenceArrayQ Method (string, CMxDataQuality)

• GetReferenceArrayQ Method (short, short,


CMxDataQuality)
• GetScanTime Method

• GetScanTime Method (short)

• GetStatusDescription Method

• GetString Method (string, string)

• GetString Method (short, short, string)

• GetString Method (string, int, string)

• GetString Method (string, string, CMxDataQuality)

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 69

• GetString Method (short, short, int, string)

• GetString Method (short, short, string, CMxDataQuality)

• GetString Method (string, string, DateTime,


CMxDataQuality)

• GetString Method (short, short, string, DateTime,


CMxDataQuality)
• GetStringArrayQ Method (string, CMxDataQuality)

• GetStringArrayQ Method (short, short,


CMxDataQuality)

• GetTime Method (string, DateTime)


• GetTime Method (short, short, DateTime)

• GetTime Method (string, int, DateTime)

• GetTime Method (string, DateTime, CMxDataQuality)

• GetTime Method (short, short, int, DateTime)

• GetTime Method (short, short, DateTime,


CMxDataQuality)

• GetTime Method (string, DateTime, DateTime,


CMxDataQuality)
• GetTime Method (short, short, DateTime, DateTime,
CMxDataQuality)

• GetTimeArrayQ Method (string, CMxDataQuality)

• GetTimeArrayQ Method (short, short, CMxDataQuality)


• GetTimeStamp Method (string, MxDataType, DateTime)
• GetTimeStamp Method (short, short, MxdataType,
DateTime)

• GetType Method (string, MxDataType, int)

• GetType Method (short, short, MxDataType, int)

• Initialize Method

• ParentPrimitive Method

• PutBoolean Method (string, bool)

• PutBoolean Method (short, short, bool)

• PutBoolean Method (string, bool, CMxDataQuality)

• PutBoolean Method (string, int, bool)

ArchestrA Object Toolkit Reference Guide


70 Chapter 1 Class Reference

• PutBoolean Method (short, short, bool, CMxDataQuality)

• PutBoolean Method (short, short, int, bool)

• PutBoolean Method (string, bool, DateTime,


CMxDataQuality)

• PutBoolean Method (short, short, bool, DateTime,


CMxDataQuality)
• PutBooleanArrayQ Method (string, CMxDataQuality)

• PutBooleanArrayQ Method (short, short,


CMxDataQuality)

• PutCustomEnum Method (string, short)


• PutCustomEnum Method (short, short, short)

• PutCustomEnum Method (string, int, short)

• PutCustomEnum Method (string, short,


CMxDataQuality)

• PutCustomEnum Method (short, short, int, short)

• PutCustomEnum Method (short, short, short,


CMxDataQuality)
• PutCustomEnum Method (string, short, DateTime,
CMxDataQuality)

• PutCustomEnum Method (short, short, short, DateTime,


CMxDataQuality)

• PutCustomEnumArrayQ Method (string,


CMxDataQuality)
• PutCustomEnumArrayQ Method (short, short,
CMxDataQuality)
• PutCustomStruct Method (string, MxCustomStruct)

• PutCustomStruct Method (short, short,


MxCustomStruct)
• PutCustomStruct Method (string, int, MxCustomStruct)

• PutCustomStruct Method (string, MxCustomStruct,


CMxDataQuality)
• PutCustomStruct Method (short, short, int,
MxCustomStruct)
• PutCustomStruct Method (short, short,
MxCustomStruct, CMxDataQuality)

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 71

• PutCustomStruct Method (string, MxCustomStruct,


DateTime, CMxDataQuality)

• PutCustomStruct Method (short, short,


MxCustomStruct, DateTime, CMxDataQuality)
• PutCustomStructArrayQ Method (string,
CMxDataQuality)

• PutCustomStructArrayQ Method (short, short,


CMxDataQuality)

• PutDouble Method (string, double)

• PutDouble Method (short, short, double)

• PutDouble Method (string, double, CMxDataQuality)

• PutDouble Method (string, int, double)

• PutDouble Method (short, short, double,


CMxDataQuality)
• PutDouble Method (short, short, int, double)

• PutDouble Method (string, double, DateTime,


CMxDataQuality)

• PutDouble Method (short, short, double, DateTime,


CMxDataQuality)

• PutDoubleArrayQ Method (string, CMxDataQuality)

• PutDoubleArrayQ Method (short, short,


CMxDataQuality)
• PutElapsedTime Method (string, TimeSpan)
• PutElapsedTime Method (short, short, TimeSpan)
• PutElapsedTime Method (string, int, TimeSpan)

• PutElapsedTime Method (string, TimeSpan,


CMxDataQuality)

• PutElapsedTime Method (short, short, int, TimeSpan)

• PutElapsedTime Method (short, short, TimeSpan,


CMxDataQuality)
• PutElapsedTime Method (string, TimeSpan, DateTime,
CMxDataQuality)
• PutElapsedTime Method (short, short, TimeSpan,
DateTime, CMxDataQuality)
• PutElapsedTimeArrayQ Method (string,
CMxDataQuality)

ArchestrA Object Toolkit Reference Guide


72 Chapter 1 Class Reference

• PutElapsedTimeArrayQ Method (short, short,


CMxDataQuality)

• PutElapsedTimeArrayQ Method (short, short,


CMxDataQuality)
• PutFloat Method (string, float)

• PutFloat Method (short, short, float)

• PutFloat Method (string, float, CMxDataQuality)

• PutFloat Method (string, int, float)

• PutFloat Method (short, short, float, CMxDataQuality)

• PutFloat Method (short, short, int, float)

• PutFloat Method (string, float, DateTime,


CMxDataQuality)
• PutFloat Method (short, short, float, DateTime,
CMxDataQuality)

• PutFloatArrayQ Method (string, CMxDataQuality)

• PutFloatArrayQ Method (short, short, CMxDataQuality)

• PutInteger Method (string, int)

• PutInteger Method (short, short, int)

• PutInteger Method (string, int, CMxDataQuality)

• PutInteger Method (string, int, int)

• PutInteger Method (short, short, int, CMxDataQuality)

• PutInteger Method (short, short, int, int)

• PutInteger Method (string, int, DateTime,


CMxDataQuality)
• PutInteger Method (short, short, int, DateTime,
CMxDataQuality)

• PutIntegerArrayQ Method (string, CMxDataQuality)

• PutIntegerArrayQ Method (short, short,


CMxDataQuality)
• PutMxDataType Method (string, MxDataType)

• PutMxDataType Method (short, short, MxDataType)

• PutMxDataType Method (string, int, MxDataType)

• PutMxDataType Method (string, MxDataType,


CMxDataQuality)

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 73

• PutMxDataType Method (short, short, int, MxDataType)

• PutMxDataType Method (short, short, MxDataType,


CMxDataQuality)

• PutMxDataType Method (string, MxDataType,


DateTime, CMxDataQuality)
• PutMxDataType Method (short, short, MxDataType,
DateTime, CMxDataQuality)

• PutMxDataTypeArrayQ Method (string,


CMxDataQuality)

• PutMxDataTypeArrayQ Method (short, short,


CMxDataQuality)
• PutMxStatus Method (string, MxStatus)
• PutMxStatus Method (short, short, MxStatus)

• PutMxStatus Method (string, int, MxStatus)

• PutMxStatus Method (string, MxStatus,


CMxDataQuality)

• PutMxStatus Method (short, short, int, MxStatus)

• PutMxStatus Method (short, short, MxStatus,


CMxDataQuality)

• PutMxStatus Method (string, MxStatus, DateTime,


CMxDataQuality)
• PutMxStatus Method (short, short, MxStatus, DateTime,
CMxDataQuality)

• PutMxStatusArrayQ Method (string, CMxDataQuality)


• PutMxStatusArrayQ Method (short, short,
CMxDataQuality)

• PutQuality Method (string, MxDataType,


CMxDataQuality)
• PutQuality Method (short, short, MxDataType,
CMxDataQuality)

• PutReference Method (string, IMxReference)

• PutReference Method (short, short, IMxReference)


• PutReference Method (string, IMxReference,
CMxDataQuality)

• PutReference Method (string, int, IMxReference)

ArchestrA Object Toolkit Reference Guide


74 Chapter 1 Class Reference

• PutReference Method (short, short, IMxReference,


CMXDataQuality)

• PutReference Method (short, short, int, IMxReference)

• PutReference Method (string, IMxReference, DateTime,


CMxDataQuality)
• PutReference Method (short, short, IMxReference,
DateTime, CMxDataQuality)

• PutReferenceArrayQ Method (string, CMxDataQuality)

• PutReferenceArrayQ Method (short, short,


CMxDataQuality)

• PutString Method (string, string)

• PutString Method (short, short, string)

• PutString Method (string, int, string)

• PutString Method (string, string, CMxDataQuality)

• PutString Method (short, short, int, string)

• PutString Method (short, short, string, CMxDataQuality)

• PutString Method (string, string, DateTime,


CMxDataQuality)
• PutString Method (short, short, string, DateTime,
CMxDataQuality)

• PutStringArrayQ Method (string, CMxDataQuality)

• PutStringArrayQ Method (short, short,


CMxDataQuality)

• PutTime Method (string, VBFILETIME)

• PutTime Method (short, short, VBFILETIME)


• PutTime Method (string, int, VBFILETIME)

• PutTime Method (string, VBFILETIME,


CMxDataQuality)

• PutTime Method (short, short, int, VBFILETIME)

• PutTime Method (short, short, VBFILETIME,


CMxDataQuality)
• PutTime Method (string, VBFILETIME, DateTime,
CMxDataQuality)

• PutTime Method (short, short, VBFILETIME, DateTime,


CMxDataQuality)

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 75

• PutTimeArrayQ Method (string, CMxDataQuality)

• PutTimeArrayQ Method (short, short, CMxDataQuality)

• PutTimeStamp Method (string, MxDataType, DateTime)


• PutTimeStamp Method (short, short, MxDataType,
DateTime)

• RecreateDynamicAttributes Method

• RestoreDynamicAttributes Method

• SendEvent Method

• SetDataToFailoverField Method

• SetHandler Method

• SetNumElementsEx Method (string, int)

• SetNumElementsEx Method (short, short, int)

• SetQ Method (string, CMxDataQuality)

• SetQ Method (short, short, CMxDataQuality)

• SetScanState Method

• StandbyStartup Method

• StandbyStartup Method

• SuspendLocalAttribute Method (string)

• SuspendLocalAttribute Method (short, string)

• SuspendPrimitiveAttribute Method (string)

• SuspendPrimitiveAttribute Method (short, short)

• UpdateDynamicAttributeData Method

ArchestrA Object Toolkit Reference Guide


76 Chapter 1 Class Reference

ActivateLocalAttribute Method (string)


Provides a method to activate an attribute. This function is
called by auto-generated toolkit code and is typically not to
be used by the Object Developer.
Syntax
public bool ActivateLocalAttribute(
string attributeName
);

Parameter
attributeName
The external name of the attribute.
Return Value
bool

ActivateLocalAttribute Method (short, string)


Provides a method to activate an attribute. This function is
called by auto-generated toolkit code and is typically not to
be used by the Object Developer.
Syntax
public bool ActivateLocalAttribute(
short attributeId,
string attributeName
);

Parameters
attributeId
The attribute ID.
attributeName
The external name of the attribute.
Return Value
bool

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 77

ActivatePrimitiveAttribute Method (string)


Provides a method to activate an attribute of a child
primitive, reusable primitive, or utility primitive.
Syntax
public bool ActivatePrimitiveAttribute(
string fullAttributeName
);

Parameter
fullAttributeName
The name of the primitive attribute. The name
fullAttributeName format should be
"PrimitiveName.AttributeName".
Return Value
bool

ActivatePrimitiveAttribute Method (short, short)


Provides a method to activate an attribute of a child
primitive, reusable primitive, or utility primitive.
Syntax
public bool ActivatePrimitiveAttribute(
short attributeId,
short primitiveId,
);

Parameters
attributeId
The Primitive's attribute ID.
primitiveId
The Primitive ID.
Return Value
bool

ArchestrA Object Toolkit Reference Guide


78 Chapter 1 Class Reference

AddAttribute Method (string, MxAttributeCategory,


MxDataType, bool)
Provides a method to add a Dynamic Attribute to the
Primitive. Use this function if you are adding a non-array
attribute.
Syntax
public bool AddAttribute(
string name,
MxAttributeCategory category,
MxDataType type,
bool setHandler
);

Parameters
Refer to the section AddAttribute Method Parameters and
Return Value.
Return Value
Refer to the section AddAttribute Method Parameters and
Return Value.

AddAttribute Method (string, MxAttributeCategory,


MxDataType, bool)
Provides a method to add a Dynamic Attribute to the
Primitive. Use this function if you are adding a non-array
attribute.
Syntax
public bool AddAttribute(
string name,
MxAttributeCategory category,
MxDataType type,
bool setHandler
);

Parameters
Refer to the section AddAttribute Method Parameters and
Return Value.
Return Value
Refer to the section AddAttribute Method Parameters and
Return Value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 79

AddAttribute Method (string, MxAttributeCategory,


MxDataType, int, bool)
Provides a method to add a Dynamic Attribute Array.
Syntax
public bool AddAttribute(
string name,
MxAttributeCategory category,
MxDataType type,
int length,
bool setHandler
);

Parameters
Refer to the section AddAttribute Method Parameters and
Return Value.
Return Value
Refer to the section AddAttribute Method Parameters and
Return Value.

AddAttribute Method (string, MxAttributeCategory,


MxDataType, MxSecurityClassification, DataQuality,
bool, bool, short)
Provides a detailed method to add a Dynamic Attribute. Use
this function to add a non- array attribute that you want to
exclude from Dump/Load.
Syntax
public bool AddAttribute(
string name,
MxAttributeCategory category,
MxDataType type,
MxSecurityClassification security,
DataQuality quality,
bool setHandler,
bool excludeFromFailover,
out short id
);

Parameters
Refer to the section AddAttribute Method Parameters and
Return Value.
Return Value
Refer to the section AddAttribute Method Parameters and
Return Value.

ArchestrA Object Toolkit Reference Guide


80 Chapter 1 Class Reference

AddAttribute Method (string, MxAttributeCategory,


MxDataType, MxSecurityClassification, DataQuality,
int, bool, bool, short)
Provides a detailed method to add a Dynamic Attribute
Array. Use this function to add a array attribute that you
want to exclude from Dump/Load.
Syntax
public bool AddAttribute(
string name,
MxAttributeCategory category,
MxDataType type,
MxSecurityClassification security,
DataQuality quality,
int length,
bool setHandler,
bool excludeFromFailover,
out short id
);

Parameters
name
Refer to the section AddAttribute Method Parameters and
Return Value.
Return Value
Refer to the section AddAttribute Method Parameters and
Return Value.

AddAttribute Method Parameters and Return Value


Parameters
name
External name of the attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 81

category
Supported categories:
MxCategory_Constant
MxCategory_SystemInternal
MxCategory_SystemSetsOnly
MxCategory_SystemWriteable
MxCategoryCalculated
MxCategoryCalculatedRetentive
MxCategoryWriteable_S
MxCategoryWriteable_U
MxCategoryWriteable_UC
MxCategoryWriteable_UC_Lockable
MxCategoryWriteable_US
MxCategoryWriteable_USC
MxCategoryWriteable_USC_Lockable
type
Supported data types:
MxBigString
MxBoolean
MxDataQualityType
MxDataTypeEnum
MxDouble
MxElapsedTime
MxFloat
MxInteger
MxInternationalizedString
MxNoData
MxQualifiedEnum
MxQualifiedStruct
MxReferenceType
MxSecurityClassificationEnum
MxStatusType
MxString
MxTime

ArchestrA Object Toolkit Reference Guide


82 Chapter 1 Class Reference

setHandler
true: Enables the runtime dynamic set handler.
The user should add a case for the dynamic attribute in the
<objectname>Runtime_RuntimeDynamic function, as the
attribute is not set by default, when this parameter is
marked as true.
length
Indicates the length of the array, pass 0 in case of non-array
attribute.
quality
Supported quality types:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
security
Supported security classifications:
MxSecurityConfigure
MxSecurityFreeAccess
MxSecurityOperate
MxSecuritySecuredWrite
MxSecurityTune
MxSecurityUndefined
MxSecurityVerifiedWrite
MxSecurityViewOnly
excludeFromDumpLoad
If true excludes the attribute from Dumpload.
id
Out parameter with the attribute ID of newly created
dynamic attribute.
Return Value
bool
true: if the attribute is successfully added.
false: fails to add the dynamic attribute if the attribute with
the provided name already exists, or if the user tries to add a
attribute with unsupported category or data type.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 83

AppendNames Method
Appends two names together in a period separated
Application Server format [owner].[child].
Syntax
public string AppendNames(
string owner,
string child
);

Parameters
owner
The owner name.
child
The child name.
Return Value
string
Returns the Archestra name in the format [owner].[child]. If
either name is empty, no period is included.

BindTo Method (string, string)


Provides a method to create an Indirect (CMxIndirect) for
referencing Attributes of other Objects.
Syntax
public CMxIndirect BindTo(
string refString,
string refContext
);

Parameters
refString
The reference of the attribute of another object, in the
format "ObjectName.AttributeName".
refContext
An empty string is used for this parameter when the
refString parameter is specified as
"ObjectName.AttributeName".
When using a relative reference (like "MyArea.ScanState"
or "MyPlatform.CPULoad") in the refString parameter, the
refContext parameter must be the Tagname property of the
object. The refContext parameter can be empty if the
refString parameter contains an absolute path.

ArchestrA Object Toolkit Reference Guide


84 Chapter 1 Class Reference

Remarks
After the BindTo() operation, access the value of the Indirect
only if the Indirect's StatusOfLastRead.success = = -1 and
StatusOfLastRead.Category = =
MxStatusCategory.MxCategoryOk
Example
CMxIndirect mxIndirect = BindTo("MyArea.ScanState",
Tagname);
Return Value
CMxIndirect

BindTo Method (string, string, bool)


Provides a method to create an Indirect (CMxIndirect) for
referencing Attributes of other Objects.
Syntax
public CMxIndirect BindTo(
string refString,
string refContext,
bool suspended
);

Parameters
refString
The reference of the attribute of another object, in the
format "ObjectName.AttributeName".
refContext
An empty string is used for this parameter when the
refString parameter is specified as
"ObjectName.AttributeName". When using a relative
reference (like "MyArea.ScanState" or
"MyPlatform.CPULoad") in the refString parameter, the
refContext parameter must be the Tagname property of the
object. The refContext parameter can be empty if the
refString parameter contains an absolute path.
suspended
true: suspend attribute.
false: Activate attribute.
Return Value
CMxIndirect
Remarks
After the BindTo() operation, access the value of the Indirect
only if the Indirect's StatusOfLastRead.success = = -1 and
StatusOfLastRead.Category = =
MxStatusCategory.MxCategoryOk

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 85

BindToWriteOnly Method (string, string)


Provides a method to create an Indirect
(CMxIndirectWriteOnly) for write-only access to Attributes
of other Objects.
Syntax
public CMxIndirectWriteOnly BindToWriteOnly(
string refString,
string refContext
);

Parameters
refString
The reference of the attribute of another object in
"ObjectName.AttributeName" format.
refContext
An empty string is used for this parameter when the
refString parameter is specified as
"ObjectName.AttributeName". When using a relative
reference (like "MyArea.ScanState" or
"MyPlatform.CPULoad") in the refString parameter, the
refContext parameter must be the Tagname property of the
object. The refContext parameter can be empty if the
refString parameter contains an absolute path.
Example:
CMxIndirectWriteOnly mxIndirect =
BindToWriteOnly("MyArea.ScanState", Tagname);
Return Value
CMxIndirectWriteOnly

BindToWriteOnly Method (string, string, bool)


Provides a method to create an Indirect
(CMxIndirectWriteOnly) for write-only access to Attributes
of other Objects.
Syntax
public CMxIndirectWriteOnly BindToWriteOnly(
string refString,
string refContext,
bool suspended
);

Parameters
refString
The reference of the attribute of another object in
"ObjectName.AttributeName" format.
refContext
An empty string is used for this parameter.

ArchestrA Object Toolkit Reference Guide


86 Chapter 1 Class Reference

suspended
true: suspend attribute.
false: Activate attribute.
Return Value
CMxIndirectWriteOnly

CheckpointDynamicAttributeData Method
Provides a method to store the values of all dynamic
attributes created at runtime, that were not explicitly
excluded from failover. This method should be called
immediately after a dynamic attribute value is changed.
Syntax
public bool CheckpointDynamicAttributeData();
Return Value
bool

DeleteAttribute Method (string)


Provides a method to delete a Dynamic Attribute by
Attribute Name.
Syntax
public void DeleteAttribute(
string name
);

Parameter
name
Name of the Dynamic attribute.

DeleteAttribute Method (string, bool)


Provides a detailed method to delete a Dynamic Attribute
and remove it from the failover data, if needed.
Syntax
public void DeleteAttribute(
string name,
bool failover
);

Parameters
name
Name of the Dynamic attribute.
failover
true: remove the attribute from failover.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 87

GetAttributeName Method (short, short, string)


Provides a method to get the name of an attribute by ID and
primitive ID.
Syntax
public bool GetAttributeName(
short attributeId,
short primitiveId,
out string name
);

Parameters
attributeId
The attribute ID.
PrimitiveId
The primitive ID.
name
Fills the name parameter with the attribute external name.
Return Value
bool
true: access to attribute name is success.
false: fails if the user tries to access a non-existing attribute.

GetAttributeProperties Method (string, MxDataType,


MxSecurityClassification, MxAttributeCategory,
MxPropertyLockedEnum, int, int, int, int, int, int,
int, int, int)
Provides a method to get all the properties of dynamic
attribute by attribute name.
Syntax
public bool GetAttributeProperties(
string fullName,
out MxDataType dataType,
out MxSecurityClassification secClass,
out MxAttributeCategory category,
out MxPropertyLockedEnum locked,
out int hasRtHandler,
out int hasQuality,
out int hasTimestamp,
out int isShared,
out int isArray,
out int isDynamic,
out int isSubscribed,
out int isCheckpointed,
out int hasTypeChanged
);

ArchestrA Object Toolkit Reference Guide


88 Chapter 1 Class Reference

Parameters
Refer to the section GetAttributeProperties Method
Parameters and Return Value.
Return Value
Refer to the section GetAttributeProperties Method
Parameters and Return Value.

GetAttributeProperties Method (short, short,


MxDataType, MxSecurityClassification,
MxAttributeCategory, MxPropertyLockedEnum, int,
int, int, int, int, int, int, int, int)
Provides a method to get all the properties of dynamic
attribute by Attribute ID and Primitive ID.
Syntax
public bool GetAttributeProperties(
short attributeId,
short primitiveId,
out MxDataType dataType,
out MxSecurityClassification secClass,
out MxAttributeCategory category,
out MxPropertyLockedEnum locked,
out int hasRtHandler,
out int hasQuality,
out int hasTimestamp,
out int isShared,
out int isArray,
out int isDynamic,
out int isSubscribed,
out int isCheckpointed,
out int hasTypeChanged
);

Parameters
Refer to the section GetAttributeProperties Method
Parameters and Return Value.
Return Value
Refer to the section GetAttributeProperties Method
Parameters and Return Value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 89

GetAttributeProperties Method Parameters and


Return Value
Parameters
fullName
External Name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
dataType
The out parameter which contains the Datatype of the
attribute.
secClass
The out parameter which contains the Security
Classification of the attribute.
category
The out parameter which contains the Category of the
attribute.
locked
The out parameter which contains the lock status of the
attribute.
hasRtHandler
The out parameter which specifies whether the attribute
has runtime set handler.
1: if attribute has runtime set handler.
0: if attribute doesn't have runtime set handler.
hasQuality
The out parameter which specifies whether the attribute
supports quality.
1: if attribute supports quality.
0: if attribute doesn't supports quality.
hasTimestamp
The out parameter which specifies whether the attribute
has timestamp.
1: if attribute has timestamp.
0:if attribute doesn't have timestamp.

ArchestrA Object Toolkit Reference Guide


90 Chapter 1 Class Reference

isShared
The out parameter which specifies whether the attribute is
shared
1: if attribute is shared type.
0: if attribute is non-shared type.
isArray
The out parameter which specifies whether the attribute is
array type.
1: if attribute is array type.
0: if attribute is non-array type.
isDynamic
The out parameter which specifies whether the attribute is
dynamic.
1: if attribute is dynamic.
0: if attribute is static.
isSubscribed
The out parameter which specifies whether the attribute is
subscribed.
1: if attribute is subscribed.
0: if attribute is not subscribed.
isCheckpointed
The out parameter which specifies whether the attribute
has check point support.
1: if attribute has checkpointed.
0: if attribute in not checkpointed.
hasTypeChanged
The out parameter which specifies whether the attribute
type is changed.
1: if attribute datatype is changed.
0: if attribute datatype is not changed.
Return Value
bool
true: if the attribute is exits and access to the attribute
properties is successful.
false: if the user tries to access a non-existing attribute.

GetBoolean Method (string, bool)


Provides a method to get the value of a Boolean attribute by
its external name.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 91

Syntax
public bool GetBoolean(
string fullName,
out bool value
);

Parameters
Refer to the section GetBoolean Method Parameters and
Return Value
Return Value
Refer to the section GetBoolean Method Parameters and
Return Value

GetBoolean Method (short, short, bool)


Provides a method to get the value of a Boolean attribute by
its ID and Primitive ID.
Syntax
public bool GetBoolean(
short attributeId,
short primitiveId,
out bool value
);

Parameters
Refer to the section GetBoolean Method Parameters and
Return Value
Return Value
Refer to the section GetBoolean Method Parameters and
Return Value

GetBoolean Method (string, int, bool)


Provides a method to get the value of a Boolean array
element by its external name and index.
Syntax
public bool GetBoolean(
string fullName,
int index,
out bool value
);

Parameters
Refer to the section GetBoolean Method Parameters and
Return Value
Return Value
Refer to the section GetBoolean Method Parameters and
Return Value

ArchestrA Object Toolkit Reference Guide


92 Chapter 1 Class Reference

GetBoolean Method (string, bool, CMxDataQuality)


Provides a method to get the value and quality of a Boolean
attribute by its external name.
Syntax
public bool GetBoolean(
string fullName,
out bool value,
out CMxDataQuality quality
);

Parameters
Refer to the section GetBoolean Method Parameters and
Return Value
Return Value
Refer to the section GetBoolean Method Parameters and
Return Value

GetBoolean Method (short, short, int, bool)


Provides a method to get the value of a Boolean array
element by its ID, Primitive ID, and index.
Syntax
public bool GetBoolean(
short attributeId,
short primitiveId,
int index,
out bool value
);

Parameters
Refer to the section GetBoolean Method Parameters and
Return Value
Return Value
Refer to the section GetBoolean Method Parameters and
Return Value

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 93

GetBoolean Method (short, short, bool,


CMxDataQuality)
Provides a method to get the value and quality of a Boolean
attribute by its ID and Primitive ID.
Syntax
public bool GetBoolean(
short attributeId,
short primitiveId,
out bool value,
out CMxDataQuality quality
);

Parameters
Refer to the section GetBoolean Method Parameters and
Return Value
Return Value
Refer to the section GetBoolean Method Parameters and
Return Value

GetBoolean Method (string, bool, DateTime,


CMxDataQuality)
Provides a method to get the value, time, and quality of a
Boolean attribute by its external name.
Syntax
public bool GetBoolean(
string fullName,
out bool value,
out DateTime time,
out CMxDataQuality quality
);

Parameters
Refer to the section GetBoolean Method Parameters and
Return Value
Return Value
Refer to the section GetBoolean Method Parameters and
Return Value

ArchestrA Object Toolkit Reference Guide


94 Chapter 1 Class Reference

GetBoolean Method (short, short, bool, DateTime,


CMxDataQuality)
Provides a method to get the value, time, and quality of a
Boolean attribute by its ID and Primitive ID.
Syntax
public bool GetBoolean(
short attributeId,
short primitiveId,
out bool value,
out DateTime time,
out CMxDataQuality quality
);

Parameters
Refer to the section GetBoolean Method Parameters and
Return Value.
Return Value
Refer to the section GetBoolean Method Parameters and
Return Value.

GetBoolean Method Parameters and Return Value


Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Value
The out parameter which contains the value of the Boolean
attribute.
Index
The Boolean array index.
quality
The out parameter contains the quality property of Boolean
attribute.
time
The out parameter contains the Date and Time associated
with the Boolean attribute.
Return Value
bool
true: if the Boolean attribute accessing is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 95

GetBooleanArrayQ Method (string, CMxDataQuality)


Provides a method to get the quality of a Boolean array
attribute by its external name.
Syntax
public bool GetBooleanArrayQ(
string fullName,
out CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The out parameter contains the quality property of Boolean
attribute.
Return Value
bool
true: if the Boolean attribute quality accessing is successful.
false: if the user tries to access a non-existing attribute.

GetBooleanArrayQ Method (short, short,


CMxDataQuality)
Provides a method to get the quality of a Boolean array
attribute by its ID and primitive ID.
Syntax
public bool GetBooleanArrayQ(
short attributeId,
short primitiveId,
out CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The out parameter contains the quality property of Boolean
attribute.
Return Value
bool
true: if the Boolean attribute quality accessing is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


96 Chapter 1 Class Reference

GetCustomEnum Method (string, short)


Provides a method to get a custom enum ordinal by its
external name.
Syntax
public bool GetCustomEnum(
string fullName,
out short value
);

Parameters
Refer to the section GetCustomEnum Method Parameters
and Return value
Return Value
Refer to the section GetCustomEnum Method Parameters
and Return value

GetCustomEnum Method (short, short, short)


Provides a method to get a custom enum ordinal by its ID
and Primitive ID.
Syntax
public bool GetCustomEnum(
short attributeId,
short primitiveId,
out short value
);

Parameters
Refer to the section GetCustomEnum Method Parameters
and Return value
Return Value
Refer to the section GetCustomEnum Method Parameters
and Return value

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 97

GetCustomEnum Method (string, int, short)


Provides a method to get a custom enum array element
ordinal by its external name and index.
Syntax
public bool GetCustomEnum(
string fullName,
int index,
out short value
);

Parameters
Refer to the section GetCustomEnum Method Parameters
and Return value
Return Value
Refer to the section GetCustomEnum Method Parameters
and Return value

GetCustomEnum Method (string, short,


CMxDataQuality)
Provides a method to get a custom enum ordinal and quality
by its external name.
Syntax
public bool GetCustomEnum(
string fullName,
out short value,
out CMxDataQuality quality
);

Parameters
Refer to the section GetCustomEnum Method Parameters
and Return value
Return Value
Refer to the section GetCustomEnum Method Parameters
and Return value

ArchestrA Object Toolkit Reference Guide


98 Chapter 1 Class Reference

GetCustomEnum Method (short, short, int, short)


Provides a method to get a custom enum array element
ordinal by its ID, Primitive ID and index.
Syntax
public bool GetCustomEnum(
short attributeId,
short primitiveId,
int index,
out short value
);

Parameters
Refer to the section GetCustomEnum Method Parameters
and Return value
Return Value
Refer to the section GetCustomEnum Method Parameters
and Return value

GetCustomEnum Method (short, short, short,


CMxDataQuality)
Provides a method to get a custom enum ordinal and quality
by its ID and Primitive ID.
Syntax
public bool GetCustomEnum(
short attributeId,
short primitiveId,
out short value,
out CMxDataQuality quality
);

Parameters
Refer to the section GetCustomEnum Method Parameters
and Return value
Return Value
Refer to the section GetCustomEnum Method Parameters
and Return value

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 99

GetCustomEnum Method (string, short, DateTime,


CMxDataQuality)
Provides a method to get a custom enum ordinal, time, and
quality by its external name.
Syntax
public bool GetCustomEnum(
string fullName,
out short value,
out DateTime time,
out CMxDataQuality quality
);

Parameters
Refer to the section GetCustomEnum Method Parameters
and Return value
Return Value
Refer to the section GetCustomEnum Method Parameters
and Return value

GetCustomEnum Method (short, short, short,


DateTime, CMxDataQuality)
Provides a method to get a custom enum ordinal, time, and
quality by its ID and Primitive ID.
Syntax
public bool GetCustomEnum(
short attributeId,
short primitiveId,
out short value,
out DateTime time,
out CMxDataQuality quality
);

Parameters
Refer to the section GetCustomEnum Method Parameters
and Return value.
Return Value
Refer to the section GetCustomEnum Method Parameters
and Return value.

ArchestrA Object Toolkit Reference Guide


100 Chapter 1 Class Reference

GetCustomEnum Method Parameters and Return


value
Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Value
The out parameter which contains the ordinal value of the
CustomEnum attribute.
Index
The CustomEnum array index.
quality
The quality property of CustomEnum attribute.
time
The out parameter contains the Date and Time associated
with the CustomEnum attribute.
Return Value
bool
true: if the CustomEnum attribute accessing is successful.
false: if the user tries to access a non-existing attribute.

GetCustomStruct Method (string, MxCustomStruct)


Provides a method to get the value of a CustomStruct
attribute by its external name.
Syntax
public bool GetCustomStruct(
string fullName,
out MxCustomStruct value
);
Parameters
Refer to the section GetCustomStruct Method Parameters
and Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 101

GetCustomStruct Method (short, short,


MxCustomStruct)
Provides a method to get the value of a CustomStruct
attribute by its id and primitive id.
Syntax
public bool GetCustomStruct(
short attributeId,
short primitiveId,
out MxCustomStruct value
);

Parameters
Refer to the section GetCustomStruct Method Parameters
and Return value.

GetCustomStruct Method (string, int,


MxCustomStruct)
Provides a method to get the value of a CustomStruct array
element by its external name and index.
Syntax
public bool GetCustomStruct(
string fullName,
int index,
out MxCustomStruct value
);

Parameters
Refer to the section GetCustomStruct Method Parameters
and Return value.

GetCustomStruct Method (string, MxCustomStruct,


CMxDataQuality)
Provides a method to get the value and quality of a
CustomStruct attribute by its external name.
Syntax
public bool GetCustomStruct(
string fullName,
out MxCustomStruct value,
out CMxDataQuality quality
);

Parameters
Refer to the section GetCustomStruct Method Parameters
and Return value.

ArchestrA Object Toolkit Reference Guide


102 Chapter 1 Class Reference

GetCustomStruct Method (short, short, int,


MxCustomStruct)
Provides a method to get the value of a CustomStruct array
element by its id, primitive id, and index.
Syntax
public bool GetCustomStruct(
short attributeId,
short primitiveId,
int index,
out MxCustomStruct value
);

Parameters
Refer to the section GetCustomStruct Method Parameters
and Return value.

GetCustomStruct Method (short, short,


MxCustomStruct, CMxDataQuality)
Provides a method to get the value and quality of a
CustomStruct attribute by its id and primitive id.
Syntax
public bool GetCustomStruct(
short attributeId,
short primitiveId,
out MxCustomStruct value,
out CMxDataQuality quality
);

Parameters
Refer to the section GetCustomStruct Method Parameters
and Return value.

GetCustomStruct Method (string, MxCustomStruct,


DateTime, CMxDataQuality)
Provides a method to get the value, time, and quality of a
CustomStruct attribute by its external name.
Syntax
public bool GetCustomStruct(
string fullName,
out MxCustomStruct value,
out DateTime time,
out CMxDataQuality quality
);

Parameters
Refer to the section GetCustomStruct Method Parameters
and Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 103

GetCustomStruct Method (short, short,


MxCustomStruct, DateTime, CMxDataQuality)
Provides a method to get the value, time, and quality of a
CustomStruct attribute by its id and primitive id.
Syntax
public bool GetCustomStruct(
short attributeId,
short primitiveId,
out MxCustomStruct value,
out DateTime time,
out CMxDataQuality quality
);

Parameters
Refer to the section GetCustomStruct Method Parameters
and Return value.

GetCustomStruct Method Parameters and Return


value
fullName
External name of the attribute.
attributeId
Attribute id.
primitiveId
Primitive id of an attribute.
Value
The out parameter which contains the value of a
CustomStruct attribute.
Index
The CustomStruct array index.
quality
The out parameter contains the quality property of
CustomStruct attribute.
time
The out parameter contains the Date and time associated
with the CustomStruct attribute.
Return Value
bool
true: if the CustomStruct attribute accessing is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


104 Chapter 1 Class Reference

GetCustomEnumArrayQ Method (string,


CMxDataQuality)
Provides a method to get a custom enum array quality by its
external name.
Syntax
public bool GetCustomEnumArrayQ(
string fullName,
out CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The out parameter contains the quality property of
CustomEnum attribute.
Return Value
bool
true: if the CustomEnum attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

GetCustomEnumArrayQ Method (short, short,


CMxDataQuality)
Provides a method to get a custom enum array quality by its
ID and Primitive ID.
Syntax
public bool GetCustomEnumArrayQ(
short attributeId,
short primitiveId,
out CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Return Value
bool
The out parameter contains the quality property of
CustomEnum attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 105

GetCustomStructArrayQ Method (string,


CMxDataQuality)
Provides a method to get a custom struct array quality by its
external name.
Syntax
public bool GetCustomStructArrayQ(
string fullName,
out CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The out parameter contains the quality property of
CustomStruct array attribute.
Return Value
bool
true: if the CustomStruct array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

GetCustomStructArrayQ Method (short, short,


CMxDataQuality)
Provides a method to get a custom struct array quality by its
ID and Primitive ID.
Syntax
public bool GetCustomStructArrayQ(
short attributeId,
short primitiveId,
out CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The out parameter contains the quality property of
CustomStruct array attribute.

ArchestrA Object Toolkit Reference Guide


106 Chapter 1 Class Reference

Return Value
bool
true: if the CustomStruct array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

GetDataFromFailoverField Method
Provides a method to get the data stored in the Failover
Attributes as a C# object. The object developer is not
expected to typically use this method.
Syntax
public object GetDataFromFailoverField();

Return Value
object

GetDefaultTimeStamp Method
Provides a method to get the object startup time.
Syntax
public bool GetDefaultTimeStamp(
out DateTime timestamp
);

Parameter
timestamp
The out parameter contains the Object startup time.
Return Value
bool
true: If the object startup time accessing is successful.
false: If the object startup time accessing failed.

GetDouble Method (string, double)


Provide a method to get the value of a Double attribute by its
external name.
Syntax
public bool GetDouble(
string fullName,
out double value
);
Parameters
Refer to the section GetDouble Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 107

GetDouble Method (short, short, double)


Provides a method to get the value of a Double attribute by
its id and primitive id.
Syntax
public bool GetDouble(
short attributeId,
short primitiveId,
out double value
);
Parameters
Refer to the section GetDouble Method Parameters and
Return value.

GetDouble Method (string, int, double)


Provides a method to get the value of a Double array element
by its external name and index.
Syntax
public bool GetDouble(
string fullName,
int index,
out double value
);
Parameters
Refer to the section GetDouble Method Parameters and
Return value.

GetDouble Method (string, double, CMxDataQuality)


Provides a method to get the value and quality of a Double
attribute by its external name.
Syntax
public bool GetDouble(
string fullName,
out double value,
out CMxDataQuality quality
);
Parameters
Refer to the section GetDouble Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


108 Chapter 1 Class Reference

GetDouble Method (short, short, int, double)


Provides a method to get the value of a Double array element
by its id, primitive id, and index.
Syntax
public bool GetDouble(
short attributeId,
short primitiveId,
int index,
out double value
);
Parameters
Refer to the section GetDouble Method Parameters and
Return value.

GetDouble Method (short, short, double,


CMxDataQuality)
Provides a method to get the value and quality of a Double
attribute by its id and primitive id.
Syntax
public bool GetDouble(
short attributeId,
short primitiveId,
out double value,
out CMxDataQuality quality
);
Parameters
Refer to the section GetDouble Method Parameters and
Return value.

GetDouble Method (string, double, DateTime,


CMxDataQuality)
Provides a method to get the value,time and quality of a
Double attribute by its external name.
Syntax
public bool GetDouble(
string fullName,
out double value,
out DateTime time,
out CMxDataQuality quality
);
Parameters
Refer to the section GetDouble Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 109

GetDouble Method (short, short, double, DateTime,


CMxDataQuality)
Provides a method to get the value,time and quality of a
Double attribute by its id and primitive id.
Syntax
public bool GetDouble(
short attributeId,
short primitiveId,
out double value,
out DateTime time,
out CMxDataQuality quality
);
Parameters
Refer to the section GetDouble Method Parameters and
Return value.

GetDouble Method Parameters and Return value


fullName
External name of the attribute.
attributeId
Attribute id.
primitiveId
Primitive id of an attribute.
Value
The out parameter which contains the value of a Double
attribute.
Index
The Double array index.
quality
The out parameter contains the quality property of Double
attribute.
time
The out parameter contains the Date and Time associated
with the Double attribute.
Return Value
bool
true: if the Double attribute accessing is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


110 Chapter 1 Class Reference

GetDoubleArrayQ Method (string, CMxDataQuality)


Provides a method to get the quality of a double array
attribute by its external name.
Syntax
public bool GetDoubleArrayQ(
string fullName,
out CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The out parameter contains the quality property of Double
array attribute.
Return Value
bool
true: if the Double array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

GetDoubleArrayQ Method (short, short,


CMxDataQuality)
Provides a method to get the quality of a double array
attribute by its ID and Primitive ID.
Syntax
public bool GetDoubleArrayQ(
short attributeId,
short primitiveId,
out CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The out parameter contains the quality property of Double
array attribute.
Return Value
bool
true: if the Double array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 111

GetElapsedTime Method (string, TimeSpan)


Provides a method to get the value of an ElapsedTime
attribute by its external name.
Syntax
public bool GetElapsedTime(
string fullName,
out TimeSpan value
);
Parameters
Refer to the section GetElapsedTime Method Parameters
and Return value.

GetElapsedTime Method (short, short, TimeSpan)


Provides a method to get the value of an ElapsedTime
attribute by its id and primitive id.
Syntax
public bool GetElapsedTime(
short attributeId,
short primitiveId,
out TimeSpan value
);
Parameters
Refer to the section GetElapsedTime Method Parameters
and Return value.

GetElapsedTime Method (string, int, TimeSpan)


Provides a method to get the value of an ElapsedTime array
element by its external name and index.
Syntax
public bool GetElapsedTime(
string fullName,
int index,
out TimeSpan value
);
Parameters
Refer to the section GetElapsedTime Method Parameters
and Return value.

ArchestrA Object Toolkit Reference Guide


112 Chapter 1 Class Reference

GetElapsedTime Method (string, TimeSpan,


CMxDataQuality)
Provides a method to get the value and quality of an
ElapsedTime attribute by its external name.
Syntax
public bool GetElapsedTime(
string fullName,
out TimeSpan value,
out CMxDataQuality quality
);
Parameters
Refer to the section GetElapsedTime Method Parameters
and Return value.

GetElapsedTime Method (short, short, int,


TimeSpan)
Provides a method to get the value of an ElapsedTime array
element by its id, primitive id, and index.
Syntax
public bool GetElapsedTime(
short attributeId,
short primitiveId,
int index,
out TimeSpan value
);
Parameters
Refer to the section GetElapsedTime Method Parameters
and Return value.

GetElapsedTime Method (short, short, TimeSpan,


CMxDataQuality)
Provides a method to get the value and quality of an
ElapsedTime attribute by its id and primitive id.
Syntax
public bool GetElapsedTime(
short attributeId,
short primitiveId,
out TimeSpan value,
out CMxDataQuality quality
);
Parameters
Refer to the section GetElapsedTime Method Parameters
and Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 113

GetElapsedTime Method (string, TimeSpan,


DateTime, CMxDataQuality)
Provides a method to get the value, time, and quality of an
ElapsedTime attribute by its external name.
Syntax
public bool GetElapsedTime(
string fullName,
out TimeSpan value,
out DateTime time,
out CMxDataQuality quality
);
Parameters
Refer to the section GetElapsedTime Method Parameters
and Return value.

GetElapsedTime Method (short, short, TimeSpan,


DateTime, CMxDataQuality)
Provides a method to get the value, time, and quality of an
ElapsedTime attribute by its id and primitive id.
Syntax
public bool GetElapsedTime(
short attributeId,
short primitiveId,
out TimeSpan value,
out DateTime time,
out CMxDataQuality quality
);
Parameters
Refer to the section GetElapsedTime Method Parameters
and Return value.

GetElapsedTime Method Parameters and Return


value
fullName
External name of the attribute.
attributeId
Attribute id.
primitiveId
Primitive id of an attribute.
Value
The out parameter which contains the value of an
ElapsedTime attribute.
Index
The ElapsedTime array index.

ArchestrA Object Toolkit Reference Guide


114 Chapter 1 Class Reference

quality
The out parameter contains the quality property of an
ElapsedTime attribute.
time
The out parameter contains the Date and time associated
with the ElapsedTime attribute.
Return Value
bool
true: if the ElapsedTime attribute accessing is successful.
false: if the user tries to access a non-existing attribute.

GetElapsedTimeArrayQ Method (string,


CMxDataQuality)
Provides a method to get the quality of an ElapsedTime array
attribute by its external name.
Syntax
public bool GetElapsedTimeArrayQ(
string fullName,
out CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The out parameter contains the quality property of
ElapsedTime array attribute.
Return Value
bool
true: if ElapsedTime array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 115

GetElapsedTimeArrayQ Method (short, short,


CMxDataQuality)
Provides a method to get the quality of an ElapsedTime array
attribute by its ID and Primitive ID.
Syntax
public bool GetElapsedTimeArrayQ(
short attributeId,
short primitiveId,
out CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The out parameter contains the quality property of
ElapsedTime array attribute.
Return Value
bool
true: if ElapsedTime array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

GetFloat Method (string, float)


Provides a method to get the value of a float attribute by its
external name.
Syntax
public bool Float(
string fullName,
out float value
);
Parameters
Refer to the section GetFloat Method Parameters and Return
value.

ArchestrA Object Toolkit Reference Guide


116 Chapter 1 Class Reference

GetFloat Method (short, short, float)


Provides a method to get the value of a float attribute by its
id and primitive id.
Syntax
public bool Float(
short attributeId,
short primitiveId,
out float value
);
Parameters
Refer to the section GetFloat Method Parameters and Return
value.

GetFloat Method (string, int, float)


Provides a method to get the value of a float array element
by its external name and index.
Syntax
public bool GetFloat(
string fullName,
int index,
out float value
);
Parameters
Refer to the section GetFloat Method Parameters and Return
value.

GetFloat Method (string, float, CMxDataQuality)


Provides a method to get the value and quality of a float
attribute by its external name.
Syntax
public bool GetFloat(
string fullName,
out float value,
out CMxDataQuality quality
);
Parameters
Refer to the section GetFloat Method Parameters and Return
value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 117

GetFloat Method (short, short, int, float)


Provides a method to get the value of a float array element by
its id, primitive id, and index.
Syntax
public bool GetFloat(
short attributeId,
short primitiveId,
int index,
out float value
);
Parameters
Refer to the section GetFloat Method Parameters and Return
value.

GetFloat Method (short, short, float,


CMxDataQuality)
Provides a method to get the value and quality of a float
attribute by its id and primitive id.
Syntax
public bool GetFloat(
short attributeId,
short primitiveId,
out float value,
out CMxDataQuality quality
);
Parameters
Refer to the section GetFloat Method Parameters and Return
value.

GetFloat Method (string, float, DateTime,


CMxDataQuality)
Provides a method to get the value, time, and quality of a
float attribute by its external name.
Syntax
public bool GetFloat(
string fullName,
out float value,
out DateTime time,
out CMxDataQuality quality
);
Parameters
Refer to the section GetFloat Method Parameters and Return
value.

ArchestrA Object Toolkit Reference Guide


118 Chapter 1 Class Reference

GetFloat Method (short, short, float, DateTime,


CMxDataQuality)
Provides a method to get the value,time and quality of a float
attribute by its id and primitive id.
Syntax
public bool GetFloat(
short attributeId,
short primitiveId,
out float value,
out DateTime time,
out CMxDataQuality quality
);
Parameters
Refer to the section GetFloat Method Parameters and Return
value.

GetFloat Method Parameters and Return value


fullName
External name of the attribute.
attributeId
Attribute id.
primitiveId
Primitive id of an attribute.
Value
The out parameter which contains the value of a float
attribute.
Index
The Float array index.
quality
The out parameter contains the quality property of Float
attribute.
time
The out parameter contains the Date and Time associated
with the Float attribute.
Return Value
bool
true: if the Float attribute accessing is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 119

GetFloatArrayQ Method (string, CMxDataQuality)


Provides a method to get the quality of Float array attribute
by its external name.
Syntax
public bool GetFloatArrayQ(
string fullName,
out CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The out parameter contains the quality property of Float
array attribute.
Return Value
bool
true: if the Float array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

GetFloatArrayQ Method (short, short,


CMxDataQuality)
Provides a method to get the quality of a Float array
attribute by its ID and Primitive ID.
Syntax
public bool GetFloatArrayQ(
short attributeId,
short primitiveId,
out CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The out parameter contains the quality property of Float
array attribute.
Return Value
bool
true: if the Float array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


120 Chapter 1 Class Reference

GetInteger Method (string, int)


Provides a method to get the value of an integer attribute by
its external name.
Syntax
public bool GetInteger(
string fullName,
out int value
);
Parameters
Refer to the section GetInteger Method Parameters and
Return value.

GetInteger Method (short, short, int)


Provides a method to get the value of an integer attribute by
its id and primitive id.
Syntax
public bool GetInteger(
short attributeId,
short primitiveId,
out int value
);
Parameters
Refer to the section GetInteger Method Parameters and
Return value.

GetInteger Method (string, int, int)


Provides a method to get the value of an integer array
element by its external name and index.
Syntax
public bool GetInteger(
string fullName,
int index,
out int value
);
Parameters
Refer to the section GetInteger Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 121

GetInteger Method (string, int, CMxDataQuality)


Provides a method to get the value and quality of an integer
attribute by its external name.
Syntax
public bool GetInteger(
string fullName,
out int value,
out CMxDataQuality quality
);
Parameters
Refer to the section GetInteger Method Parameters and
Return value.

GetInteger Method (short, short, int, int)


Provides a method to get the value of an integer array
element by its id, primitive id, and index.
Syntax
public bool GetInteger(
short attributeId,
short primitiveId,
int index,
out int value
);
Parameters
Refer to the section GetInteger Method Parameters and
Return value.

GetInteger Method (short, short, int,


CMxDataQuality)
Provides a method to get the value and quality of an integer
attribute by its id and primitive id.
Syntax
public bool GetInteger(
short attributeId,
short primitiveId,
out int value,
out CMxDataQuality quality
);
Parameters
Refer to the section GetInteger Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


122 Chapter 1 Class Reference

GetInteger Method (string, int, DateTime,


CMxDataQuality)
Provides a method to get the value, time, and quality of an
integer attribute by its external name.
Syntax
public bool GetInteger(
string fullName,
out int value,
out DateTime time,
out CMxDataQuality quality
);
Parameters
Refer to the section GetInteger Method Parameters and
Return value.

GetInteger Method (short, short, int, DateTime,


CMxDataQuality)
Provides a method to get the value, time, and quality of an
integer attribute by its id and primitive id.
Syntax
public bool GetInteger(
short attributeId,
short primitiveId,
out int value,
out DateTime time,
out CMxDataQuality quality
);
Parameters
Refer to the section GetInteger Method Parameters and
Return value.

GetInteger Method Parameters and Return value


fullName
External name of the attribute.
attributeId
Attribute id.
primitiveId
Primitive id of an attribute.
Value
The out parameter which contains the value of an integer
attribute.
Index
The Integer array index.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 123

quality
The out parameter contains the quality property of Integer
attribute.
time
The out parameter contains the Date and Time associated
with the Integer attribute.
Return Value
bool
true: if the Integer attribute accessing is successful.
false: if the user tries to access a non-existing attribute.

GetIntegerArrayQ Method (string, CMxDataQuality)


Provides a method to get the quality of an Integer array
attribute by its external name.
Syntax
public bool GetIntegerArrayQ(
string fullName,
out CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The out parameter contains the quality property of Integer
array attribute.
Return Value
boo
true: if the Integer array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


124 Chapter 1 Class Reference

GetIntegerArrayQ Method (short, short,


CMxDataQuality)
Provides a method to get the quality of a Integer array
attribute by its ID and Primitive ID.
Syntax
public bool GetIntegerArrayQ(
short attributeId,
short primitiveId,
out CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The out parameter contains the quality property of Integer
array attribute.
Return Value
bool
true: if the Integer array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

GetLockStatus Method (string,


MxPropertyLockedEnum)
Provides a method to get the LockStatus of an attribute by its
external name.
Syntax
public bool GetLockStatus(
string fullName,
out MxPropertyLockedEnum lockStatus
);

Parameters
fullName
External name of the attribute.
lockStatus
The out parameter contains the LockStatus property of an
attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 125

Return Value
bool
true: if the attribute LockStatus accessing is successful.
false: if the user tries to access a non-existing attribute.

GetLockStatus Method (short, short,


MxPropertyLockedEnum)
Provides a method to get the LockStatus of an attribute by its
ID and Primitive ID.
Syntax
public bool GetLockStatus(
short attributeId,
short primitiveId,
out MxPropertyLockedEnum lockStatus
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
lockStatus
The out parameter contains the LockStatus property of an
attribute.
Return Value
bool
true: if the attribute LockStatus accessing is successful.
false: if the user tries to access a non-existing attribute.

GetMxDataType Method (string, MxDataType)


Provides a method to get the value of a MxDataType
attribute by its external name.
Syntax
public bool GetMxDataType(
string fullName,
out MxDataType value
);
Parameters
Refer to the section GetMxDataType Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


126 Chapter 1 Class Reference

GetMxDataType Method (short, short, MxDataType)


Provides a method to get the value of a MxDataType
attribute by its id and primitive id.
Syntax
public bool GetMxDataType(
short attributeId,
short primitiveId,
out MxDataType value
);
Parameters
Refer to the section GetMxDataType Method Parameters and
Return value.

GetMxDataType Method (string, int, MxDataType)


Provides a method to get the value of a MxDataType array
element by its external name and index.
Syntax
public bool GetMxDataType(
string fullName,
int index,
out MxDataType value
);
Parameters
Refer to the section GetMxDataType Method Parameters and
Return value.

GetMxDataType Method (string, MxDataType,


CMxDataQuality)
Provides a method to get the value and quality of a
MxDataType attribute by its external name.
Syntax
public bool GetMxDataType(
string fullName,
out MxDataType value,
out CMxDataQuality quality
);
Parameters
Refer to the section GetMxDataType Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 127

GetMxDataType Method (short, short, int,


MxDataType)
Provides a method to get the value of a MxDataType array
element by its id, primitive id, and index.
Syntax
public bool GetMxDataType(
short attributeId,
short primitiveId,
int index,
out MxDataType value
);
Parameters
Refer to the section GetMxDataType Method Parameters and
Return value.

GetMxDataType Method (short, short, MxDataType,


CMxDataQuality)
Provides a method to get the value and quality of a
MxDataType attribute by its id and primitive id.
Syntax
public bool GetMxDataType(
short attributeId,
short primitiveId,
out MxDataType value,
out CMxDataQuality quality
);
Parameters
Refer to the section GetMxDataType Method Parameters and
Return value.

GetMxDataType Method (string, MxDataType,


DateTime, CMxDataQuality)
Provides a method to get the value, time, and quality of a
MxDataType attribute by its external name.
Syntax
public bool GetMxDataType(
string fullName,
out MxDataType value,
out DateTime time,
out CMxDataQuality quality
);
Parameters
Refer to the section GetMxDataType Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


128 Chapter 1 Class Reference

GetMxDataType Method (short, short, MxDataType,


DateTime, CMxDataQuality)
Provides a method to get the value, time, and quality of a
MxDataType attribute by its id and primitive id.
Syntax
public bool GetMxDataType(
short attributeId,
short primitiveId,
out MxDataType value,
out DateTime time,
out CMxDataQuality quality
);
Parameters
Refer to the section GetMxDataType Method Parameters and
Return value.

GetMxDataType Method Parameters and Return


value
fullName
External name of the attribute.
attributeId
Attribute id.
primitiveId
Primitive id of an attribute.
Value
The out parameter which contains the value of an
MxDataType attribute.
Index
The MxDataType array index.
quality
The out parameter contains the quality property of
MxDataType attribute.
time
The out parameter contains the Date and time associated
with the MxDataType attribute.
Return Value
bool
true: if the MxDataType attribute accessing is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 129

GetMxDataTypeArrayQ Method (string,


CMxDataQuality)
Provides a method to get the quality of a MxDataType array
attribute by its external name.
Syntax
public bool GetMxDataTypeArrayQ(
string fullName,
out CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The out parameter contains the quality property of
MxDataType array attribute.
Return Value
bool
true: if the MxDataType array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

GetMxDataTypeArrayQ Method (short, short,


CMxDataQuality)
Provides a method to get the quality of a MxDataType array
attribute by its ID and Primitive ID.
Syntax
public bool GetMxDataTypeArrayQ(
short attributeId,
short primitiveId,
out CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The out parameter contains the quality property of
MxDataType array attribute.

ArchestrA Object Toolkit Reference Guide


130 Chapter 1 Class Reference

Return Value
bool
true: if MxDataType array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

GetMxStatus Method (string, MxStatus)


Provides a method to get the value of a MxStatus attribute
by its external name.
Syntax
public bool GetMxStatus(
string fullName,
out MxStatus value
);

Parameters
Refer to the section GetMxStatus Method Parameters and
Return value.
Return Value
Refer to the section GetMxStatus Method Parameters and
Return value.

GetMxStatus Method (short, short, MxStatus)


Provides a method to get the value of a MxStatus attribute
by its ID and Primitive ID.
Syntax
public bool GetMxStatus(
short attributeId,
short primitiveId,
out MxStatus value
);

Parameters
Refer to the section GetMxStatus Method Parameters and
Return value.
Return Value
Refer to the section GetMxStatus Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 131

GetMxStatus Method (string, int, MxStatus)


Provides a method to get the value of a MxStatus array
element by its external name and index.
Syntax
public bool GetMxStatus(
string fullName,
int index,
out MxStatus value
);

Parameters
Refer to the section GetMxStatus Method Parameters and
Return value.
Return Value
Refer to the section GetMxStatus Method Parameters and
Return value.

GetMxStatus Method (string, MxStatus,


CMxDataQuality)
Provides a method to get the value and quality of a MxStatus
attribute by its external name.
Syntax
public bool GetMxStatus(
string fullName,
out MxStatus value,
out CMxDataQuality quality
);

Parameters
Refer to the section GetMxStatus Method Parameters and
Return value
Return Value
Refer to the section GetMxStatus Method Parameters and
Return value

ArchestrA Object Toolkit Reference Guide


132 Chapter 1 Class Reference

GetMxStatus Method (short, short, int, MxStatus)


Provides a method to get the value of a MxStatus array
element by its ID, Primitive ID and index.
Syntax
public bool GetMxStatus(
short attributeId,
short primitiveId,
int index,
out MxStatus value
);

Parameters
Refer to the section GetMxStatus Method Parameters and
Return value
Return Value
Refer to the section GetMxStatus Method Parameters and
Return value

GetMxStatus Method (short, short, MxStatus,


CMxDataQuality)
Provides a method to get the value and quality of a MxStatus
array attribute by its ID and Primitive ID.
Syntax
public bool GetMxStatus(
short attributeId,
short primitiveId,
out MxStatus value,
out CMxDataQuality quality
);

Parameters
Refer to the section GetMxStatus Method Parameters and
Return value
Return Value
Refer to the section GetMxStatus Method Parameters and
Return value

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 133

GetMxStatus Method (string, MxStatus, DateTime,


CMxDataQuality)
Provides a method to get the value, time, and quality of a
MxStatus attribute by external name.
Syntax
public bool GetMxStatus(
string fullName,
out MxStatus value,
out DateTime time,
out CMxDataQuality quality
);

Parameters
Refer to the section GetMxStatus Method Parameters and
Return value
Return Value
Refer to the section GetMxStatus Method Parameters and
Return value

GetMxStatus Method (short, short, MxStatus,


DateTime, CMxDataQuality)
Provides a method to get the value, time, and quality of a
MxStatus attribute by its ID and primitive ID.
Syntax
public bool GetMxStatus(
short attributeId,
short primitiveId,
out MxStatus value,
out DateTime time,
out CMxDataQuality quality
);

Parameters
Refer to the section GetMxStatus Method Parameters and
Return value.
Return Value
Refer to the section GetMxStatus Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


134 Chapter 1 Class Reference

GetMxStatus Method Parameters and Return value


fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Value
The out parameter which contains the value of the
MxStatus attribute.
Index
The MxStatus array index.
quality
The quality property of MxStatus attribute.
time
The out parameter contains the Date and Time associated
with the MxStatus attribute.
Return Value
bool
true: if the MxStatus attribute accessing is successful.
false: if the user tries to access a non-existing attribute.

GetMxStatusArrayQ Method (string, CMxDataQuality)


Provides a method to get the quality of a MxStatus array
attribute by its external name.
Syntax
public bool GetMxStatusArrayQ(
string fullName,
out CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The out parameter contains the quality property of the
MxStatus array attribute.
Return Value
bool
true: if the MxStatus array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 135

GetMxStatusArrayQ Method (short, short,


CMxDataQuality)
Provides a method to get the quality of a MxStatus array
attribute by its ID and Primitive ID.
Syntax
public bool GetMxStatusArrayQ(
short attributeId,
short primitiveId,
out CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The out parameter contains the quality property of
MxStatus array attribute.
Return Value
bool
true: if the MxStatus array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

GetNormalChildID Method
Provides a method to access the ID of a non-virtual Child
Primitive by its parent primitive ID and primitive internal
name.
Syntax
public short GetNormalChildID(
short parentPrimID,
string primInternalName
);

Parameters
parentPrimID
The parent primitive ID.
primInternalName
The primitive internal name.
Return Value
bool

ArchestrA Object Toolkit Reference Guide


136 Chapter 1 Class Reference

GetNumElementsEx Method (string, int)


Provides a method to return the number of elements of an
array attribute by its external name.
Syntax
public bool GetNumElementsEx(
string fullName,
out int numElements
);

Parameters
fullName
The Name of the array attribute.
numElements
The out parameter contains the number of elements in the
array.
Return Value
bool
true: if the accessing of number of elements in array
elements is successful.
false: if the user tries to access a non-existing attribute.

GetNumElementsEx Method (short, short, int)


Provides a method to return the number of elements of an
array attribute by its ID and Primitive ID.
Syntax
public bool GetNumElementsEx(
short attributeId,
short primitiveId,
out int numElements
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
numElements
The out parameter contains the number of elements in the
array.
Return Value
bool
true: if the accessing of number of elements in an array is
successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 137

GetPrimitiveIds Method
Provides a method to return ID's of the primitives in an
object.
Syntax
public bool GetPrimitiveIds(out short[] primitiveIds);

Parameter
primitiveIds
The array contains all the primitive IDs.
Return Value
bool

GetPrimitiveInfo Method
Provides an implementation of IPrimitiveDeployment
member returning the file that contains the aaDEF as a
resource and the ID of the resource in the file.
Syntax
public void GetPrimitiveInfo(
ref string pFilename,
ref int pResourceId
);

Parameters
pFilename
The file name.
pResourceId
The resource ID.

GetPrimitiveRuntimeSite2 Method
Provides access to RuntimeSite2 interface of a primitive by
ID.
Syntax
public IPrimitiveRuntimeSite2
GetPrimitiveRuntimeSite2(short _primID);
Parameter
_primID
The primitive.
Return Value
IPrimitiveRuntimeSite2

ArchestrA Object Toolkit Reference Guide


138 Chapter 1 Class Reference

GetQ Method (string)


Provides a method to get the quality of an attribute by name.
Syntax
public CMxDataQuality GetQ(string fullName);
Parameter
fullName
External Name of the attribute.
Return Value
CMxDataQuality

GetQ Method (short, short)


Provides a method to get the quality of an attribute by ID
and Primitive ID.
Syntax
public CMxDataQuality GetQ(
short attributeId,
short primitiveId
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Return Value
CMxDataQuality

GetQuality Method (string, MxDataType,


CMxDataQuality)
Provides a method to get the quality of an attribute by its
type and name.
Syntax
public bool GetQuality(
string fullName,
MxDataType dataType,
out CMxDataQuality quality
);

Parameters
fullName
External Name of the attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 139

dataType
The Datatype of an attribute. The supported datatype are:
MxBoolean
MxInteger
MxFloat
MxDouble
MxString
MxTime
MxElapsedTime
MxReferenceType
MxStatusType
MxDataTypeEnum
MxQualifiedEnum
MxQualifiedStruct
quality
The out parameter contains the quality property of an
attribute.
Return Value
bool
true: if attribute quality accessing is successful.
false: if the user tries to access a non-existing attribute.

GetQuality Method (short, short, MxDataType,


CMxDataQuality)
Provides a method to get the quality of an attribute by its
type, ID, and Primitive ID.
Syntax
public bool GetQuality(
short attributeId,
short primitiveId,
MxDataType dataType,
out CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.

ArchestrA Object Toolkit Reference Guide


140 Chapter 1 Class Reference

dataType
The Datatype of an attribute. The supported datatype are:
MxBoolean
MxInteger
MxFloat
MxDouble
MxString
MxTime
MxElapsedTime
MxReferenceType
MxStatusType
MxDataTypeEnum
MxQualifiedEnum
MxQualifiedStruct
quality
The out parameter contains the quality property of an
attribute.
Return Value
bool
true: if attribute quality accessing is successful.
false: if the user tries to access a non-existing attribute.

GetReference Method (string, IMxReference)


Provides a method to access the reference attribute by its
external name.
Syntax
public bool GetReference(
string fullName,
out IMxReference value
);

Parameters
Refer to the section GetReference Method Parameters and
Return value.
Return Value
Refer to the section GetReference Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 141

GetReference Method (short, short, IMxReference)


Provides a method to access the reference attribute by its ID
and Primitive ID.
Syntax
public bool GetReference(
short attributeId,
short primitiveId,
out IMxReference value
);

Parameters
Refer to the section GetReference Method Parameters and
Return value.
Return Value
Refer to the section GetReference Method Parameters and
Return value.

GetReference Method (string, int, IMxReference)


Provides a method to access the reference array element by
its external name and index.
Syntax
public bool GetReference(
string fullName,
int index,
out IMxReference value
);

Parameters
Refer to the section GetReference Method Parameters and
Return value.
Return Value
Refer to the section GetReference Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


142 Chapter 1 Class Reference

GetReference Method (string, IMxReference,


CMxDataQuality)
Provides a method to access the reference attribute and
quality by its external name.
Syntax
public bool GetReference(
string fullName,
out IMxReference value,
out CMxDataQuality quality
);

Parameters
Refer to the section GetReference Method Parameters and
Return value.
Return Value
Refer to the section GetReference Method Parameters and
Return value.

GetReference Method (short, short, int,


IMxReference)
Provides a method to access the reference array element by
its ID, Primitive ID, and index.
Syntax
public bool GetReference(
short attributeId,
short primitiveId,
int index,
out IMxReference value
);

Parameters
Refer to the section GetReference Method Parameters and
Return value.
Return Value
Refer to the section GetReference Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 143

GetReference Method (short, short, IMxReference,


CMxDataQuality)
Provides a method to access the reference attribute and
quality by its ID and Primitive ID.
Syntax
public bool GetReference(
short attributeId,
short primitiveId,
out IMxReference value,
out CMxDataQuality quality
);

Parameters
Refer to the section GetReference Method Parameters and
Return value.
Return Value
Refer to the section GetReference Method Parameters and
Return value.

GetReference Method (string, IMxReference,


DateTime, CMxDataQuality)
Provides a method to access the reference attribute, its
quality and time by external name.
Syntax
public bool GetReference(
string fullName,
out IMxReference value,
out DateTime time,
out CMxDataQuality quality
);

Parameters
Refer to the section GetReference Method Parameters and
Return value.
Return Value
Refer to the section GetReference Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


144 Chapter 1 Class Reference

GetReference Method (short, short, IMxReference,


DateTime, CMxDataQuality)
Provides a method to access the reference attribute, its
quality and time by ID and Primitive ID.
Syntax
public bool GetReference(
short attributeId,
short primitiveId,
out IMxReference value,
out DateTime time,
out CMxDataQuality quality
);

Parameters
Refer to the section GetReference Method Parameters and
Return value.
Return Value
Refer to the section GetReference Method Parameters and
Return value.

GetReference Method Parameters and Return value


Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Value
The out parameter which contains the value of the
Reference attribute.
Index
The Reference attribute array index.
quality
The quality property of Reference attribute.
time
The out parameter contains the Date and Time associated
with the Reference attribute.
Return Value
bool
true: if the Reference attribute accessing is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 145

GetReferenceArrayQ Method (string,


CMxDataQuality)
Provides a method to get the quality of a Reference array
attribute by its external name.
Syntax
public bool GetReferenceArrayQ(
string fullName,
out CMxDataQuality quality
);

Parameters
fullName
External name of an attribute.
quality
The out parameter contains the quality property of
Reference attribute.
Return Value
bool
true: if the Reference attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

GetReferenceArrayQ Method (short, short,


CMxDataQuality)
Provides a method to get the quality of a Reference array
attribute by its ID and Primitive ID.
Syntax
public bool GetReferenceArrayQ(
short attributeId,
short primitiveId,
out CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The out parameter contains the quality property of
Reference attribute.

ArchestrA Object Toolkit Reference Guide


146 Chapter 1 Class Reference

Return Value
bool
true: if the Reference attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

GetScanTime Method
Provides a method to access to the current scan time.
Syntax
public DateTime GetScanTime();
Return Value
DateTime

GetScanTime Method (short)


Provides a method to access to the current scan time with
time zone offset.
Syntax
public DateTime GetScanTime(
out short offset
);

Parameter
offset
The time zone offset.
Return Value
DateTime

GetStatusDescription Method
Provides a method to get the string associated with an error
code.
Syntax
public string GetStatusDescription(
short shDetailedErrorCode
);

Parameter
shDetailedErrorCode
The error code.
Return Value
string
The string value corresponding to the error code.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 147

GetString Method (string, string)


Provides a method to get the value of string attribute by its
external name.
Syntax
public bool GetString(
string fullName,
out string value
);

Parameters
Refer to the section GetString Method Parameters and
Return value
Return Value
Refer to the section GetString Method Parameters and
Return value

GetString Method (short, short, string)


Provides a method to get the value of string attribute by its
ID and Primitive ID.
Syntax
public bool GetString(
short attributeId,
short primitiveId,
out string value
);

Parameters
Refer to the section GetString Method Parameters and
Return value
Return Value
Refer to the section GetString Method Parameters and
Return value

ArchestrA Object Toolkit Reference Guide


148 Chapter 1 Class Reference

GetString Method (string, int, string)


Provides a method to get the value of string array element by
its external name and index.
Syntax
public bool GetString(
string fullName,
int index,
out string value
);

Parameters
Refer to the section GetString Method Parameters and
Return value.
Return Value
Refer to the section GetString Method Parameters and
Return value.

GetString Method (string, string, CMxDataQuality)


Provides a method to get the value and quality of string
attribute by its external name.
Syntax
public bool GetString(
string fullName,
out string value,
out CMxDataQuality quality
);

Parameters
Refer to the section GetString Method Parameters and
Return value.
Return Value
Refer to the section GetString Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 149

GetString Method (short, short, int, string)


Provides a method to get the value of string array element by
its ID, Primitive ID, and index.
Syntax
public bool GetString(
short attributeId,
short primitiveId,
int index,
out string value
);

Parameters
Refer to the section GetString Method Parameters and
Return value.
Return Value
Refer to the section GetString Method Parameters and
Return value.

GetString Method (short, short, string,


CMxDataQuality)
Provides a method to get the value and quality of string
attribute by its ID and Primitive ID.
Syntax
public bool GetString(
short attributeId,
short primitiveId,
out string value,
out CMxDataQuality quality
);

Parameters
Refer to the section GetString Method Parameters and
Return value.
Return Value
Refer to the section GetString Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


150 Chapter 1 Class Reference

GetString Method (string, string, DateTime,


CMxDataQuality)
Provides a method to get the value, time, and quality of
string attribute by its external name.
Syntax
public bool GetString(
string fullName,
out string value,
out DateTime time,
out CMxDataQuality quality
);

Parameters
Refer to the section GetString Method Parameters and
Return value.
Return Value
Refer to the section GetString Method Parameters and
Return value.

GetString Method (short, short, string, DateTime,


CMxDataQuality)
Provides a method to get the value, time, and quality of
string attribute by its ID and Primitive ID.
Syntax
public bool GetString(
short attributeId,
short primitiveId,
out string value,
out DateTime time,
out CMxDataQuality quality
);

Parameters
Refer to the section GetString Method Parameters and
Return value
Return Value
Refer to the section GetString Method Parameters and
Return value

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 151

GetString Method Parameters and Return value


Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Value
The out parameter which contains the value of the string
attribute.
Index
The string array index.
quality
The quality property of string attribute.
time
The out parameter contains the Date and Time associated
with the string attribute.
Return Value
bool
true: if the string attribute accessing is successful.
false: if the user tries to access a non-existing attribute.

GetStringArrayQ Method (string, CMxDataQuality)


Provides a method to get the quality of a string array
attribute by its external name.
Syntax
public bool GetStringArrayQ(
string fullName,
out CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The out parameter contains the quality property of string
array attribute.

ArchestrA Object Toolkit Reference Guide


152 Chapter 1 Class Reference

Return Value
bool
true: if the string array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

GetStringArrayQ Method (short, short,


CMxDataQuality)
Provides a method to get the quality of a string array
attribute by its ID and Primitive ID.
Syntax
public bool GetStringArrayQ(
short attributeId,
short primitiveId,
out CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The out parameter contains the quality property of string
array attribute.
Return Value
bool
true: if the string array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

GetTime Method (string, DateTime)


Provides a method to get the value of a time attribute by its
external name.
Syntax
public bool GetTime(
string fullName,
out DateTime value
);
Parameters
Refer to the section GetTime Method Parameters and Return
value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 153

GetTime Method (short, short, DateTime)


Provides a method to get the value of a time attribute by its
id and primitive id.
Syntax
public bool GetTime(
short attributeId,
short primitiveId,
out DateTime value
);
Parameters
Refer to the section GetTime Method Parameters and Return
value.

GetTime Method (string, int, DateTime)


Provides a method to get the value of a time array element by
its external name and index.
Syntax
public bool GetTime(
string fullName,
int index,
out DateTime value
);
Parameters
Refer to the section GetTime Method Parameters and Return
value.

GetTime Method (string, DateTime, CMxDataQuality)


Provides a method to get the value and quality of a time
attribute by its external name.
Syntax
public bool GetTime(
string fullName,
out DateTime value,
out CMxDataQuality quality
);
Parameters
Refer to the section GetTime Method Parameters and Return
value.

ArchestrA Object Toolkit Reference Guide


154 Chapter 1 Class Reference

GetTime Method (short, short, int, DateTime)


Provides a method to get the value of a time array element by
its id, primitive id, and index.
Syntax
public bool GetTime(
short attributeId,
short primitiveId,
int index,
out DateTime value
);
Parameters
Refer to the section GetTime Method Parameters and Return
value.

GetTime Method (short, short, DateTime,


CMxDataQuality)
Provides a method to get the value and quality of a time
attribute by its id and primitive id.
Syntax
public bool GetTime(
short attributeId,
short primitiveId,
out DateTime value,
out CMxDataQuality quality
);
Parameters
Refer to the section GetTime Method Parameters and Return
value.

GetTime Method (string, DateTime, DateTime,


CMxDataQuality)
Provides a method to get the value, time, and quality of a
time attribute by its external name.
Syntax
public bool GetTime(
string fullName,
out DateTime value,
out DateTime time,
out CMxDataQuality quality
);

Parameters
Refer to the section GetTime Method Parameters and Return
value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 155

GetTime Method (short, short, DateTime, DateTime,


CMxDataQuality)
Provides a method to get the value, time, and quality of a
time attribute by its id and primitive id.
Syntax
public bool GetTime(
short attributeId,
short primitiveId,
out DateTime value,
out DateTime time,
out CMxDataQuality quality
);

Parameters
Refer to the section GetTime Method Parameters and Return
value.

GetTime Method Parameters and Return value


fullName
External name of the attribute.
attributeId
Attribute id.
primitiveId
Primitive id of an attribute.
Value
The out parameter which contains the value of a time
attribute.
Index
The DateTime array index.
quality
The out parameter contains the quality property of time
attribute.
time
The out parameter contains the Date and Time associated
with the time attribute.
Return Value
bool
true: if the time attribute accessing is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


156 Chapter 1 Class Reference

GetTimeArrayQ Method (string, CMxDataQuality)


Provides a method to get the quality of a Time array
attribute by its external name.
Syntax
public bool GetTimeArrayQ(
string fullName,
out CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The out parameter contains the quality property of the
Time array attribute.
Return Value
bool
true: if the Time array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

GetTimeArrayQ Method (short, short,


CMxDataQuality)
Provides a method to get the quality of a Time array
attribute by its ID and Primitive ID.
Syntax
public bool GetTimeArrayQ(
short attributeId,
short primitiveId,
out CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The out parameter contains the quality property of Time
array attribute.
Return Value
bool
true: if the Time array attribute quality accessing is
successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 157

GetTimeStamp Method (string, MxDataType,


DateTime)
Provides a method to get the time of an attribute by name.
Syntax
public bool GetTimeStamp(
string fullName,
MxDataType dataType,
out DateTime time
);

Parameters
fullName
External name of attribute.
dataType
Datatype of an attribute.
time
The out parameter contains the date and time of an
attribute.
Return Value
bool
true: if accessing the Date and Time of an attribute is
successful.
false: if the user tries to access a non-existing attribute.

GetTimeStamp Method (short, short, MxdataType,


DateTime)
Provides a method to get the time of an attribute by ID and
Primitive ID.
Syntax
public bool GetTimeStamp(
short attributeId,
short primitiveId,
MxDataType dataType,
out DateTime time
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
dataType
Datatype of an attribute.

ArchestrA Object Toolkit Reference Guide


158 Chapter 1 Class Reference

time
The out parameter contains the date and time of an
attribute.
Return Value
bool
true: if accessing the Date and Time of an attribute is
successful.
false: if the user tries to access a non-existing attribute.

GetType Method (string, MxDataType, int)


Provides a method to get the type of an attribute by name.
Syntax
public bool GetType(
string fullName,
out MxDataType dataType,
out int isArray
);

Parameters
fullName
External name of an attribute.
dataType
The out parameter contains the Datatype if an attribute.
isArray
The out parameter which specifies whether the attribute is
an array type.
1: if attribute is an array type.
0: if attribute is non-array type.
Return Value
bool
true: if the accessing of attribute type is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 159

GetType Method (short, short, MxDataType, int)


Provides a method to get the type of an attribute by ID and
Primitive ID.
Syntax
public bool GetType(
short attributeId,
short primitiveId,
out MxDataType dataType,
out int isArray
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
dataType
The out parameter contains the Datatype of an attribute.
isArray
The out parameter which specifies whether the attribute is
an array type.
1: if the attribute is an array type.
0: if the attribute is non-array type
Return Value
bool
true: if the accessing of attribute type is successful.
false: if the user tries to access a non-existing attribute.

Initialize Method
Provides a method to initialize the wrapper to a Primitive by
ID and IPrimitiveRuntimeSite.
Syntax
public void Initialize(
short primitiveId,
IPrimitiveRuntimeSite pSite
);

Parameters
primitiveId
Primitive ID.
pSite
Object of IPrimitiveRuntimeSite.

ArchestrA Object Toolkit Reference Guide


160 Chapter 1 Class Reference

ParentPrimitive Method
Provides a method to get the Parent Primitive ID of a
Primitive.
Syntax
public short ParentPrimitive(short _primID);
Parameter
_primId
Primitive ID.
Return Value
short

PutBoolean Method (string, bool)


Provides a method to set the value of Boolean attribute by
external name.
Syntax
public bool PutBoolean(
string fullName,
bool value
);

Parameters
Refer to the section PutBoolean Method Parameters and
Return value.
Return Value
Refer to the section PutBoolean Method Parameters and
Return value.

PutBoolean Method (short, short, bool)


Provides a method to set the value of Boolean attribute by ID
and Primitive ID.
Syntax
public bool PutBoolean(
short attributeId,
short primitiveId,
bool value
);

Parameters
Refer to the section PutBoolean Method Parameters and
Return value.
Return Value
Refer to the section PutBoolean Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 161

PutBoolean Method (string, bool, CMxDataQuality)


Provides a method to set the value and quality of Boolean
attribute by name.
Syntax
public bool PutBoolean(
string fullName,
bool value,
CMxDataQuality quality
);

Parameters
Refer to the section PutBoolean Method Parameters and
Return value.
Return Value
Refer to the section PutBoolean Method Parameters and
Return value.

PutBoolean Method (string, int, bool)


Provides a method to set the value of an element of a Boolean
array attribute by name.
Syntax
public bool PutBoolean(
string fullName,
int index,
bool value
);

Parameters
Refer to the section PutBoolean Method Parameters and
Return value.
Return Value
Refer to the section PutBoolean Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


162 Chapter 1 Class Reference

PutBoolean Method (short, short, bool,


CMxDataQuality)
Provides a method to set the value and quality of Boolean
attribute by ID and Primitive ID.
Syntax
public bool PutBoolean(
short attributeId,
short primitiveId,
bool value,
CMxDataQuality quality
);

Parameters
Refer to the section PutBoolean Method Parameters and
Return value.
Return Value
Refer to the section PutBoolean Method Parameters and
Return value.

PutBoolean Method (short, short, int, bool)


Provides a method to set the value of an element of a Boolean
array attribute by ID, Primitive ID and index.
Syntax
public bool PutBoolean(
short attributeId,
short primitiveId,
int index,
bool value
);

Parameters
Refer to the section PutBoolean Method Parameters and
Return value.
Return Value
Refer to the section PutBoolean Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 163

PutBoolean Method (string, bool, DateTime,


CMxDataQuality)
Provides a method to set the value, time, and quality of
Boolean attribute by name.
Syntax
public bool PutBoolean(
string fullName,
bool value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutBoolean Method Parameters and
Return value.
Return Value
Refer to the section PutBoolean Method Parameters and
Return value.

PutBoolean Method (short, short, bool, DateTime,


CMxDataQuality)
Provides a method to set the value, time, and quality of a
Boolean attribute by ID and Primitive ID.
Syntax
public bool PutBoolean(
short attributeId,
short primitiveId,
bool value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutBoolean Method Parameters and
Return value.
Return Value
Refer to the section PutBoolean Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


164 Chapter 1 Class Reference

PutBoolean Method Parameters and Return value


Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Value
The Boolean value.
Index
The Boolean array index.
quality
The quality property for Boolean attribute. The supported
quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
time
The Date and Time for a Boolean attribute.
Return Value
bool
true: if the Boolean attribute setting is successful.
false: if the user tries to access a non-existing attribute.

PutBooleanArrayQ Method (string, CMxDataQuality)


Provides a method to set the quality of a Boolean array
attribute by its external name.
Syntax
public bool PutBooleanArrayQ(
string fullName,
CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 165

quality
The quality property for Boolean array attribute. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the Boolean array element quality setting is
successful.
false: if the user tries to access a non-existing attribute.

PutBooleanArrayQ Method (short, short,


CMxDataQuality)
Provides a method to set the quality of a Boolean array
element by its ID and Primitive ID.
Syntax
public bool PutBooleanArrayQ(
short attributeId,
short primitiveId,
CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The quality property for Boolean array element. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown

ArchestrA Object Toolkit Reference Guide


166 Chapter 1 Class Reference

Return Value
bool
true: if the Boolean array element quality setting is
successful.
false: if the user tries to access a non-existing attribute.

PutCustomEnum Method (string, short)


Provides a method to set the ordinal value of CustomEnum
attribute by name.
Syntax
public bool PutCustomEnum(
string fullName,
short value
);

Parameters
Refer to the section PutCustomEnum Method Parameters
and Return value
Return Value
Refer to the section PutCustomEnum Method Parameters
and Return value

PutCustomEnum Method (short, short, short)


Provides a method to set the ordinal value of CustomEnum
attribute by ID and Primitive ID.
Syntax
public bool PutCustomEnum(
short attributeId,
short primitiveId,
short value
);

Parameters
Refer to the section PutCustomEnum Method Parameters
and Return value
Return Value
Refer to the section PutCustomEnum Method Parameters
and Return value

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 167

PutCustomEnum Method (string, int, short)


Provides a method to set the ordinal value of a CustomEnum
array element by name.
Syntax
public bool PutCustomEnum(
string fullName,
int index,
short value
);

Parameters
Refer to the section PutCustomEnum Method Parameters
and Return value
Return Value
Refer to the section PutCustomEnum Method Parameters
and Return value

PutCustomEnum Method (string, short,


CMxDataQuality)
Provides a method to set the ordinal value and quality of
CustomEnum attribute by name.
Syntax
public bool PutCustomEnum(
string fullName,
short value,
CMxDataQuality quality
);

Parameters
Refer to the section PutCustomEnum Method Parameters
and Return value
Return Value
Refer to the section PutCustomEnum Method Parameters
and Return value

ArchestrA Object Toolkit Reference Guide


168 Chapter 1 Class Reference

PutCustomEnum Method (short, short, int, short)


Provides a method to set the ordinal value of CustomEnum
array element by ID and Primitive ID.
Syntax
public bool PutCustomEnum(
short attributeId,
short primitiveId,
int index,
short value
);

Parameters
Refer to the section PutCustomEnum Method Parameters
and Return value
Return Value
Refer to the section PutCustomEnum Method Parameters
and Return value

PutCustomEnum Method (short, short, short,


CMxDataQuality)
Provides a method to set the ordinal value and quality of
CustomEnum attribute by ID and Primitive ID.
Syntax
public bool PutCustomEnum(
short attributeId,
short primitiveId,
short value,
CMxDataQuality quality
);

Parameters
Refer to the section PutCustomEnum Method Parameters
and Return value
Return Value
Refer to the section PutCustomEnum Method Parameters
and Return value

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 169

PutCustomEnum Method (string, short, DateTime,


CMxDataQuality)
Provides a method to set the ordinal value, time, and quality
of CustomEnum attribute by name.
Syntax
public bool PutCustomEnum(
string fullName,
short value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutCustomEnum Method Parameters
and Return value
Return Value
Refer to the section PutCustomEnum Method Parameters
and Return value

PutCustomEnum Method (short, short, short,


DateTime, CMxDataQuality)
Provides a method to set the ordinal value, time, and quality
of CustomEnum attribute by ID and Primitive ID.
Syntax
public bool PutCustomEnum(
short attributeId,
short primitiveId,
short value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutCustomEnum Method Parameters
and Return value.
Return Value
Refer to the section PutCustomEnum Method Parameters
and Return value.

ArchestrA Object Toolkit Reference Guide


170 Chapter 1 Class Reference

PutCustomEnum Method Parameters and Return


value
Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Value
The ordinal value of CustomEnum attribute.
Index
The CustomEnum array index.
quality
The quality property for CustomEnum attribute.The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
time
The Date and Time for a CustomEnum attribute.
Return Value
bool
true: if the CustomEnum attribute setting is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 171

PutCustomEnumArrayQ Method (string,


CMxDataQuality)
Provides a method to set the quality of a CustomEnum array
element by its external name.
Syntax
public bool PutCustomEnumArrayQ(
string fullName,
CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The quality property for CustomEnum array element . The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
true: if the CustomEnum array element quality setting is
successful.
false: if the user tries to access a non-existing attribute.

PutCustomEnumArrayQ Method (short, short,


CMxDataQuality)
Provides a method to set the quality of a CustomEnum array
element by its ID and Primitive ID.
Syntax
public bool PutCustomEnumArrayQ(
short attributeId,
short primitiveId,
CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.

ArchestrA Object Toolkit Reference Guide


172 Chapter 1 Class Reference

quality
The quality property for CustomEnum array element . The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the CustomEnum array element quality setting is
successful.
false: if the user tries to access a non-existing attribute.

PutCustomStruct Method (string, MxCustomStruct)


Provides a method to set the value of a CustomStruct
attribute by its external name.
Syntax
public bool PutCustomStruct(
string fullName,
MxCustomStruct value
);

Parameters
Refer to the section PutCustomStruct Method Parameters
and Return value
Return Value
Refer to the section PutCustomStruct Method Parameters
and Return value

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 173

PutCustomStruct Method (short, short,


MxCustomStruct)
Provide a method to set the value of a CustomStruct
attribute by its id and primitive id.
Syntax
public bool PutCustomStruct(
short attributeId,
short primitiveId,
MxCustomStruct value
);

Parameters
Refer to the section PutCustomStruct Method Parameters
and Return value
Return Value
Refer to the section PutCustomStruct Method Parameters
and Return value

PutCustomStruct Method (string, int,


MxCustomStruct)
Provides a method to set the value of an element of a
CustomStruct array attribute by its external name and
index.
Syntax
public bool PutCustomStruct(
string fullName,
int index,
MxCustomStruct value
);

Parameters
Refer to the section PutCustomStruct Method Parameters
and Return value
Return Value
Refer to the section PutCustomStruct Method Parameters
and Return value

ArchestrA Object Toolkit Reference Guide


174 Chapter 1 Class Reference

PutCustomStruct Method (string, MxCustomStruct,


CMxDataQuality)
Provides a method to set the value and quality of a
CustomStruct attribute by its external name.
Syntax
public bool PutCustomStruct(
string fullName,
MxCustomStruct value,
CMxDataQuality quality
);

Parameters
Refer to the section PutCustomStruct Method Parameters
and Return value
Return Value
Refer to the section PutCustomStruct Method Parameters
and Return value

PutCustomStruct Method (short, short, int,


MxCustomStruct)
Provides a method to set the value of an element of a
CustomStruct array attribute by its id, primitive id, and
index.
Syntax
public bool PutCustomStruct(
short attributeId,
short primitiveId,
int index,
MxCustomStruct value
);

Parameters
Refer to the section PutCustomStruct Method Parameters
and Return value
Return Value
Refer to the section PutCustomStruct Method Parameters
and Return value

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 175

PutCustomStruct Method (short, short,


MxCustomStruct, CMxDataQuality)
Provides a method to set the value and quality of a
CustomStruct attribute by its id and primitive id.
Syntax
public bool PutCustomStruct(
short attributeId,
short primitiveId,
MxCustomStruct value,
CMxDataQuality quality
);

Parameters
Refer to the section PutCustomStruct Method Parameters
and Return value
Return Value
Refer to the section PutCustomStruct Method Parameters
and Return value

PutCustomStruct Method (string, MxCustomStruct,


DateTime, CMxDataQuality)
Provides a method to set the value, time, and quality of a
CustomStruct attribute by its external name.
Syntax
public bool PutCustomStruct(
string fullName,
MxCustomStruct value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutCustomStruct Method Parameters
and Return value
Return Value
Refer to the section PutCustomStruct Method Parameters
and Return value

ArchestrA Object Toolkit Reference Guide


176 Chapter 1 Class Reference

PutCustomStruct Method (short, short,


MxCustomStruct, DateTime, CMxDataQuality)
Provides a method to set the value, time, and quality of a
CustomStruct attribute by its id and primitive id.
Syntax
public bool PutCustomStruct(
short attributeId,
short primitiveId,
MxCustomStruct value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutCustomStruct Method Parameters
and Return value.
Return Value
Refer to the section PutCustomStruct Method Parameters
and Return value.

PutCustomStruct Method Parameters and Return


value
Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
guid
The guid of customstruct.
length
The length of the byte array.
Value
The byte array.
Index
The CustomStruct array index.
quality
The quality property for CustomStruct attribute.
time
The Date and Time for a CustomStruct attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 177

Return Value
bool
true: if the CustomStruct attribute setting is successful.
false: if the user tries to access a non-existing attribute.

PutCustomStructArrayQ Method (string,


CMxDataQuality)
Provides a method to set the quality of a CustomStruct array
element by its external name.
Syntax
public bool PutCustomStructArrayQ(
string fullName,
CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The quality property for CustomStruct array element. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the CustomStruct array element quality setting is
successful.
false: if the user tries to access a non-existing attribute.

PutCustomStructArrayQ Method (short, short,


CMxDataQuality)
Provides a method to set the quality of a CustomStruct array
element by its ID and Primitive ID.
Syntax
public bool PutCustomStructArrayQ(
short attributeId,
short primitiveId,
CMxDataQuality quality
);

ArchestrA Object Toolkit Reference Guide


178 Chapter 1 Class Reference

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The quality property for CustomStruct attribute. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the CustomStruct array element quality setting is
successful.
false: if the user tries to access a non-existing attribute.

PutDouble Method (string, double)


Provides a method to set the value of a double attribute by
name.
Syntax
public bool PutDouble(
string fullName,
double value
);

Parameters
Refer to the section PutDouble Method Parameters and
Return value
Return Value
Refer to the section PutDouble Method Parameters and
Return value

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 179

PutDouble Method (short, short, double)


Provides a method to set the value of a double attribute by ID
and Primitive ID.
Syntax
public bool PutDouble(
short attributeId,
short primitiveId,
double value
);

Parameters
Refer to the section PutDouble Method Parameters and
Return value
Return Value
Refer to the section PutDouble Method Parameters and
Return value

PutDouble Method (string, double, CMxDataQuality)


Provides a method to set the value and quality of a double
attribute by name.
Syntax
public bool PutDouble(
string fullName,
double value,
CMxDataQuality quality
);

Parameters
Refer to the section PutDouble Method Parameters and
Return value
Return Value
Refer to the section PutDouble Method Parameters and
Return value

ArchestrA Object Toolkit Reference Guide


180 Chapter 1 Class Reference

PutDouble Method (string, int, double)


Provides a method to set the value of a double array element
by name.
Syntax
public bool PutDouble(
string fullName,
int index,
double value
);

Parameters
Refer to the section PutDouble Method Parameters and
Return value
Return Value
Refer to the section PutDouble Method Parameters and
Return value

PutDouble Method (short, short, double,


CMxDataQuality)
Provides a method to set the value and quality of a double
attribute by ID and Primitive ID.
Syntax
public bool PutDouble(
short attributeId,
short primitiveId,
double value,
CMxDataQuality quality
);

Parameters
Refer to the section PutDouble Method Parameters and
Return value
Return Value
Refer to the section PutDouble Method Parameters and
Return value

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 181

PutDouble Method (short, short, int, double)


Provides a method to set the value of an element of a double
array attribute by ID and Primitive ID.
Syntax
public bool PutDouble(
short attributeId,
short primitiveId,
int index,
double value
);

Parameters
Refer to the section PutDouble Method Parameters and
Return value
Return Value
Refer to the section PutDouble Method Parameters and
Return value

PutDouble Method (string, double, DateTime,


CMxDataQuality)
Provides a method to set the value, time, and quality of a
double attribute by name.
Syntax
public bool PutDouble(
string fullName,
double value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutDouble Method Parameters and
Return value
Return Value
Refer to the section PutDouble Method Parameters and
Return value

ArchestrA Object Toolkit Reference Guide


182 Chapter 1 Class Reference

PutDouble Method (short, short, double, DateTime,


CMxDataQuality)
Provides a method to set the value, time, and quality of a
double attribute by ID and Primitive ID.
Syntax
public bool PutDouble(
short attributeId,
short primitiveId,
double value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutDouble Method Parameters and
Return value.
Return Value
Refer to the section PutDouble Method Parameters and
Return value.

PutDouble Method Parameters and Return value


Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Value
The Double value.
Index
The Double array index.
quality
The quality property for Double attribute. The supported
quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
time
The Date and Time for a Double attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 183

Return Value
bool
true: if the Double attribute setting is successful.
false: if the user tries to access a non-existing attribute.

PutDoubleArrayQ Method (string, CMxDataQuality)


Provides a method to set the quality of a double array
element by its external name.
Syntax
public bool PutDoubleArrayQ(
string fullName,
CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The quality property for double attribute. The supported
quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the double array element quality setting is
successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


184 Chapter 1 Class Reference

PutDoubleArrayQ Method (short, short,


CMxDataQuality)
Provides a method to set the quality of a double array
element by its ID and Primitive ID.
Syntax
public bool PutDoubleArrayQ(
short attributeId,
short primitiveId,
CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The quality property for double array element. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the double array element quality setting is
successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 185

PutElapsedTime Method (string, TimeSpan)


Provides a method to set the value of an ElapsedTime
attribute by its external name.
Syntax
public bool PutElapsedTime(
string fullName,
TimeSpan value
);

Parameters
Refer to the section PutElapsedTime Method Parameters
and Return value
Return Value
Refer to the section PutElapsedTime Method Parameters
and Return value

PutElapsedTime Method (short, short, TimeSpan)


Provides a method to set the value of an ElapsedTime
attribute by its ID and Primitive ID.
Syntax
public bool PutElapsedTime(
short attributeId,
short primitiveId,
TimeSpan value
);

Parameters
Refer to the section PutElapsedTime Method Parameters
and Return value
Return Value
Refer to the section PutElapsedTime Method Parameters
and Return value

ArchestrA Object Toolkit Reference Guide


186 Chapter 1 Class Reference

PutElapsedTime Method (string, int, TimeSpan)


Provides a method to set the value of an element of an
ElapsedTime array attribute by its name.
Syntax
public bool PutElapsedTime(
string fullName,
int index,
TimeSpan value
);

Parameters
Refer to the section PutElapsedTime Method Parameters
and Return value
Return Value
Refer to the section PutElapsedTime Method Parameters
and Return value

PutElapsedTime Method (string, TimeSpan,


CMxDataQuality)
Provides a method to set the value and quality of an
ElapsedTime attribute by its name.
Syntax
public bool PutElapsedTime(
string fullName,
TimeSpan value,
CMxDataQuality quality
);

Parameters
Refer to the section PutElapsedTime Method Parameters
and Return value
Return Value
Refer to the section PutElapsedTime Method Parameters
and Return value

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 187

PutElapsedTime Method (short, short, int,


TimeSpan)
Provides a method to set the value of an element of an
ElapsedTime array attribute by its ID and Primitive ID.
Syntax
public bool PutElapsedTime(
short attributeId,
short primitiveId,
int index,
TimeSpan value
);

Parameters
Refer to the section PutElapsedTime Method Parameters
and Return value
Return Value
Refer to the section PutElapsedTime Method Parameters
and Return value

PutElapsedTime Method (short, short, TimeSpan,


CMxDataQuality)
Provides a method to set the value and quality of an
ElapsedTime attribute by its ID and Primitive ID.
Syntax
public bool PutElapsedTime(
short attributeId,
short primitiveId,
TimeSpan value,
CMxDataQuality quality
);

Parameters
Refer to the section PutElapsedTime Method Parameters
and Return value
Return Value
Refer to the section PutElapsedTime Method Parameters
and Return value

ArchestrA Object Toolkit Reference Guide


188 Chapter 1 Class Reference

PutElapsedTime Method (string, TimeSpan,


DateTime, CMxDataQuality)
Provides a method to set the value, time, and quality of an
ElapsedTime attribute by its name.
Syntax
public bool PutElapsedTime(
string fullName,
TimeSpan value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutElapsedTime Method Parameters
and Return value
Return Value
Refer to the section PutElapsedTime Method Parameters
and Return value

PutElapsedTime Method (short, short, TimeSpan,


DateTime, CMxDataQuality)
Provides a method to set the value, time, and quality of an
ElapsedTime attribute by its ID and Primitive ID.
Syntax
public bool PutElapsedTime(
short attributeId,
short primitiveId,
TimeSpan value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutElapsedTime Method Parameters
and Return value.
Return Value
Refer to the section PutElapsedTime Method Parameters
and Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 189

PutElapsedTime Method Parameters and Return


value
Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Value
The ElapsedTime value.
Index
The ElapsedTime array index.
quality
The quality property for ElapsedTime attribute.
time
The Date and Time for a ElapsedTime attribute.
Return Value
bool
true: if the ElapsedTime attribute setting is successful.
false: if the user tries to access a non-existing attribute.

PutElapsedTimeArrayQ Method (string,


CMxDataQuality)
Provides a method to set the quality of a ElapsedTime array
element by its external name.
Syntax
public bool PutElapsedTimeArrayQ(
string fullName,
CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.

ArchestrA Object Toolkit Reference Guide


190 Chapter 1 Class Reference

quality
The quality property for ElapsedTime array element. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the ElapsedTime array element quality setting is
successful.
false: if the user tries to access a non-existing attribute.

PutElapsedTimeArrayQ Method (short, short,


CMxDataQuality)
Provides a method to set the quality of an ElapsedTime array
element by its ID and Primitive ID.
Syntax
public bool PutElapsedTimeArrayQ(
short attributeId,
short primitiveId,
CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The quality property for ElapsedTime array element. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 191

Return Value
bool
true: if the ElapsedTime array element quality setting is
successful.
false: if the user tries to access a non-existing attribute.

PutFloat Method (string, float)


Provides a method to set the value of a float attribute by its
external name.
Syntax
public bool PutFloat(
string fullName,
float value
);

Parameters
Refer to the section PutFloat Method Parameters and Return
value
Return Value
Refer to the section PutFloat Method Parameters and Return
value

PutFloat Method (short, short, float)


Provides a method to set the value of a float attribute by its
ID and Primitive ID.
Syntax
public bool PutFloat(
short attributeId,
short primitiveId,
float value
);

Parameters
Refer to the section PutFloat Method Parameters and Return
value
Return Value
Refer to the section PutFloat Method Parameters and Return
value

ArchestrA Object Toolkit Reference Guide


192 Chapter 1 Class Reference

PutFloat Method (string, float, CMxDataQuality)


Provides a method to set the value and quality of a float
attribute by its name.
Syntax
public bool PutFloat(
string fullName,
float value,
CMxDataQuality quality
);

Parameters
Refer to the section PutFloat Method Parameters and Return
value
Return Value
Refer to the section PutFloat Method Parameters and Return
value

PutFloat Method (string, int, float)


Provides a method to set the value of an element of a float
array attribute by its name.
Syntax
public bool PutFloat(
string fullName,
int index,
float value
);

Parameters
Refer to the section PutFloat Method Parameters and Return
value
Return Value
Refer to the section PutFloat Method Parameters and Return
value

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 193

PutFloat Method (short, short, float,


CMxDataQuality)
Provides a method to set the value and quality of a float
attribute by its ID and Primitive ID.
Syntax
public bool PutFloat(
short attributeId,
short primitiveId,
float value,
CMxDataQuality quality
);

Parameters
Refer to the section PutFloat Method Parameters and Return
value
Return Value
Refer to the section PutFloat Method Parameters and Return
value

PutFloat Method (short, short, int, float)


Provides a method to set the value of an element of a float
array attribute by its ID and Primitive ID.
Syntax
public bool PutFloat(
short attributeId,
short primitiveId,
int index,
float value
);

Parameters
Refer to the section PutFloat Method Parameters and Return
value
Return Value
Refer to the section PutFloat Method Parameters and Return
value

ArchestrA Object Toolkit Reference Guide


194 Chapter 1 Class Reference

PutFloat Method (string, float, DateTime,


CMxDataQuality)
Provides a method to set the value, time, and quality of a
float attribute by its name.
Syntax
public bool PutFloat(
string fullName,
float value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutFloat Method Parameters and Return
value
Return Value
Refer to the section PutFloat Method Parameters and Return
value

PutFloat Method (short, short, float, DateTime,


CMxDataQuality)
Provides a method to set the value, time, and quality of a
float attribute by its ID and Primitive ID.
Syntax
public bool PutFloat(
short attributeId,
short primitiveId,
float value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutFloat Method Parameters and Return
value.
Return Value
Refer to the section PutFloat Method Parameters and Return
value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 195

PutFloat Method Parameters and Return value


Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Value
The Float value.
Index
The Float array index.
quality
The quality property for Float attribute. The supported
quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
time
The Date and Time for a Float attribute.
Return Value
bool
true: if the Float attribute setting is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


196 Chapter 1 Class Reference

PutFloatArrayQ Method (string, CMxDataQuality)


Provides a method to set the quality of a Float array element
by its external name.
Syntax
public bool PutFloatArrayQ(
string fullName,
CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The quality property for Float array element. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the Float array element quality setting is successful.
false: if the user tries to access a non-existing attribute.

PutFloatArrayQ Method (short, short,


CMxDataQuality)
Provides a method to set the quality of a Float array element
by its external ID and Primitive ID.
Syntax
public bool PutFloatArrayQ(
short attributeId,
short primitiveId,
CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 197

quality
The quality property for Float array element. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the Float array element quality setting is successful.
false: if the user tries to access a non-existing attribute.

PutInteger Method (string, int)


Provides a method to set the value of an Integer attribute by
its external name.
Syntax
public bool PutInteger(
string fullName,
int value
);

Parameters
Refer to the section PutInteger Method Parameters and
Return value
Return Value
Refer to the section PutInteger Method Parameters and
Return value

PutInteger Method (short, short, int)


Provides a method to set the value of an Integer attribute by
its ID and Primitive ID.
Syntax
public bool PutInteger(
short attributeId,
short primitiveId,
int value
);

Parameters
Refer to the section PutInteger Method Parameters and
Return value
Return Value
Refer to the section PutInteger Method Parameters and
Return value

ArchestrA Object Toolkit Reference Guide


198 Chapter 1 Class Reference

PutInteger Method (string, int, CMxDataQuality)


Provides a method to set the value and quality of an Integer
attribute by name.
Syntax
public bool PutInteger(
string fullName,
int value,
CMxDataQuality quality
);

Parameters
Refer to the section PutInteger Method Parameters and
Return value
Return Value
Refer to the section PutInteger Method Parameters and
Return value

PutInteger Method (string, int, int)


Provides a method to set the value of an element of an
Integer array attribute by name.
Syntax
public bool PutInteger(
string fullName,
int index,
int value
);

Parameters
Refer to the section PutInteger Method Parameters and
Return value
Return Value
Refer to the section PutInteger Method Parameters and
Return value

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 199

PutInteger Method (short, short, int,


CMxDataQuality)
Provides a method to set the value and quality of an Integer
attribute by ID and Primitive ID.
Syntax
public bool PutInteger(
short attributeId,
short primitiveId,
int value,
CMxDataQuality quality
);

Parameters
Refer to the section PutInteger Method Parameters and
Return value
Return Value
Refer to the section PutInteger Method Parameters and
Return value

PutInteger Method (short, short, int, int)


Provides a method to set the value of an element of an
Integer array attribute by ID and Primitive ID.
Syntax
public bool PutInteger(
short attributeId,
short primitiveId,
int index,
int value
);

Parameters
Refer to the section PutInteger Method Parameters and
Return value
Return Value
Refer to the section PutInteger Method Parameters and
Return value

ArchestrA Object Toolkit Reference Guide


200 Chapter 1 Class Reference

PutInteger Method (string, int, DateTime,


CMxDataQuality)
Provides a method to set the value, time, and quality of an
Integer attribute by name.
Syntax
public bool PutInteger(
string fullName,
int value,
DateTime time,
CMxDataQuality quality
);
Parameters
Refer to the section PutInteger Method Parameters and
Return value
Return Value
Refer to the section PutInteger Method Parameters and
Return value

PutInteger Method (short, short, int, DateTime,


CMxDataQuality)
Provides a method to set the value, time, and quality of an
Integer attribute by ID and Primitive ID.
Syntax
public bool PutInteger(
short attributeId,
short primitiveId,
int value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutInteger Method Parameters and
Return value.
Return Value
Refer to the section PutInteger Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 201

PutInteger Method Parameters and Return value


Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Value
The Integer value.
Index
The Integer array index.
quality
The quality property for an Integer attribute. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
time
The Date and Time for an Integer attribute.
Return Value
bool
true: if the Integer attribute setting is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


202 Chapter 1 Class Reference

PutIntegerArrayQ Method (string, CMxDataQuality)


Provides a method to set the quality of an Integer array
attribute by its external name.
Syntax
public bool PutIntegerArrayQ(
string fullName,
CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The quality property for an Integer array attribute. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the Integer array attribute quality setting is
successful.
false: if the user tries to access a non-existing attribute.

PutIntegerArrayQ Method (short, short,


CMxDataQuality)
Provides a method to set the quality of an Integer array
attribute by its ID and Primitive ID.
Syntax
public bool PutIntegerArrayQ(
short attributeId,
short primitiveId,
CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 203

quality
The quality property for an Integer array attribute. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the Integer array attribute quality setting is
successful.
false: if the user tries to access a non-existing attribute.

PutMxDataType Method (string, MxDataType)


Provides a method to set the value of a MxDataType
attribute by its external name.
Syntax
public bool PutMxDataType(
string fullName,
MxDataType value
);

Parameters
Refer to the section PutMxDataType Method Parameters and
Return value.
Return Value
Refer to the section PutMxDataType Method Parameters and
Return value

ArchestrA Object Toolkit Reference Guide


204 Chapter 1 Class Reference

PutMxDataType Method (short, short, MxDataType)


Provides a method to set the value of a MxDataType
attribute by its ID and Primitive ID.
Syntax
public bool PutMxDataType(
short attributeId,
short primitiveId,
MxDataType value
);

Parameters
Refer to the section PutMxDataType Method Parameters and
Return value.
Return Value
Refer to the section PutMxDataType Method Parameters and
Return value.

PutMxDataType Method (string, int, MxDataType)


Provides a method to set the value of an element of an
MxDataType array attribute by name.
Syntax
public bool PutMxDataType(
string fullName,
int index,
MxDataType value
);

Parameters
Refer to the section PutMxDataType Method Parameters and
Return value.
Return Value
Refer to the section PutMxDataType Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 205

PutMxDataType Method (string, MxDataType,


CMxDataQuality)
Provides a method to set the value and quality of a
MxDataType attribute by name.
Syntax
public bool PutMxDataType(
string fullName,
MxDataType value,
CMxDataQuality quality
);

Parameters
Refer to the section PutMxDataType Method Parameters and
Return value.
Return Value
Refer to the section PutMxDataType Method Parameters and
Return value.

PutMxDataType Method (short, short, int,


MxDataType)
Provides a method to set the value of an element of an
MxDataType array attribute by ID and Primitive ID.
Syntax
public bool PutMxDataType(
short attributeId,
short primitiveId,
int index,
MxDataType value
);

Parameters
Refer to the section PutMxDataType Method Parameters and
Return value.
Return Value
Refer to the section PutMxDataType Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


206 Chapter 1 Class Reference

PutMxDataType Method (short, short, MxDataType,


CMxDataQuality)
Provides a method to set the value and quality of a
MxDataType attribute by ID and Primitive ID.
Syntax
public bool PutMxDataType(
short attributeId,
short primitiveId,
MxDataType value,
CMxDataQuality quality
);

Parameters
Refer to the section PutMxDataType Method Parameters and
Return value.
Return Value
Refer to the section PutMxDataType Method Parameters and
Return value.

PutMxDataType Method (string, MxDataType,


DateTime, CMxDataQuality)
Provides a method to set the value, time, and quality of a
MxDataType attribute by name.
Syntax
public bool PutMxDataType(
string fullName,
MxDataType value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutMxDataType Method Parameters and
Return value.
Return Value
Refer to the section PutMxDataType Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 207

PutMxDataType Method (short, short, MxDataType,


DateTime, CMxDataQuality)
Provides a method to set the value, time, and quality of a
MxDataType attribute by ID and Primitive ID.
Syntax
public bool PutMxDataType(
short attributeId,
short primitiveId,
MxDataType value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutMxDataType Method Parameters and
Return value.
Return Value
Refer to the section PutMxDataType Method Parameters and
Return value.

PutMxDataType Method Parameters and Return value


Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Value
The MxDataType value. The supported MxDataType values
are:
MxBigString, MxBoolean, MxDataQualityType,
MxDataTypeEND, MxDataTypeEnum,
MxDataTypeUnknown, MxDouble, MxElapsedTime,
MxFloat, MxInteger, MxInternationalizedString,
MxNoData, MxQualifiedEnum, MxQualifiedStruct,
MxReferenceType, MxSecurityClassificationEnum,
MxStatusType, MxString, and MxTime.
Index
The MxDataType array index.

ArchestrA Object Toolkit Reference Guide


208 Chapter 1 Class Reference

quality
The quality property for MxDataType attribute. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
time
The Date and Time for MxDataType attribute.
Return Value
bool
true: if the MxDataType attribute setting is successful.
false: if the user tries to access a non-existing attribute.

PutMxDataTypeArrayQ Method (string,


CMxDataQuality)
Provides a method to set the quality of a MxDataType array
attribute by its external name.
Syntax
public bool PutMxDataTypeArrayQ(
string fullName,
CMxDataQuality quality
);

Parameters
fullName
External name of the attribute.
quality
The quality property for MxDataType array attribute. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the MxDataType array attribute quality setting is
successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 209

PutMxDataTypeArrayQ Method (short, short,


CMxDataQuality)
Provides a method to set the quality of a MxDataType array
attribute by its ID and Primitive ID.
Syntax
public bool PutMxDataTypeArrayQ(
short attributeId,
short primitiveId,
CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The quality property for MxDataType array attribute. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the MxDataType array attribute quality setting is
successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


210 Chapter 1 Class Reference

PutMxStatus Method (string, MxStatus)


Provides a method to set the value of a MxStatus attribute by
its external name.
Syntax
public bool PutMxStatus(
string fullName,
MxStatus value
);

Parameters
Refer to the section PutMxStatus Method Parameters and
Return value
Return Value
Refer to the section PutMxStatus Method Parameters and
Return value

PutMxStatus Method (short, short, MxStatus)


Provides a method to set the value of a MxStatus attribute by
its ID and Primitive ID.
Syntax
public bool PutMxStatus(
short attributeId,
short primitiveId,
MxStatus value
);

Parameters
Refer to the section PutMxStatus Method Parameters and
Return value.
Return Value
Refer to the section PutMxStatus Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 211

PutMxStatus Method (string, int, MxStatus)


Provides a method to set the value of an element of an
MxStatus array attribute by name.
Syntax
public bool PutMxStatus(
string fullName,
int index,
MxStatus value
);

Parameters
Refer to the section PutMxStatus Method Parameters and
Return value.
Return Value
Refer to the section PutMxStatus Method Parameters and
Return value

PutMxStatus Method (string, MxStatus,


CMxDataQuality)
Provides a method to set the value and quality of a MxStatus
attribute by name.
Syntax
public bool PutMxStatus(
string fullName,
MxStatus value,
CMxDataQuality quality
);

Parameters
Refer to the section PutMxStatus Method Parameters and
Return value.
Return Value
Refer to the section PutMxStatus Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


212 Chapter 1 Class Reference

PutMxStatus Method (short, short, int, MxStatus)


Provides a method to set the value of an element of an
MxStatus array attribute by ID and Primitive ID.
Syntax
public bool PutMxStatus(
short attributeId,
short primitiveId,
int index,
MxStatus value
);

Parameters
Refer to the section PutMxStatus Method Parameters and
Return value.
Return Value
Refer to the section PutMxStatus Method Parameters and
Return value.

PutMxStatus Method (short, short, MxStatus,


CMxDataQuality)
Provides a method to set the value and quality of a MxStatus
attribute by ID and Primitive ID.
Syntax
public bool PutMxStatus(
short attributeId,
short primitiveId,
MxStatus value,
CMxDataQuality quality
);

Parameters
Refer to the section PutMxStatus Method Parameters and
Return value.
Return Value
Refer to the section PutMxStatus Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 213

PutMxStatus Method (string, MxStatus, DateTime,


CMxDataQuality)
Provides a method to set the value, time, and quality of a
MxStatus attribute by name.
Syntax
public bool PutMxStatus(
string fullName,
MxStatus value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutMxStatus Method Parameters and
Return value.
Return Value
Refer to the section PutMxStatus Method Parameters and
Return value.

PutMxStatus Method (short, short, MxStatus,


DateTime, CMxDataQuality)
Provides a method to set the value, time, and quality of a
MxStatus attribute by ID and Primitive ID.
Syntax
public bool PutMxStatus(
short attributeId,
short primitiveId,
MxStatus value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutMxStatus Method Parameters and
Return value.
Return Value
Refer to the section PutMxStatus Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


214 Chapter 1 Class Reference

PutMxStatus Method Parameters and Return value


Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Value
The MxStatus value. The MxStatus value can set as shown
below:
MxStatus sval = new MxStatus();
sval.success = -1;
sval.Category = MxStatusCategory.MxCategoryOk;
sval.detail = 1;
sval.detectedBy =
MxStatusSource.MxSourceRequestingAutomationObject;
PutMxStatus("StatusAttr", sval);
Index
The MxStatus array index.
quality
The quality property for MxStatus attribute. The supported
quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
time
The Date and Time for MxStatus attribute.
Return Value
bool
true: if the MxStatus attribute setting is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 215

PutMxStatusArrayQ Method (string, CMxDataQuality)


Provides a method to set the quality of a MxDataType array
attribute by its external name.
Syntax
public bool PutMxStatusArrayQ(
string fullName,
CMxDataQuality quality
);

Parameters
fullName
External name of attribute.
quality
The quality property for MxStatus array attribute. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if MxStatus array attribute quality setting is
successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


216 Chapter 1 Class Reference

PutMxStatusArrayQ Method (short, short,


CMxDataQuality)
Provides a method to set the quality of a MxDataType array
attribute by ID and Primitive ID.
Syntax
public bool PutMxStatusArrayQ(
short attributeId,
short primitiveId,
CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The quality property for MxStatus array attribute. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if MxStatus array attribute quality setting is
successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 217

PutQuality Method (string, MxDataType,


CMxDataQuality)
Provides a method to set the quality of an attribute by its
name.
Syntax
public bool PutQuality(
string fullName,
MxDataType dataType,
CMxDataQuality quality
);

Parameters
Refer to the section PutQuality Method Parameters and
Return value.
Return Value
Refer to the section PutQuality Method Parameters and
Return value.

PutQuality Method (short, short, MxDataType,


CMxDataQuality)
Provides a method to set the quality of an attribute by its ID
and Primitive ID.
Syntax
public bool PutQuality(
short attributeId,
short primitiveId,
MxDataType dataType,
CMxDataQuality quality
);

Parameters
Refer to the section PutQuality Method Parameters and
Return value.
Return Value
Refer to the section PutQuality Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


218 Chapter 1 Class Reference

PutQuality Method Parameters and Return value


Parameters
fullName
External name of an attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
dataType
The Datatype of an attribute. The supported datatypes are:
MxBoolean
MxInteger
MxFloat
MxDouble
MxString
MxTime
MxElapsedTime
MxReferenceType
MxStatusType
MxDataTypeEnum
MxQualifiedEnum
MxQualifiedStruct
quality
The quality property of an attribute. The supported quality
types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the attribute quality setting is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 219

PutReference Method (string, IMxReference)


Provides a method to set the value of reference attribute by
its external name.
Syntax
public bool PutReference(
string fullName,
IMxReference value
);

Parameters
Refer to the section PutReference Method Parameters and
Return value.
Return Value
Refer to the section PutReference Method Parameters and
Return value.

PutReference Method (short, short, IMxReference)


Provides a method to set the value of reference attribute by
its ID and Primitive ID.
Syntax
public bool PutReference(
short attributeId,
short primitiveId,
IMxReference value
);

Parameters
Refer to the section PutReference Method Parameters and
Return value.
Return Value
Refer to the section PutReference Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


220 Chapter 1 Class Reference

PutReference Method (string, IMxReference,


CMxDataQuality)
Provides a method to set the value and quality of reference
attribute by name.
Syntax
public bool PutReference(
string fullName,
IMxReference value,
CMxDataQuality quality
);

Parameters
Refer to the section PutReference Method Parameters and
Return value
Return Value
Refer to the section PutReference Method Parameters and
Return value

PutReference Method (string, int, IMxReference)


Provides a method to set the value of an element of a
reference array attribute by name.
Syntax
public bool PutReference(
string fullName,
int index,
IMxReference value
);

Parameters
Refer to the section PutReference Method Parameters and
Return value.
Return Value
Refer to the section PutReference Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 221

PutReference Method (short, short, IMxReference,


CMXDataQuality)
Provides a method to set the value and quality of reference
attribute by ID and Primitive ID.
Syntax
public bool PutReference(
short attributeId,
short primitiveId,
IMxReference value,
CMxDataQuality quality
);

Parameters
Refer to the section PutReference Method Parameters and
Return value.
Return Value
Refer to the section PutReference Method Parameters and
Return value.

PutReference Method (short, short, int,


IMxReference)
Provides a method to set the value of an element of a
reference array attribute by ID and Primitive ID.
Syntax
public bool PutReference(
short attributeId,
short primitiveId,
int index,
IMxReference value
);
Parameters
Refer to the section PutReference Method Parameters and
Return value.
Return Value
Refer to the section PutReference Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


222 Chapter 1 Class Reference

PutReference Method (string, IMxReference,


DateTime, CMxDataQuality)
Provides a method to set the value, time, and quality of
reference attribute by name.
Syntax
public bool PutReference(
string fullName,
IMxReference value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutReference Method Parameters and
Return value.
Return Value
Refer to the section PutReference Method Parameters and
Return value.

PutReference Method (short, short, IMxReference,


DateTime, CMxDataQuality)
Provides a method to set the value, time, and quality of
reference attribute by ID and Primitive ID.
Syntax
public bool PutReference(
short attributeId,
short primitiveId,
IMxReference value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutReference Method Parameters and
Return value.
Return Value
Refer to the section PutReference Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 223

PutReference Method Parameters and Return value


Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Value
The Reference attribute value. The value can be set by
IMxReference:
IMxReference val;
val.FullReferenceString = "Sample String";
PutReference("ReferenceAttr", val);
Index
The Reference array index.
quality
The quality property for Reference attribute. The supported
quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
time
The Date and Time for a Reference attribute.
Return Value
bool
true: if the Reference attribute setting is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


224 Chapter 1 Class Reference

PutReferenceArrayQ Method (string,


CMxDataQuality)
Provides a method to set the quality of a Reference array
attribute by its external name.
Syntax
public bool PutReferenceArrayQ(
string fullName,
CMxDataQuality quality
);

Parameters
fullName
External name of attribute.
quality
The quality property for Reference array attribute. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if Reference array attribute quality setting is
successful.
false: if the user tries to access a non-existing attribute.

PutReferenceArrayQ Method (short, short,


CMxDataQuality)
Provides a method to set the quality of a Reference array
attribute by its ID and Primitive ID.
Syntax
public bool PutReferenceArrayQ(
short attributeId,
short primitiveId,
CMxDataQuality quality
);

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 225

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The quality property for Reference array attribute. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if Reference array attribute quality setting is
successful.
false: if the user tries to access a non-existing attribute.

PutString Method (string, string)


Provides a method to set the value of a string attribute by its
external name.
Syntax
public bool PutString(
string fullName,
string value
);

Parameters
Refer to the section PutString Method Parameters and
Return value.
Return Value
Refer to the section PutString Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


226 Chapter 1 Class Reference

PutString Method (short, short, string)


Provides a method to set the value of a string attribute by its
ID and Primitive ID.
Syntax
public bool PutString(
short attributeId,
short primitiveId,
string value
);

Parameters
Refer to the section PutString Method Parameters and
Return value.
Return Value
Refer to the section PutString Method Parameters and
Return value.

PutString Method (string, int, string)


Provides a method to set the value of an element of a string
array attribute by name.
Syntax
public bool PutString(
string fullName,
int index,
string value
);

Parameters
Refer to the section PutString Method Parameters and
Return value.
Return Value
Refer to the section PutString Method Parameters and
Return value.

PutString Method (string, string, CMxDataQuality)


Provides a method to set the value and quality of a string
attribute by name.
Syntax
public bool PutString(
string fullName,
string value,
CMxDataQuality quality
);

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 227

Parameters
Refer to the section PutString Method Parameters and
Return value.
Return Value
Refer to the section PutString Method Parameters and
Return value.

PutString Method (short, short, int, string)


Provides a method to set the value of an element of a string
array attribute by ID and Primitive ID.
Syntax
public bool PutString(
short attributeId,
short primitiveId,
int index,
string value
);

Parameters
Refer to the section PutString Method Parameters and
Return value.
Return Value
Refer to the section PutString Method Parameters and
Return value.

PutString Method (short, short, string,


CMxDataQuality)
Provides a method to set the value and quality of a string
attribute by ID and Primitive ID.
Syntax
public bool PutString(
short attributeId,
short primitiveId,
string value,
CMxDataQuality quality
);

Parameters
Refer to the section PutString Method Parameters and
Return value.
Return Value
Refer to the section PutString Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


228 Chapter 1 Class Reference

PutString Method (string, string, DateTime,


CMxDataQuality)
Provides a method to set the value, time, and quality of a
string attribute by name.
Syntax
public bool PutString(
string fullName,
string value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutString Method Parameters and
Return value.
Return Value
Refer to the section PutString Method Parameters and
Return value.

PutString Method (short, short, string, DateTime,


CMxDataQuality)
Provides a method to set the value, time, and quality of a
string attribute by ID and Primitive ID.
Syntax
public bool PutString(
short attributeId,
short primitiveId,
string value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutString Method Parameters and
Return value.
Return Value
Refer to the section PutString Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 229

PutString Method Parameters and Return value


Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Value
The string value.
Index
The string array index.
quality
The quality property for string attribute. The supported
quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
time
The Date and Time for a string attribute.
Return Value
bool
true: if the string attribute setting is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


230 Chapter 1 Class Reference

PutStringArrayQ Method (string, CMxDataQuality)


Provides a method to set the quality of a string array
attribute by its external name.
Syntax
public bool PutStringArrayQ(
string fullName,
CMxDataQuality quality
);

Parameters
fullName
External name of attribute.
quality
The quality property for string array attribute. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the string array attribute quality setting is
successful.
false: if the user tries to access a non-existing attribute.

PutStringArrayQ Method (short, short,


CMxDataQuality)
Provides a method to set the quality of a string array
attribute by its ID and Primitive ID.
Syntax
public bool PutStringArrayQ(
short attributeId,
short primitiveId,
CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 231

quality
The quality property for string array attribute. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the string array attribute quality setting is
successful.
false: if the user tries to access a non-existing attribute.

PutTime Method (string, VBFILETIME)


Provides a method to set the value of a time attribute by its
external name.
Syntax
public bool PutTime(
string fullName,
ref VBFILETIME value
);

Parameters
Refer to the section PutTime Method Parameters and Return
value.
Return Value
Refer to the section PutTime Method Parameters and Return
value.

ArchestrA Object Toolkit Reference Guide


232 Chapter 1 Class Reference

PutTime Method (short, short, VBFILETIME)


Provides a method to set the value of a time attribute by its
ID and Primitive ID.
Syntax
public bool PutTime(
short attributeId,
short primitiveId,
ref VBFILETIME value
);

Parameters
Refer to the section PutTime Method Parameters and Return
value.
Return Value
Refer to the section PutTime Method Parameters and Return
value.

PutTime Method (string, int, VBFILETIME)


Provides a method to set the value of an element of a time
array attribute by name.
Syntax
public bool PutTime(
string fullName,
int index,
ref VBFILETIME value
);

Parameters
Refer to the section PutTime Method Parameters and Return
value.
Return Value
Refer to the section PutTime Method Parameters and Return
value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 233

PutTime Method (string, VBFILETIME,


CMxDataQuality)
Provides a method to set the value and quality of a time
attribute by name.
Syntax
public bool PutTime(
string fullName,
ref VBFILETIME value,
CMxDataQuality quality
);

Parameters
Refer to the section PutTime Method Parameters and Return
value.
Return Value
Refer to the section PutTime Method Parameters and Return
value.

PutTime Method (short, short, int, VBFILETIME)


Provides a method to set the value of an element of a time
array attribute by ID and Primitive ID.
Syntax
public bool PutTime(
short attributeId,
short primitiveId,
int index,
ref VBFILETIME value
);

Parameters
Refer to the section PutTime Method Parameters and Return
value
Return Value
Refer to the section PutTime Method Parameters and Return
value

ArchestrA Object Toolkit Reference Guide


234 Chapter 1 Class Reference

PutTime Method (short, short, VBFILETIME,


CMxDataQuality)
Provides a method to set the value and quality of a time
attribute by ID and Primitive ID.
Syntax
public bool PutTime(
short attributeId,
short primitiveId,
ref VBFILETIME value,
CMxDataQuality quality
);

Parameters
Refer to the section PutTime Method Parameters and Return
value
Return Value
Refer to the section PutTime Method Parameters and Return
value

PutTime Method (string, VBFILETIME, DateTime,


CMxDataQuality)
Provides a method to set the value, time, and quality of a
time attribute by name.
Syntax
public bool PutTime(
string fullName,
ref VBFILETIME value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutTime Method Parameters and Return
value
Return Value
Refer to the section PutTime Method Parameters and Return
value

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 235

PutTime Method (short, short, VBFILETIME,


DateTime, CMxDataQuality)
Provides a method to set the value, time, and quality of a
time attribute by ID and Primitive ID.
Syntax
public bool PutTime(
short attributeId,
short primitiveId,
ref VBFILETIME value,
DateTime time,
CMxDataQuality quality
);

Parameters
Refer to the section PutTime Method Parameters and Return
value.
Return Value
Refer to the section PutTime Method Parameters and Return
value.

PutTime Method Parameters and Return value


Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
Value
The Time attribute value. The Time value can be set as
shown below:
VBFILETIME val =
CMxValue.DateTimeToVBFT(DateTime.Now);
PutTime("TimeAttr", ref val);
Index
The Time array index.

ArchestrA Object Toolkit Reference Guide


236 Chapter 1 Class Reference

quality
The quality property for Time attribute. The supported
quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
time
The Date and Time for a Time attribute.
Return Value
bool
true: if the Time attribute setting is successful.
false: if the user tries to access a non-existing attribute.

PutTimeArrayQ Method (string, CMxDataQuality)


Provides a method to set the quality of a Time array attribute
by its external name.
Syntax
public bool PutTimeArrayQ(
string fullName,
CMxDataQuality quality
);

Parameters
fullName
External name of attribute.
quality
The quality property for Time array attribute. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the Time array attribute quality setting is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 237

PutTimeArrayQ Method (short, short,


CMxDataQuality)
Provides a method to set the quality of a Time array attribute
by its ID and Primitive ID.
Syntax
public bool PutTimeArrayQ(
short attributeId,
short primitiveId,
CMxDataQuality quality
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The quality property for Time array attribute. The
supported quality types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown
Return Value
bool
true: if the Time array attribute quality setting is successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


238 Chapter 1 Class Reference

PutTimeStamp Method (string, MxDataType,


DateTime)
Provides a method to set the time of an attribute by name.
Syntax
public bool PutTimeStamp(
string fullName,
MxDataType dataType,
DateTime time
);

Parameters
Refer to the section PutTimeStamp Method Parameters and
Return value
Return Value
Refer to the section PutTimeStamp Method Parameters and
Return value

PutTimeStamp Method (short, short, MxDataType,


DateTime)
Provides a method to set the time of an attribute by ID and
Primitive ID.
Syntax
public bool PutTimeStamp(
short attributeId,
short primitiveId,
MxDataType dataType,
DateTime time
);

Parameters
Refer to the section PutTimeStamp Method Parameters and
Return value.
Return Value
Refer to the section PutTimeStamp Method Parameters and
Return value.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 239

PutTimeStamp Method Parameters and Return value


Parameters
fullName
External name of an attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
dataType
The Datatype of an attribute. The supported datatype are:
MxBoolean
MxInteger
MxFloat
MxDouble
MxString
MxTime
MxElapsedTime
MxReferenceType
MxStatusType
MxDataTypeEnum
MxQualifiedEnum
MxQualifiedStruct
time
The time property of an attribute.
Return Value
bool
true: if the attribute time setting is successful.
false: if the user tries to access a non-existing attribute.

RecreateDynamicAttributes Method
Provides a method to recreate dynamic attributes supported
by failover.
Syntax
public void RecreateDynamicAttributes();

ArchestrA Object Toolkit Reference Guide


240 Chapter 1 Class Reference

RestoreDynamicAttributes Method
Provides a method to recreate dynamic attributes supported
by failover and set their value if the object is starting up from
standby. Use this method to restore the dynamic attribute’s
values if the startup context is Checkpoint or Failover.
Syntax
public void RestoreDynamicAttributes();

SendEvent Method
Provides a method to cause an Attributes Set Handler to
execute using the Attributes External Name (report a data
change).
Syntax
public bool SendEvent(
string name,
string oldValue,
string newValue,
string description
);

Parameters
name
External name of an attribute.
oldValue
Old value of an attribute.
newValue
New value of an attribute.
description
The custom string specifies the description of change.
Return Value
bool

SetDataToFailoverField Method
Provides a method to set a C# object to the failover attribute.
Syntax
public void SetDataToFailoverField(object data);
Parameter
data
The data object.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 241

SetHandler Method
Provides a method to perform custom execution logic based
upon a change of data for a particular attribute.
Syntax
public void SetHandler(
ref AttributeHandle pAttributeHandle,
ref SetInfo pInfo,
IMxValue pMxValue,
ref MxStatus pMxStatus
);

Parameters
pAttributeHandle
Specifies which property of which attribute is attempting to
be set.
pInfo
Specifies additional information regarding this set
attribute.
pMxValue
Specifies the value of the property to be set.
pMxStatus
Specifies the return status of the set.

SetNumElementsEx Method (string, int)


Provides a method to set the number of elements of an array
attribute by name.
Syntax
public bool SetNumElementsEx(
string fullName,
int numElements
);

Parameters
fullName
Name of an array attribute.
numElements
The number of elements of an array attribute.
Return Value
bool
true: if the array attribute number of elements setting is
successful.
false: if the user tries to access a non-existing attribute.

ArchestrA Object Toolkit Reference Guide


242 Chapter 1 Class Reference

SetNumElementsEx Method (short, short, int)


Provides a method to set the number of elements of an array
attribute by ID and Primitive ID.
Syntax
public bool SetNumElementsEx(
short attributeId,
short primitiveId,
int numElements
);

Parameters
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
numElements
The number of elements of an array attribute.
Return Value
bool
true: if the array attribute number of elements setting is
successful.
false: if the user tries to access a non-existing attribute.

SetQ Method (string, CMxDataQuality)


Provides a method to set the quality of an attribute by name.
Syntax
public void SetQ(
string fullName,
CMxDataQuality quality
);

Parameters
Refer to the section SetQ Method Parameters and Return
value

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 243

SetQ Method (short, short, CMxDataQuality)


Provides a method to set the quality of an attribute by ID and
Primitive ID.
Syntax
public void SetQ(
short attributeId,
short primitiveId,
CMxDataQuality quality
);

Parameters
Refer to the section SetQ Method Parameters and Return
value.

SetQ Method Parameters and Return value


Parameters
fullName
External name of the attribute.
attributeId
Attribute ID.
primitiveId
Primitive ID of an attribute.
quality
The quality property of an attribute. The supported quality
types are:
DataQualityBad
DataQualityGood
DataQualityInitializing
DataQualityUncertain
DataQualityUnknown

SetScanState Method
Provides a wrapper to fire the SetScanState event.
Syntax
public void SetScanState(bool bOnScan);
Parameter
bOnScan
true: OnScan state.
false: OffScan state.

ArchestrA Object Toolkit Reference Guide


244 Chapter 1 Class Reference

StandbyStartup Method
Provide indication if object is starting up from standby.
Syntax
public bool StandbyStartup();
Return Value
bool

SuspendLocalAttribute Method (string)


Provides a method to suspend an attribute. This function is
called by auto-generated toolkit code and is typically not to
be used by the Object Developer.
Syntax
public bool SuspendLocalAttribute(
string attributeName
);

Parameter
attributeName
External name of an attribute.
Return Value
bool

SuspendLocalAttribute Method (short, string)


Provides a method to activate an attribute. This function is
called by auto-generated toolkit code and is not to be used by
the Object Developer.
Syntax
public bool SuspendLocalAttribute(
short attributeId,
string attributeName
);

Parameters
attributeId
Attribute ID.
attributeName
External name of an attribute.
Return Value
bool

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 245

SuspendPrimitiveAttribute Method (string)


Provides a method to suspend an attribute of a child
primitive, reusable primitive, or an utility primitive.
Syntax
public bool SuspendPrimitiveAttribute(
string fullAttributeName
);

Parameter
fullAttributeName
The name of the primitive attribute. The name
fullAttributeName format should be
"PrimitiveName.AttributeName".
Return Value
bool

SuspendPrimitiveAttribute Method (short, short)


Provides a method to activate an attribute of a child
primitive, reusable primitive, or utility primitive.
Syntax
public bool SuspendPrimitiveAttribute(
short attributeId,
short primitiveId
);

Parameters
attributeId
The primitive's attribute ID.
primitiveId
Primitive ID.
Return Value
bool

UpdateDynamicAttributeData Method
Provides a method to update each dynamic attribute
registered for failover with its current name, type, category,
security, and set handler flag.
Syntax
public void UpdateDynamicAttributeData();

ArchestrA Object Toolkit Reference Guide


246 Chapter 1 Class Reference

InputOutputPrimitive Class
This class provides a wrapper for the InputOutput Primitive.
Syntax
public class InputOutputPrimitive :
RuntimeBase.PrimitiveWrapper
Remarks
The InputOutputPrimitive is derived from
RuntimeBase.PrimitiveWrapper and it contains the
properties, attributes, and methods associated with the
InputOutput Primitives.

InputOutputPrimitive Properties
The following are the properties of the InputOutputPrimitive
class.
• DataType Property

• ReadQuality Property

• ReadStatus Property

• ReadTime Property

• ReadValue Property

• Reference Property

• ReferenceSecondary Property

• WriteStatus Property

• WriteTime Property

• WriteValue Property

DataType Property
Provides access to the DataType attribute.
Syntax
public MxDataType DataType {get;}
Return Value
MxDataType

ReadQuality Property
Provides access to the Quality of the Read Value attribute.
Syntax
public CMxDataQuality ReadQuality {get;}
Return Value
CMxDataQuality

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 247

ReadStatus Property
Provides access to the Read Status attribute.
Syntax
public MxStatus ReadStatus {get;}
Return Value
MxStatus

ReadTime Property
Provides access to the Time of the Read Value attribute.
Syntax
public DateTime ReadTime{get;}
Return Value
DateTime

ReadValue Property
Provides access to the Value of the Read Value attribute.
Syntax
public CMxValue ReadValue{get;}
Return Value
CMxValue

Reference Property
Provides access to set/get the Reference as a reference string.
Identifies the target attribute to which the value is to be
written.
Syntax
public string Reference{get; set;}
Return Value
string

ReferenceSecondary Property
Provides access to set/get the Secondary Reference as a
reference string. ReferenceSecondary identifies the source
attribute from which the value and quality are to be read.
Syntax
public string ReferenceSecondary{get; set;}
Return Value
string

ArchestrA Object Toolkit Reference Guide


248 Chapter 1 Class Reference

WriteStatus Property
Provides access to the Write Status attribute.
Syntax
public MxStatus WriteStatus{get;}
Return Value
MxStatus

WriteTime Property
Provides access to get/set the Time of the Write Value
attribute.
Syntax
public DateTime WriteTime{get; set;}
Return Value
DateTime

WriteValue Property
Provides access to get/set the Value of the Write Value
attribute.
Syntax
public CMxValue WriteValue{get; set;}
Return Value
CMxValue

InputOutputPrimitive Constructor
The following is the constructor of the InputOutputPrimitive
class.
• InputOutputPrimitive Constructor

InputOutputPrimitive Constructor
Syntax
public InputOutputPrimitive(RuntimeBase
_parentPrimitive);
Parameter
_parentPrimitive
Instance of RuntimeBase.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 249

InputOutputPrimitive Methods
The following are the methods of the InputOutputPrimitive
class.
• ActivateUpdatesList Method

• Initialize Method (short)

• Initialize Method (string)

• SuspendUpdatesList Method

ActivateUpdatesList Method
Provides a method to activate updates of data from the
remote attributes that are referenced by the
InputOutputPrimitive. It activates the attribute configured
in the secondary reference.
Syntax
public void ActivateUpdatesList();

Initialize Method (short)


Provides a method to initialize the wrapper to a primitive by
ID.
Syntax
public override void Initialize(short _primitiveID);
Parameter
_primitiveID
Primitive ID of an InputOutput Primitive instance.

Initialize Method (string)


Provides a method to initialize the wrapper to a primitive by
internal name.
Syntax
public void Initialize(string _primitiveInternalName);
Parameter
_primitiveInternalName
Primitive internal name of an IO Primitive instance.

SuspendUpdatesList Method
Provides a method to suspend updates of data from the
remote attributes that are referenced by the
InputOutputPrimitive. It deactivates the attribute
configured in the secondary reference.
Syntax
public void SuspendUpdatesList();

ArchestrA Object Toolkit Reference Guide


250 Chapter 1 Class Reference

InputPrimitive Class
This class provides a wrapper for Input Primitive.
Syntax
public class InputPrimitive :
RuntimeBase.PrimitiveWrapper
Remarks
The InputPrimitive is derived from
RuntimeBase.PrimitiveWrapper and it contains the
properties, attributes, and methods associated with the
InputPrimitives.

InputPrimitive Properties
The following are the properties of the InputPrimitive class.
• DataType Property

• InputSource Property

• Quality Property

• ReadStatus Property

• Time Property

• Value Property

DataType Property
Provides access to the DataType.
Syntax
public MxDataType DataType{get;}
Return Value
MxDataType

InputSource Property
Provides access to set/get the Input Source as a reference
string.
Syntax
public string InputSource{get; set;}
Return Value
string

Quality Property
Provides access to the Quality of the Value attribute.
Syntax
public CMxDataQuality Quality{get;}
Return Value
CMxDataQuality

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 251

ReadStatus Property
Provides access to the ReadStatus attribute.
Syntax
public MxStatus ReadStatus{get;}
Return Value
MxStatus

Time Property
Provides access to the Time of the Value attribute.
Syntax
public DateTime Time{get;}
Return Value
DateTime

Value Property
Provides access to the Value of the Value attribute.
Syntax
public CMxValue Value{get;}
Return Value
CMxValue

InputPrimitive Constructor
The following is the constructor of the InputPrimitive class.
• InputPrimitive Constructor

InputPrimitive Constructor
Syntax
public InputPrimitive(RuntimeBase _parentPrimitive);
Parameter
_parentPrimitive
Instance of RuntimeBase.

InputPrimitive Methods
The following are the methods of the InputPrimitive class.
• ActivateUpdatesList Method

• Initialize Method (short)

• Initialize Method (string)

• SuspendUpdatesList Method

ArchestrA Object Toolkit Reference Guide


252 Chapter 1 Class Reference

ActivateUpdatesList Method
Provides a method to activate updates of data from the
remote attribute that is referenced by the InputPrimitive.
Syntax
public void ActivateUpdatesList( );

Initialize Method (short)


Provides a method to initialize the wrapper to a primitive by
ID.
Syntax
public override void Initialize(short _primitiveID);
Parameter
_primitiveID
The Primitive ID of an InputPrimitive instance.

Initialize Method (string)


Provides a method to initialize the wrapper to a primitive by
internal name.
Syntax
public void Initialize(string _primitiveInternalName);
Parameter
_primitiveInternalName
Primitive internal name of an Input Primitive instance.

SuspendUpdatesList Method
Provides a method to suspend updates of data from the
remote attribute that is referenced by the InputPrimitive.
Syntax
public void SuspendUpdatesList( );

OutputPrimitive Class
This class provides a wrapper for Output Primitive.
Syntax
public class OutputPrimitive :
RuntimeBase.PrimitiveWrapper
Remarks
The OutputPrimitive is derived from
RuntimeBase.PrimitiveWrapper and it contains the
properties, attributes, and methods associated with the
OutputPrimitives.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 253

OutputPrimitive Properties
The following are the properties of the OutputPrimitive
class.
• DataType Property

• OutputDest Property

• Time Property

• Value Property

• WriteStatus Property

DataType Property
Provides access to the DataType attribute.
Syntax
public MxDataType DataType { get; }
Return Value
MxDataType

OutputDest Property
Provides access to set/get the Output Destination as a
reference string.
Syntax
public string OutputDest { get; set; }
Return Value
string

Time Property
Provides access to get/set the Time of the Value attribute.
Syntax
public DateTime Time { get; set; }
Return Value
DateTime

Value Property
Provides access get/set the value of the Value attribute.
Syntax
public CMxValue Value { get; set; }
Return Value
CMxValue

ArchestrA Object Toolkit Reference Guide


254 Chapter 1 Class Reference

WriteStatus Property
Provides access to the WriteStatus attribute.
Syntax
public MxStatus WriteStatus { get; }
Return Value
MxStatus

OutputPrimitive Constructor
The following is the constructor of the OutputPrimitive class.
• OutputPrimitive Constructor

OutputPrimitive Constructor
Syntax
public OutputPrimitive(RuntimeBase _parentPrimitive);
Parameter
_parentPrimitive
Instance of RuntimeBase.

OutputPrimitive Methods
The following are the methods of the OutputPrimitive class.
• Initialize Method (short)

• Initialize Method (string)

Initialize Method (short)


Provides a method to initialize the wrapper to a primitive by
ID.
Syntax
public override void Initialize(short _primitiveID);
Parameter
_primitiveID
The Primitive ID of an Output Primitive instance.

Initialize Method (string)


Provides a method to initialize the wrapper to a primitive by
internal name.
Syntax
public void Initialize(string _primitiveInternalName);
Parameter
_primitiveInternalName
Primitive internal name of an Output Primitive instance.

ArchestrA Object Toolkit Reference Guide


RuntimeBase Class 255

PrimitiveWrapper Class
This class is the base class of all IO Wrappers.
Syntax
public class PrimitiveWrapper

PrimitiveWrapper Property
Following is the property of the PrimitiveWrapper class.
• IsGood Property

IsGood Property
Provides indication that the wrapper has been initialized
successfully.
Syntax
public bool IsGood { get; }
Return Value
bool

PrimitiveWrapper Constructor
Following is the constructor of the PrimitiveWrapper class.
• PrimitiveWrapper Constructor

PrimitiveWrapper Constructor
Syntax
public PrimitiveWrapper(RuntimeBase _parentPrimitive);
Parameter
_parentPrimitive
Instance of RuntimeBase.

PrimitiveWrapper Methods
Following are the methods of the PrimitiveWrapper class.
• Initialize Method (short)

• Initialize Method (string)

Initialize Method (short)


Provides a method to initialize the wrapper to a primitive by
ID.
Syntax
public virtual void Initialize(short _primtiveId);
Parameter
_primtiveId
The PrimitiveID of an IO Primitive instance.

ArchestrA Object Toolkit Reference Guide


256 Chapter 1 Class Reference

Initialize Method (string)


Provides a method to initialize the wrapper to a primitive by
internal name.
Syntax
public void Initialize(string _primitiveInternalName);
Parameter
_primitiveInternalName
The internal name of an IO primitive instance.

aaBaseEditorForm Class
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
public class aaBaseEditorForm : UserControl,
IaaEditorForm, IaaEditorFormInternal, IaaControl

aaBaseEditorForm Methods
The following are the methods of the aaBaseEditorForm
class.
• GetData Method (string)

• GetData Method (string, string)

• GetLocalizedText Method (string, string)

• SetData Method (string, object)

• SetData Method (string, string, object)

ArchestrA Object Toolkit Reference Guide


aaBaseEditorForm Class 257

GetData Method (string)


Provides a method to access attribute value from the Editor
project.
Syntax
public object GetData(string sAttribute);
Parameter
sAttribute
Attribute external name.
Return Value
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
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.
Return Value
User should typecast the return value to the corresponding
datatype. Returns null if the attribute is not found.

ArchestrA Object Toolkit Reference Guide


258 Chapter 1 Class Reference

GetLocalizedText Method (string, string)


Provides a method to get a string from the dictionary.
Syntax
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.
Return Value
object

SetData Method (string, object)


Provides a method to set the value of an Attribute by name.
Syntax
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
public void SetData(string sAttribute, string
sProperty, object sVal);

ArchestrA Object Toolkit Reference Guide


Event Arguments 259

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.

Event Arguments
This section describes the Event Handlers for the Configtime
and RuntimeBase class.

SetHandlerEventArgs Class
SetHandlerEventArgs is an inherited class that provides
properties that are common to all SetHandlers.
Syntax
public class SetHandlerEventArgs : EventArgs

SetHandlerEventArgs Property
The following is the property of the SetHandlerEventArgs
class.
• IsArrayElement Property

IsArrayElement Property
This property returns true if the attribute is an array.
Otherwise, returns false if the attribute is a non-array.
Syntax
public bool IsArrayElement { get; }
Return Value
bool

ArchestrA Object Toolkit Reference Guide


260 Chapter 1 Class Reference

SetHandlerEventArgs Constructor
The following is the constructor of the SetHandlerEventArgs
class.
• SetHandlerEventArgs Constructor AttributeHandle, IMxValue

SetHandlerEventArgs Constructor AttributeHandle, IMxValue


This constructor is used internally by the Toolkit. The object
developer is not expected to typically use this constructor.
Syntax
SetHandlerEventArgs(AttributeHandle _attribute,
IMxValue _value)
Parameters
_ attribute
[in] The attribute handle of the attribute being set.
_ value
[in] The value being set.

SetHandlerEventArgs Members
The following are the members of the SetHandlerEventArgs
class.
• attributeHandle Member
• Value Member

attributeHandle Member
The attribute handle of the attribute being set.
Syntax
AttributeHandle attributeHandle

Value Member
The value being set.
Syntax
CMxValue Value

ArchestrA Object Toolkit Reference Guide


Event Arguments 261

ConfigtimeSetHandlerEventArgs Class
ConfigtimeSetHandlerEventArgs is a class that provides
configtime set handlers with the information they need when
called.
Syntax
public class ConfigtimeSetHandlerEventArgs :
SetHandlerEventArgs

ConfigtimeSetHandlerEventArgs Constructor
The following is the constructor of the
ConfigtimeSetHandlerEventArgs class.
• ConfigtimeSetHandlerEventArgs Constructor AttributeHandle,
IMxValue

ConfigtimeSetHandlerEventArgs Constructor
AttributeHandle, IMxValue
This constructor is used internally by the Toolkit. The object
developer is not expected to typically use this constructor.
Syntax
ConfigtimeSetHandlerEventArgs(AttributeHandle
_attribute, IMxValue _value)
Parameters
_ attribute
[in] The attribute handle of the attribute being set.
_value
[in] The value being set.

ConfigtimeSetHandlerEventArgs Member
The following is the member of the
ConfigtimeSetHandlerEventArgs class.
• Message Member

Message Member
A string that the user can set to write a message back to the
set handler caller when an error or warning is needed. The
message must be empty for the set handler to be successful.
Syntax
string Message

ArchestrA Object Toolkit Reference Guide


262 Chapter 1 Class Reference

MigrateHandler Class
The migrate handler contains the information on the current
migrate event.
Syntax
public class MigrateHandler

MigrateHandler Properties
The following are the properties of the MigrateHandler class.
• OriginalPrimitiveFullName Property
• OriginalPrimitiveId Property
• PreviousSite Property

OriginalPrimitiveFullName Property
Provides a property that Gets the full name of the current
primitive being migrated from. When Get is called on a
primitive, the full name must be prepended with a period to
fully reference the attribute.
Syntax
public string OriginalPrimitiveFullName { get; }
Return Value
string
Remarks
When migrating attributes within a reusable primitive, the
code in the configtime_migrate method must use the full
primitive name to access the attribute in the original object
being migrated. The property OriginalPrimitiveFullName
within the MigrateHandler class is available for this purpose
so that it can be prepended in front of the attribute name.
For example, in the Reusable Primitive configtime_migrate
method use:
migrate.GetValue(migrate.OriginalPrimitiveFullName +
".Attribute1")

OriginalPrimitiveId Property
The primitive id of the primitive that is being migrated.
Syntax
public short OriginalPrimitiveId { get; }
Return Value
short

ArchestrA Object Toolkit Reference Guide


Event Arguments 263

PreviousSite Property
A handle to the configtime site of the object that is being
migrated.
Syntax
public IPrimitivePackageSite PreviousSite { get; }
Return Value
IPrimitivePackageSite

MigrateHandler Constructor
The following are the constructor of the MigrateHandler
class.
• MigrateHandler Constructor IPrimitivePackageSite, short

MigrateHandler Constructor IPrimitivePackageSite, short


This constructor is used internally by the Toolkit. The object
developer is not expected to typically use this constructor.
Syntax
MigrateHandler(IPrimitivePackageSite _oldSite, short
_originalPrimitiveId);
Parameters
_oldSite
[in] The configtime site of the previous version of the object.
_originalPrimitiveId
[in] The primitive id of the primitive being migrated from.

MigrateHandler Methods
The following are the methods of the MigrateHandler class.
• Get Method
• GetLocked Method
• GetSecurity Method
• GetValue Method
• MajorVersion Method

ArchestrA Object Toolkit Reference Guide


264 Chapter 1 Class Reference

Get Method
Gets the value of an attribute property in the previous
version of the object.
Syntax
public CMxValue Get(string attribute,
EATTRIBUTEPROPERTY property);
Parameters
attribute
[in] the name of the attribute (must include the full name of
the primitive if it is not the topmost primitive.)
property
[in] the property being accesses.
Return Value
CMxValue

GetLocked Method
Gets the lock status of an attribute in the previous version of
the object.
Syntax
public bool GetLocked(string attribute);
Parameter
attribute
[in] the name of the attribute (must include the full name of
the primitive if it is not the topmost primitive.)
Return Value
bool

GetSecurity Method
Gets the security of an attribute in the previous version of
the object.
Syntax
public MxSecurityClassification GetSecurity(string
attribute);
Parameter
attribute
[in] the name of the attribute (must include the full name of
the primitive if it is not the topmost primitive.)
Return Value
MxSecurityClassification

ArchestrA Object Toolkit Reference Guide


Event Arguments 265

GetValue Method
Gets the value of an attribute in the previous version of the
object.
Syntax
public CMxValue GetValue(string attribute);
Parameter
attribute
[in] the name of the attribute ( must include the full name
of the primitive if it is not the topmost primitive.)
Return Value
CMxValue

MajorVersion Method
The major version of the primitive that is being migrated.
Syntax
public short MajorVersion();
Return Value
short

MigrateHandler Member
The following is the member of the MigrateHandler class.
• AutoMigrateChildPrimitives Member

AutoMigrateChildPrimitives Member
You can set this flag true if you want child primitives to auto
migrate.
Syntax
bool AutoMigrateChildPrimitives

ArchestrA Object Toolkit Reference Guide


266 Chapter 1 Class Reference

RuntimeSetHandlerEventArgs Class
RuntimeSetHandlerEventArgs is a class that provides
runtime set handlers with the information they need when
called.
Syntax
public class RuntimeRuntimeSetHandlerEventArgs :
RuntimeSetHandlerEventArgs

RuntimeSetHandlerEventArgs Constructor
The following is the constructor of the
RuntimeSetHandlerEventArgs class.
• RuntimeSetHandlerEventArgs Constructor AttributeHandle,
SetInfo, MxStatus, IMxValue, DateTime, DataQuality

RuntimeSetHandlerEventArgs Constructor AttributeHandle,


SetInfo, MxStatus, IMxValue, DateTime, DataQuality
This constructor is used internally by the Toolkit. The object
developer is not expected to typically use this constructor.
Syntax
RuntimeSetHandlerEventArgs(AttributeHandle
pAttributeHandle, SetInfo pInfo, MxStatus _status,
IMxValue pMxValue, DateTime _time, DataQuality
_quality)
Parameters
_ pAttributeHandle
[in] The attribute handle of the attribute being set.
_ pInfo
[in] The SetInfo sent with the value to this set handler.
_status
[in] The status information sent with the value to this set
handler.
_ pMxValue
[in] The value being sent to this set handler.
_time
[in] The timestamp of the value sent to this set handler.
_quality
[in] The data quality of the value sent to this set handler.

ArchestrA Object Toolkit Reference Guide


Event Arguments 267

RuntimeSetHandlerEventArgs Members
The following are the members of the
RuntimeSetHandlerEventArgs class.
• attributeInfo Member
• status member
• Time member
• Quality member

attributeInfo Member
The SetInfo of the current set.
Syntax
SetInfo attributeInfo

status member
A status to report the status of the set handler back to the
caller.
Syntax
MxStatus status

Time member
The timestamp of the value being set.
Syntax
DateTime Time

Quality member
The data quality of the value being set.
Syntax
CMxDataQuality Quality

ArchestrA Object Toolkit Reference Guide


268 Chapter 1 Class Reference

RuntimeGetStatusDescEventArgs Class
This class is the argument to the GetStatusDescription
event.
Syntax
public class RuntimeGetStatusDescEventArgs : EventArgs

RuntimeGetStatusDescEventArgs Constructor
The following is the constructor of the
RuntimeGetStatusDescEventArgs class.
• RuntimeGetStatusDescEventArgs Constructor

RuntimeGetStatusDescEventArgs Constructor
Provides a default constructor.
Syntax
RuntimeGetStatusDescEventArgs()

RuntimeGetStatusDescEventArgs Members
The following are the members of the
RuntimeGetStatusDescEventArgs class.
• status Member
• detailedErrorCode Member

status Member
A string describing the detailed error code.
Syntax
string status

detailedErrorCode Member
The detailed error code to look up for a description.
Syntax
short detailedErrorCode

ArchestrA Object Toolkit Reference Guide


Event Arguments 269

RuntimeSetScanStateEventArgs Class
This class is the argument to the set scan state event.
Syntax
public class RuntimeSetScanStateEventArgs : EventArgs

RuntimeSetScanStateEventArgs Constructor
The following is the constructor of the
RuntimeSetScanStateEventArgs class.
• RuntimeSetScanStateEventArgs Constructor

RuntimeSetScanStateEventArgs Constructor
Provides a default constructor.
Syntax
public RuntimeSetScanStateEventArgs();

RuntimeSetScanStateEventArgs Member
The following is the member of the
RuntimeSetScanEventArgs class.
• onScan Member

onScan Member
True if the object is going on scan.
Syntax
bool onScan

RuntimeStartupEventArgs Class
This class is the argument for the startup event.
Syntax
public class RuntimeStartupEventArgs : EventArgs

RuntimeStartupEventArgs Constructor
The following is the constructor of the
RuntimeStartupEventArgs class.
• RuntimeStartupEventArgs Constructor StartupInfo

RuntimeStartupEventArgs Constructor StartupInfo


This constructor is used internally by the Toolkit. The object
developer is not expected to typically use this constructor.
Syntax
public RuntimeStartupEventArgs(StartupInfo i);
Parameter
StartupInfo
[in] the StartupInfo of this startup event.

ArchestrA Object Toolkit Reference Guide


270 Chapter 1 Class Reference

RuntimeStartupEventArgs Member
The following is the member of the
RuntimeStartupEventArgs class.
• startInfo Member

startInfo Member
The startup information of this startup event.
Syntax
StartupInfo startInfo

Enumerations
This section includes Enumerations for Configtime, Runtime,
and Editor projects.

ESTARTUPCONTEXT Enumeration
Syntax
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.

eStartingFromCheckpoint
Indicates the object instance is being started after an engine
restart from checkpoint.

eStartingFromStandby
Indicates the object instance is being started after failover.
Remarks
Enumeration defining the context in which the primitive or
object of interest is being started.

ArchestrA Object Toolkit Reference Guide


Enumerations 271

StartupInfo Enumeration
Syntax
struct StartupInfo
{
public VB_LARGE_INTEGER checkpointFiletime;
public ESTARTUPCONTEXT startupContext;
}

Members

startupContext
Indicates whether object has just been deployed or restarted
from checkpoint.

checkpointFiletime
Amount of elapsed time in 100-nanosecond ticks since the
checkpoint file was last written for the hosting engine.
Indicates time since object last ran and check pointed to disk.
Remarks
Structure providing information on the startup context and
the amount of time that has elapsed since the checkpoint file
was last saved.This information can be used in the
RuntimeStartup() method in certain cases, especially when
the amount of time since the object last ran and was check
pointed to disk is required.This may be useful in certain
supervisory control algorithms that use hot startup and
warm startup concepts.

ArchestrA Object Toolkit Reference Guide


272 Chapter 1 Class Reference

ECALLCONTEXTFLAG Enumeration
Syntax
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.

SetInfo Enumeration
Syntax
struct SetInfo
{
public ECALLCONTEXTFLAG callContext;
public string engineName;
public int responseId;
public VBGUID userId;
public VBGUID userIdVerifier;
}

Members

UserId
For internal use only.

UserIdVerifier
For internal use only.

CallContext
Indicates type of client that issued the set request.

responseId
For internal use only.

ArchestrA Object Toolkit Reference Guide


Enumerations 273

engineName
For internal use only.
Remarks
Indicates information about an attribute set operation.

MxStatus Enumeration
Syntax
struct MxStatus
{
public MxStatusCategory Category;
public short detail;
public MxStatusSource detectedBy;
public short success;
}

Members

success
Indicates whether the operation succeeded, pending, or
failed.

Category
The MxStatusCategory of the operation indicating the
category of the status.

detectedBy
Indicates which component detected the condition.

detail
Error detail codes. 0 to 32,767. Values 0 to 9999 are reserved.
Values 10000 to 32767 can be used to define custom detailed
error codes.
Remarks
Structure containing detailed status information regarding a
Message Exchange get or set operation.

ArchestrA Object Toolkit Reference Guide


274 Chapter 1 Class Reference

MxStatusCategory Enumeration
Syntax
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.

ArchestrA Object Toolkit Reference Guide


Enumerations 275

MxStatusSource Enumeration
Syntax
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.

DataQuality Enumeration
Syntax
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.

ArchestrA Object Toolkit Reference Guide


276 Chapter 1 Class Reference

MxSecurityClassification Enumeration
Syntax
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.

MxCustomStruct Enumeration
Syntax
class MxCustomStruct
{
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();
}

ArchestrA Object Toolkit Reference Guide


Enumerations 277

Members

Guid
Unique type identifier for the custom structure for
type-checking.

Data
An array of bytes containing the actual data.
Remarks
This datatype is used in conjunction with CMxValue to
extract a custom struct from an MxValue. This datatype is
basically the "blob" type, allowing a stream of bytes to be
stored, read, and written in an attribute.

MxDataType Enumeration
Syntax
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.

ArchestrA Object Toolkit Reference Guide


278 Chapter 1 Class Reference

EPACKAGESTATUS Enumeration
Syntax
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.

EPRIMITIVEOPSTATUS Enumeration
Syntax
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.

ArchestrA Object Toolkit Reference Guide


Compatible Interface Classes 279

MxPropertyLockedEnum Enumeration
Syntax
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.

Compatible Interface Classes


The following table describes the classes:

Class Name Description

CMxValue Class A wrapper class that represents an


MxValue. Includes the fundamental
variant object that contains a single
data value or single array of data values
of like type. MxValue is used to get and
set data within the ArchestrA
framework.
CMxType Class An abstract class that provides the
methods and properties available to all
classes for supporting CMx{type}{Array}
style classes.
CMxCommon Class Derived from CMxType and provides
the default implementation for all
non-array types.
CMxArrayBase Class Derived from CMxType and provides
the default implementation for all array
types.

ArchestrA Object Toolkit Reference Guide


280 Chapter 1 Class Reference

Class Name Description

CMxArray<T> Class Derived from CMxArrayBase. It is a


template class that can be implemented
for each type to be supported to provide
type safe data access.
CMxBoolean Class Derived from CMxCommon and
provides support for Boolean Attributes.
CMxBooleanArray Class Derived from CMxArray and provides
support for Boolean Array Attributes.
CMxFloat Class Derived from CMxCommon and
provides support for Float Attributes.
CMxFloatArray Class Derived from CMxArray and provides
support for Float Array Attributes.
CMxDouble Class Derived from CMxCommon and
provides support for Double Attributes.
CMxDoubleArray Class Derived from CMxArray and provides
support for Double Array Attributes.
CMxInteger Class Derived from CMxCommon and
provides support for Integer Attributes.
CMxIntegerArray Class Derived from CMxArray and provides
support for Integer Array Attributes.
CMxCustomEnum Class Derived from CMxCommon and
provides support for Enum Attributes.
EnumText Class A utility class for
CMxCutomsEnumArray. It provides a
method to access the value of an
element of the array as a string rather
than an ordinal.
CMxCustomEnumArray Class Derived from CMxArray and provides
support for Enum Array Attributes.
CMxCustomStruct Class Derived from CMxCommon and
provides support for custom data in the
form of a guid and byte array.
CMxCustomStructArray Class Derived from CMxArray and provides
support for an array of custom data in
the form of a guid and byte array.
CMxDataType Class Derived from CMxCommon and
provides support for MxDataType
Attributes.

ArchestrA Object Toolkit Reference Guide


Compatible Interface Classes 281

Class Name Description

CMxDataTypeArray Class Derived from CMxArray and provides


support for MxDataType Array
Attributes.
CMxElapsedTime Class Derived from CMxCommon and
provides support for Elapsed
time/Timespan Attributes.
CMxElapsedTimeArray Class Derived from CMxArray and provides
support for Elapsed time/Timespan
Array Attributes.
CMxInternationalizedString Class Derived from CMxCommon and
provides support for Internationalized
string Attributes.
CMxInternationalizedStringArray Class Derived from CMxArray and provides
support for Arrays of Internationalized
strings.
CMxReference Class Derived from CMxCommon and
provides support for Reference
Attributes.
CMxReferenceArray Class Derived from CMxArray and provides
support for Reference Array Attributes.
CMxStatus Class Derived from CMxCommon and
provides support for MxStatus
Attributes.
CMxStatusArray Class Derived from CMxArray and provides
support for MxStatus Array Attributes.
CMxString Class Derived from CMxCommon and
provides support for string Attributes.
CMxStringArray Class Derived from CMxArray and provides
support for string Array Attributes.
CMxTime Class Derived from CMxCommon and
provides support for Time/DateTime
Attributes.
CMxTimeArray Class Derived from CMxArray and provides
support for Time/DateTime Array
Attributes.
CMxVariant Class Derived from CMxCommon and
provides support for variant Attributes.
CMxVariantArray Class Derived from CMxArray and provides
support for Variant Array Attributes.

ArchestrA Object Toolkit Reference Guide


282 Chapter 1 Class Reference

Class Name Description

CMxBigString Class Derived from CMxString and provides


support for Big String Attributes.
CMxBigStringArray Class Derived from CMxStringArray and
provides support for BigString Array
Attributes.
CMxInternalDumpLoadData Class Derived from CMxCustomStruct and
provides support for dump/load at
Configtime.
CMxInternalFailoverData Class Derived from CMxCustomStruct and
provides support for failover at
Runtime.
CMxDataQuality Class A wrapper class for handling
MxDataQuality. Indicates the data
quality of an associated value as the
OPC-compliant data quality word. The
high order byte is reserved by
ArchestrA (do not use) as allowed by the
OPC specification.
CMxIndirectBase Class CMxIndirectBase is an inherited class
that provides methods and properties
common to the two types of Indirects:
CMxIndirect and
CMxIndirectWriteOnly.
CMxIndirectWriteOnly Class 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.
CMxIndirect Class CMxIndirect is a support class that
allows a user to connect to an external
attribute and read/write its value.

ArchestrA Object Toolkit Reference Guide


CMxValue Class 283

CMxValue Class
A wrapper class that represents an MxValue. Includes the
fundamental variant object that contains a single data value
or single array of data values of like type. MxValue is used to
get and set data within the ArchestrA framework.
Syntax
public class CMxValue

CMxValue Properties
The following are the properties of the CMxValue class.
• Length Property

• Value Property

Length Property
Provides a property to get the length of the value.
Syntax
int Length { get; }
Return Value
int
Returns 0 if the value is a non-array type.

Value Property
Provides a property to get IMxValue for compatibility with
the existing methods.
Syntax
IMxValue Value { get; }
Return Value
IMxValue

ArchestrA Object Toolkit Reference Guide


284 Chapter 1 Class Reference

CMxValue Constructors
The following are the constructors of the CMxValue class.
• CMxValue Constructor
• CMxValue Constructor IMxValue

• CMxValue Constructor object

CMxValue Constructor
Provides a constructor to create an empty CMxValue.
Syntax
public CMxValue();

CMxValue Constructor IMxValue


Provides a constructor to create a CMxValue with the value
from an existing IMxValue.
Syntax
public CMxValue(IMxValue val);
Parameter
val
[in] IMxValue to be set.

CMxValue Constructor object


Provides a constructor to create a CMxValue with the value
of a C# object.
Syntax
public CMxValue(object val);
Parameter
val
[in] Supported datatypes: CMxValue, CMxType,
System.Boolean, System.Int32, System.Single,
System.Double, System.String, System.DateTime,
System.TimeSpan, System.Int16,
ArchestrA.Toolkit.EnumOrdinal,
ArchestrA.Toolkit.MxCustomStruct,
ArchestrA.Core.MxDataType,
ArchestrA.Core.MxDataType,
ArchestrA.Core.MxSecurityClassification,
ArchestrA.Core.InternationalizedString,
ArchestrA.Core.DataQuality,
ArchestrA.Toolkit.CMxDataQuality and
ArchestrA.Core.MxReference.

ArchestrA Object Toolkit Reference Guide


CMxValue Class 285

CMxValue Methods
The following are the methods of the CMxValue class.
• Clone Method
• Empty Method

• DateTimeToFileTime Method

• DateTimeToVBFT Method

• FileTimeToDateTime Method

• VBFIToDateTime Method

• TimeSpanToVBLI Method
• VBLIToTimeSpan Method

• GetBoolean Method

• GetBooleanArray Method

• GetClassID Method

• GetCustomEnum Method

• GetCustomEnumArray Method

• GetCustomEnumOrdinal Method

• GetCustomEnumString Method

• GetCustomStruct Method

• GetCustomStructArray Method

• GetCustomStructVB Method
• GetDataType Method
• GetDimensionCount Method

• GetDimensionSize Method

• GetDouble Method

• GetDoubleArray Method

• GetElapsedTime Method

• GetElapsedTimeArray Method

• GetElement Method

• GetFloat Method

• GetFloatArray Method

• GetInteger Method

ArchestrA Object Toolkit Reference Guide


286 Chapter 1 Class Reference

• GetIntegerArray Method

• GetInternationalString Method

• GetInternationalStrings Method
• GetMxDataQuality Method

• GetMxDataType Method

• GetMxDataTypeArray Method

• GetMxReference Method

• GetMxReferenceArrayAsStrings Method
• GetMxReferenceAsString Method

• GetMxSecurityClassification Method

• GetMxSecurityClassificationArray Method

• GetMxStatus Method

• GetMxStatusArray Method

• GetSizeMax Method

• GetString Method

• GetStringArray Method

• GetTime Method

• GetTime Method

• GetTimeArray Method

• IsArray Method
• IsDirty Method
• PutBoolean Method

• PutBooleanArray Method

• PutCustomEnum Method

• PutCustomEnumArray Method

• PutCustomEnumOrdinal Method

• PutCustomStruct Method

• PutCustomStructArray Method

• PutCustomStructVBArray Method

• PutDouble Method

• PutDoubleArray Method

ArchestrA Object Toolkit Reference Guide


CMxValue Class 287

• PutElapsedTime Method

• PutElapsedTimeArray Method

• PutElement Method
• PutFloat Method

• PutFloatArray Method

• PutInteger Method

• PutIntegerArray Method

• PutInternationalString Method
• PutInternationalStringVB Method

• PutMxDataQuality Method

• PutMxDataQuality Method

• PutMxDataType Method

• PutMxDataTypeArray Method

• PutMxReference Method

• PutMxReferenceArrayAsStrings Method

• PutMxReferenceAsString Method

• PutMxSecurityClassification Method

• PutMxSecurityClassificationArray Method

• PutMxStatus Method

• PutMxStatusArray Method
• PutString Method
• PutStringArray Method

• PutTime Method

• PutTimeArray Method

• ToString Method

ArchestrA Object Toolkit Reference Guide


288 Chapter 1 Class Reference

Clone Method
Provides a method to create a copy of an existing CMxValue
which includes creating a copy of the internal IMxValue
class.
Syntax
public Clone(out CMxValue ppMxValue);
Parameter
ppMxValue
[out} fills the ppMxValue with the current CMxValue.

Empty Method
Provides a method to call Empty on the IMxValue.
Syntax
public void Empty();

DateTimeToFileTime Method
Provides a method to convert a DateTime into a _FILETIME.
Converts the current System.DateTime object to a Windows
file time.
Syntax
public static _FILETIME DateTimeToFileTime(DateTime
date);
Parameter
date
[in] DateTime value.
Return Value
_FILETIME

DateTimeToVBFT Method
Provides a method to convert a DateTime into a
VBFILETIME.
Syntax
public static VBFILETIME DateTimeToVBFT(DateTime date);
Parameter
date
[in] DateTime value.
Return Value
VBFILETIME

ArchestrA Object Toolkit Reference Guide


CMxValue Class 289

FileTimeToDateTime Method
Provides a method to convert a _FILETIME to a DateTime.
Syntax
public static DateTime FileTimeToDateTime(_FILETIME
val);
Parameter
val
[in] __FILETIME value.
Return Value
DateTime

VBFIToDateTime Method
Provides a method to convert VBFILETIME to DateTime.
Syntax
public static DateTime VBFTToDateTime(VBFILETIME val);
Parameter
val
[in] VBFILETIME value.
Return Value
DateTime

TimeSpanToVBLI Method
Provides a method to convert a TimeSpan to
VB_LARGE_INTEGER.
Syntax
public static VB_LARGE_INTEGER TimeSpanToVBLI(TimeSpan
span);
Parameter
span
[in] TimeSpan value.
Return Value
VB_LARGE_INTEGER

ArchestrA Object Toolkit Reference Guide


290 Chapter 1 Class Reference

VBLIToTimeSpan Method
Provides a method to convert VB_LARGE_INTEGER to
TimeSpan.
Syntax
public static TimeSpan VBLIToTimeSpan(VB_LARGE_INTEGER
val);
Parameter
val
[in] VB_LARGE_INTEGER value.
Return Value
TimeSpan

GetBoolean Method
Provides a method to get the value as a Boolean.
Syntax
public bool GetBoolean();
Return Value
bool

GetBooleanArray Method
Provides a method to get the value as a Boolean array.
Syntax
public bool[] GetBooleanArray();
Return Value
bool[ ]

GetClassID Method
Provides a method to get the Class ID of the IMxValue.
Syntax
public void GetClassID(out Guid pClassID);
Parameter
pClassID
[out] fills the pClassID with the Class ID of the IMxValue.

ArchestrA Object Toolkit Reference Guide


CMxValue Class 291

GetCustomEnum Method
Provides a method to get a custom enum as a text value,
ordinal, id of the primitive that owns the array of strings, id
of the array of strings.
Syntax
public void GetCustomEnum(out string pValue, out short
pOrdinal, out short pPrimitiveId, out
short pAttributeId);
Parameters
pValue
[out] fills the pValue with the current CMXCustomEnum
text.
pOrdinal
[out] fills the pOrdinal with the current CMXCustomEnum
ordinal.
pPrimitiveId
[out] fills the pPrimitiveId with the primitive ID of the
referred string array attribute.
pAttributeId
[out] fills the pAttributeId with the attribute ID of the
referred string array attribute.

GetCustomEnumArray Method
Provides a method to get an array of ordinals of a
CustomEnum.
Syntax
public short[] GetCustomEnumArray();
Return Value
short[ ]

GetCustomEnumOrdinal Method
Provides a method to get the ordinal of a CustomEnum.
Syntax
public short GetCustomEnumOrdinal();
Return Value
short

ArchestrA Object Toolkit Reference Guide


292 Chapter 1 Class Reference

GetCustomEnumString Method
Provides a method to get the text value of a CustomEnum.
Syntax
public string GetCustomEnumString();
Return Value
string

GetCustomStruct Method
Provides a method to get the value as an MxCustomStruct.
Syntax
public MxCustomStruct GetCustomStruct();
Return Value
MxCustomStruct

GetCustomStructArray Method
Provides a method to get the value as an MxCustomStruct
Array.
Syntax
public MxCustomStruct[] GetCustomStructArray();
Return Value
MxCustomStruct[ ]

GetCustomStructVB Method
Provides a method to get the value as a guid and byte array.
Syntax
public void GetCustomStructVB(out int pGuid, ref byte[]
pStruct);
Parameters
pGuid
[out] fills the pGuid with the current
CMXCustomStructArray guid.
pStruct
[out] fills the pStruct with the current
CMXCustomStructArray data.

GetDataType Method
Provides a method to get the type of the data.
Syntax
public MxDataType GetDataType();
Return Value
MxDataType

ArchestrA Object Toolkit Reference Guide


CMxValue Class 293

GetDimensionCount Method
Provides a method to get the number of dimensions.
Syntax
public void GetDimensionCount(out short nDimensions);
Parameter
nDimensions
[out] fills the nDimensions with the dimension count of the
IMxValue.

GetDimensionSize Method
Provides a method to access the DimensionSize of IMxValue.
Syntax
public void GetDimensionSize(out int pSize);
Parameter
pSize
[out] fills the pSize with the dimension size of the
IMxValue.

GetDouble Method
Provides a method to get the value as a double.
Syntax
public double GetDouble();
Return Value
double

GetDoubleArray Method
Provides a method to get the value as a double array.
Syntax
public double[] GetDoubleArray();
Return Value
double[ ]

GetElapsedTime Method
Provides a method to get the value as a TimeSpan.
Syntax
public dTimeSpan GetElapsedTime();
Return Value
TimeSpan

ArchestrA Object Toolkit Reference Guide


294 Chapter 1 Class Reference

GetElapsedTimeArray Method
Provides a method to get the value as a TimeSpan array.
Syntax
public TimeSpan[] GetElapsedTimeArray();
Return Value
TimeSpan[ ]

GetElement Method
Provides a method to get a single element of an array as a
CMxValue by index.
Syntax
public void GetElement(int index1, out CMxValue
pMxValue);
Parameters
index1
[in] index of the array element.
pMxValue
[out] fills the pMxValue with the array element.

GetFloat Method
Provides a method to get the value as a float.
Syntax
public float GetFloat();
Return Value
float

GetFloatArray Method
Provides a method to get the value as a float array.
Syntax
public float[] GetFloatArray();
Return Value
float[ ]

GetInteger Method
Provides a method to get the value as an int.
Syntax
public int GetInteger();
Return Value
int

ArchestrA Object Toolkit Reference Guide


CMxValue Class 295

GetIntegerArray Method
Provides a method to get the value as an int array.
Syntax
public int[] GetIntegerArray();
Return Value
int[ ]

GetInternationalString Method
Provides a method to get the value by locale.
Syntax
public string GetInternationalString(int locale);
Parameter
locale
[in] locale number of the language/culture.
Return Value
string

GetInternationalStrings Method
Provides a method to get the value as an array of
InternationalizedStrings.
Syntax
public InternationalizedString[]
GetInternationalStrings();
Return Value
InternationalizedString[ ]

GetMxDataQuality Method
Provides a method to get the Data Quality as a short.
Syntax
public short GetMxDataQuality();
Return Value
short

GetMxDataType Method
Provides a method to get the value as a MxDataType.
Syntax
public MxDataType GetMxDataType();
Return Value
MxDataType

ArchestrA Object Toolkit Reference Guide


296 Chapter 1 Class Reference

GetMxDataTypeArray Method
Provides a method to get the value as a MxDataType array.
Syntax
public MxDataType[] GetMxDataTypeArray();
Return Value
MxDataType[ ]

GetMxReference Method
Provides a method to get the value as a IMxReference.
Syntax
public IMxReference GetMxReference();
Return Value
IMxReference

GetMxReferenceArrayAsStrings Method
Provides a method to get the value of a reference array as an
array of strings.
Syntax
public string[] GetMxReferenceArrayAsStrings();
Return Value
string[ ]

GetMxReferenceAsString Method
Provides a method to get the value of a reference as a string.
Syntax
public string GetMxReferenceAsString();
Return Value
string

GetMxSecurityClassification Method
Provides a method to get the value as a
MxSecurityClassification.
Syntax
public MxSecurityClassification
GetMxSecurityClassification();
Return Value
MxSecurityClassification

ArchestrA Object Toolkit Reference Guide


CMxValue Class 297

GetMxSecurityClassificationArray Method
Provides a method to get the value as a
MxSecurityClassification array.
Syntax
public MxSecurityClassification[]
GetMxSecurityClassificationArray();
Return Value
MxSecurityClassification[ ]

GetMxStatus Method
Provides a method to get the value as a MxStatus.
Syntax
public MxStatus GetMxStatus();
Return Value
MxStatus

GetMxStatusArray Method
Provides a method to get the value as a MxStatus array.
Syntax
public MxStatus[] GetMxStatusArray();
Return Value
MxStatus[ ]

GetSizeMax Method
Provides a method to get the max size as a
_ULARGE_INTEGER.
Syntax
public void GetSizeMax(out _ULARGE_INTEGER pcbSize);
Parameter
pcbSize
[out] fills the pcbSize with the IMxValue max size.

GetString Method
Provides a method to get the value as a string.
Syntax
public string GetString();
Return Value
string

ArchestrA Object Toolkit Reference Guide


298 Chapter 1 Class Reference

GetStringArray Method
Provides a method to get the value as a string array.
Syntax
public string[] GetStringArray();
Return Value
string[ ]

GetTime Method
Provides a method to get the value as a DateTime.
Syntax
public DateTime GetTime();
Return Value
DateTime

GetTime Method
Provides a method to get the value as a DateTime
(compatible with IMxValue syntax.)
Syntax
public void GetTime(out DateTime pVal);
Parameter
pVal
[out] fills the DateTime parameter by converting the
Windows file time to its equivalent local time.

GetTimeArray Method
Provides a method to get the value as a DateTime array.
Syntax
public DateTime[] GetTimeArray();
Return Value
DateTime[ ]

IsArray Method
Provides a method to indicate if the value is an array.
Syntax
public bool IsArray();
Return Value
bool

ArchestrA Object Toolkit Reference Guide


CMxValue Class 299

IsDirty Method
Provides a method to access IMxValue IsDirty.
Syntax
public void IsDirty();

PutBoolean Method
Provides a method to set the value from a Boolean.
Syntax
public void PutBoolean(bool newVal);
Parameter
newVal
[in] bool value to be set.

PutBooleanArray Method
Provides a method to set the value from a Boolean array.
Syntax
public void PutBooleanArray(bool[] values);
Parameter
values
[in] bool[ ] value to be set.

PutCustomEnum Method
Provides a method to set the value from a text string, ordinal,
primitive ID, and atttribute ID.
Syntax
public void PutCustomEnum(string Value, short ordinal,
short primitiveId, short attributeId);
Parameters
Value
[in] Text to set to the CMxCustomEnum.
ordinal
[in] Ordinal position to be set.
primitiveId
[in] primitive id of the referenced string array attribute.
attributeId
[in] Attribute id of the referenced string array attribute
CMxValue Class.

ArchestrA Object Toolkit Reference Guide


300 Chapter 1 Class Reference

PutCustomEnumArray Method
Provides a method to set the value from an array of shorts
indicating the ordinal.
Syntax
public void PutCustomEnumArray(short[] values);
Parameter
values
[in] Sets the CMxCustomEnumArray with the ordinal
values.

PutCustomEnumOrdinal Method
Provides a method to set the value of the ordinal.
Syntax
public void PutCustomEnumOrdinal(short ordinal);
Parameter
ordinal
[in] Sets the CMxCustomEnum ordinal value.

PutCustomStruct Method
Provides a method to set the value from a MxCustomStruct.
Syntax
public void PutCustomStruct(MxCustomStruct cs);
Parameter
cs
[in] MxCustomStruct value to be set.

PutCustomStructArray Method
Provides a method to set the value from a MxCustomStruct
array.
Syntax
public void PutCustomStructArray(MxCustomStruct[]
values);
Parameter
values
[in] MxCustomStruct[ ] value to be set.

ArchestrA Object Toolkit Reference Guide


CMxValue Class 301

PutCustomStructVBArray Method
Provides a method to set the value from a guid and byte
array.
Syntax
public void PutCustomStructVB(int guid, byte[]
pStruct);
Parameters
guid
[in] int value that holds guid to be set.
pStruct
[in] byte[ ] value to be set.

PutDouble Method
Provides a method to set the value from a double.
Syntax
public void PutDouble(double newVal);
Parameter
newVal
[in] double value to be set.

PutDoubleArray Method
Provides a method to set the value from a double array.
Syntax
public void PutDoubleArray(double[] values);
Parameter
values
[in] double[ ] value to be set.

PutElapsedTime Method
Provides a method to set the value from a TimeSpan.
Syntax
public void PutElapsedTime(TimeSpan ts);
Parameter
ts
[in] TimeSpan value to be set.

ArchestrA Object Toolkit Reference Guide


302 Chapter 1 Class Reference

PutElapsedTimeArray Method
Provides a method to set the value from a TimeSpan array.
Syntax
public void PutElapsedTimeArray(TimeSpan[] values);
Parameter
values
[in] TimeSpan[ ] value to be set.

PutElement Method
Provides a method to set the value of an element from a
CMxValue by index.
Syntax
public void PutElement(int index, CMxValue pMxValue);
Parameters
index
[in] index value.
pMxValue
[in] value to be set at the specified index.

PutFloat Method
Provides a method to set the value from a float.
Syntax
public void PutFloat(float newVal);
Parameter
newVal
[in] float value to be set.

PutFloatArray Method
Provides a method to set the value from a float array.
Syntax
public void PutFloatArray(float[] values);
Parameter
values
[in] float[ ] value to be set.

ArchestrA Object Toolkit Reference Guide


CMxValue Class 303

PutInteger Method
Provides a method to set the value from an int.
Syntax
public void PutInteger(int newVal);
Parameter
newVal
[in] integer value to be set.

PutIntegerArray Method
Provides a method to set the value from an int array.
Syntax
public void PutIntegerArray(int[] values);
Parameter
values
[in] integer[ ] value to be set.

PutInternationalString Method
Provides a method to set the value of a specified locale from a
string.
Syntax
public void PutInternationalString(int locale, string
InternationalizedString);
Parameters
locale
[in] integer value to be set.
InternationalizedString
[in] string value to be set.

PutInternationalStringVB Method
Provides a method to set the value from an
InternationalizedString array.
Syntax
public void
PutInternationalStringsVB(InternationalizedString[]
ppsa);
Parameter
ppsa
[in] InternationalizedString[ ] value to be set.

ArchestrA Object Toolkit Reference Guide


304 Chapter 1 Class Reference

PutMxDataQuality Method
Provides a method to set the value from an OpcQuality.
Syntax
public void PutMxDataQuality(OpcQuality newVal);
Parameter
newVal
[in] OpcQuality value to be set.

PutMxDataQuality Method
Provides a method to set the value from a short quality.
Syntax
public void PutMxDataQuality(short newVal);
Parameter
newVal
[in] short value to be set.

PutMxDataType Method
Provides a method to set the value from a MxDataType.
Syntax
public void PutMxDataType(MxDataType newVal);
Parameter
newVal
[in] MxDataType value to be set.

PutMxDataTypeArray Method
Provides a method to set the value from a MxDataType
array.
Syntax
public void PutMxDataTypeArray(MxDataType[] values);
Parameter
values
[in] MxDataType[ ] values to be set.

PutMxReference Method
Provides a method to set the value from a IMxReference.
Syntax
public void PutMxReference(IMxReference newVal);
Parameter
newVal
[in] IMxReference value to be set.

ArchestrA Object Toolkit Reference Guide


CMxValue Class 305

PutMxReferenceArrayAsStrings Method
Provides a method to set the value of a reference array from
an array of strings.
Syntax
public void PutMxReferenceArrayAsStrings(string[]
values);
Parameter
values
[in] string[ ] value to set the reference string of
CMxReferenceArray.

PutMxReferenceAsString Method
Provides a method to set the value of a reference from a
string.
Syntax
public void PutMxReferenceAsString(string newVal);
Parameter
newVal
[in] string value to be set.

PutMxSecurityClassification Method
Provides a method to set the value from a
MxSecurityClassification.
Syntax
public void
PutMxSecurityClassification(MxSecurityClassification
newVal);
Parameter
newVal
[in] MxSecurityClassification value to be set.

PutMxSecurityClassificationArray Method
Provides a method to set the value from a
MxSecurityClassification array.
Syntax
public void
PutMxSecurityClassificationArray(MxSecurityClassific
ation[] newVal);
Parameter
newVal
[in] MxSecurityClassification[ ] value to be set.

ArchestrA Object Toolkit Reference Guide


306 Chapter 1 Class Reference

PutMxStatus Method
Provides a method to set the value from a MxStatus.
Syntax
public void PutMxStatus(MxStatus newVal);
Parameter
newVal
[in] MxStatus value to be set.

PutMxStatusArray Method
Provides a method to set the value from a MxStatus array.
Syntax
public void PutMxStatusArray(MxStatus[] values);
Parameter
values
[in] MxStatus[ ] value to be set.

PutString Method
Provides a method to set the value from a string.
Syntax
public void PutString(string newVal);
Parameter
newVal
[in] string value to be set to CMxString.

PutStringArray Method
Provides a method to set the value from a string array.
Syntax
public void PutStringArray(string[] values);
Parameter
values
[in] string[ ] value to be set.

PutTime Method
Provides a method to set the value from a DateTime.
Syntax
public void PutTime(DateTime val);
Parameter
val
[in] DateTime value to be set.

ArchestrA Object Toolkit Reference Guide


CMxValue Class 307

PutTimeArray Method
Provides a method to set the value from a DateTime array.
Syntax
public void PutTimeArray(DateTime[] values);
Parameter
values
[in] DateTime[ ] value to be set.

ToString Method
Provides a method to output the value as a string.
Syntax
public override string ToString();
Return Value
string

CMxValue Operator Overloads


The following are the operator overloads of the CMxValue
class.
• Integer Operator Overload

• Float Operator Overload

• Double Operator Overload

• TimeSpan Operator Overload

• MxCustomStruct Operator Overload

• EnumOrdinal Operator Overload


• MxDataType Operator Overload
• MxStatus Operator Overload

• String Overload

• MxSecurityClassification Operator Overload

• DateTime Operator Overload

• MxValueClass Operator Overload

• CMxValue Operator Overload (bool)

• CMxValue Operator Overload (DateTime)

• CMxValue Operator Overload (double)

• CMxValue Operator Overload (float)

• CMxValue Operator Overload (int)

ArchestrA Object Toolkit Reference Guide


308 Chapter 1 Class Reference

• CMxValue Operator Overload (MxDataType)

• CMxValue Operator Overload (MxSecurityClassification)

• CMxValue Operator Overload (MxStatus)


• CMxValue Operator Overload (OpcQuality)

• CMxValue Operator Overload (string)

• CMxValue Operator Overload (TimeSpan)

Integer Operator Overload


Provides a conversion operator to convert from CMxValue to
int.
Syntax
public static implicit operator int(CMxValue val);
Parameter
val
[in] CMxValue to convert to integer.
Return Value
int

Float Operator Overload


Provides a conversion operator to convert from CMxValue to
float.
Syntax
public static implicit operator float(CMxValue val);
Parameter
val
[in] CMxValue to convert to float.
Return Value
float

Double Operator Overload


Provides a conversion operator to convert from CMxValue to
a double.
Syntax
public static implicit operator double(CMxValue val);
Parameter
val
[in] CMxValue to convert to double.
Return Value
double

ArchestrA Object Toolkit Reference Guide


CMxValue Class 309

TimeSpan Operator Overload


Provides a conversion operator to convert from CMxValue to
TimeSpan.
Syntax
public static implicit operator TimeSpan(CMxValue val);
Parameter
val
[in] CMxValue to convert to ElapsedTime.
Return Value
TimeSpan

MxCustomStruct Operator Overload


Provides a conversion operator to convert from CMxValue to
MxCustomStruct.
Syntax
public static implicit operator MxCustomStruct(CMxValue
val);
Parameter
val
[in] CMxValue to convert to MxCustomStruct.
Return Value
MxCustomStruct

EnumOrdinal Operator Overload


Provides a conversion operator to convert from CMxValue to
EnumOrdinal.
Syntax
public static implicit operator EnumOrdinal(CMxValue
val);
Parameter
val
[in] CMxValue to convert to EnumOrdinal.
Return Value
EnumOrdinal

ArchestrA Object Toolkit Reference Guide


310 Chapter 1 Class Reference

MxDataType Operator Overload


Provides a conversion operator to convert from CMxValue to
MxDataType
Syntax
public static implicit operator MxDataType(CMxValue
val);
Parameter
val
[in] CMxValue to convert to MxDataType.
Return Value
MxDataType

MxStatus Operator Overload


Provides a conversion operator to convert from CMxValue to
MxStatus.
Syntax
public static implicit operator MxStatus(CMxValue val);
Parameter
val
[in] CMxValue to convert to MxStatus.
Return Value
MxStatus

String Overload
Provides a conversion operator to convert from CMxValue to
string.
Syntax
public static implicit operator string(CMxValue val);
Parameter
val
[in] CMxValue to convert to string.
Return Value
string

ArchestrA Object Toolkit Reference Guide


CMxValue Class 311

MxSecurityClassification Operator Overload


Provides a conversion operator to convert from CMxValue to
MxSecurityClassification
Syntax
public static implicit operator
MxSecurityClassification(CMxValue val);
Parameter
val
[in] CMxValue to convert to MxSecurityClassification.
Return Value
MxSecurityClassification

DateTime Operator Overload


Provides a conversion operator to convert from CMxValue to
DateTime.
Syntax
public static implicit operator DateTime(CMxValue val);
Parameter
val
[in] CMxValue to convert to DateTime.
Return Value
DateTime

MxValueClass Operator Overload


Provides a conversion operator to convert from CMxValue to
MxValueClass.
Syntax
public static implicit operator MxValueClass(CMxValue
val);
Parameter
val
[in] CMxValue to convert to MxValueClass.
Return Value
MxValueClass

ArchestrA Object Toolkit Reference Guide


312 Chapter 1 Class Reference

CMxValue Operator Overload (bool)


Provides a conversion operator to convert from bool to
CMxValue.
Syntax
public static implicit operator CMxValue(bool val);
Parameter
val
[in] bool value to convert to CMxValue.
Return Value
CMxValue

CMxValue Operator Overload (DateTime)


Provides a conversion operator to convert from DateTime to
CMxValue.
Syntax
public static implicit operator CMxValue(DateTime val);
Parameter
val
[in] DateTime value to convert to CMxValue.
Return Value
CMxValue

CMxValue Operator Overload (double)


Provides a conversion operator to convert from double to
CMxValue.
Syntax
public static implicit operator CMxValue(double val);
Parameter
val
[in] double value to convert to CMxValue.
Return Value
CMxValue

ArchestrA Object Toolkit Reference Guide


CMxValue Class 313

CMxValue Operator Overload (float)


Provides a conversion operator to convert from float to
CMxValue.
Syntax
public static implicit operator CMxValue(float val);
Parameter
val
[in] float value to convert to CMxValue.
Return Value
CMxValue

CMxValue Operator Overload (int)


Provides a conversion operator to convert from int to
CMxValue
Syntax
public static implicit operator CMxValue(int val);
Parameter
val
[in] int value to convert to CMxValue.
Return Value
CMxValue

CMxValue Operator Overload (MxDataType)


Provides a conversion operator to convert from MxDataType
to CMxValue
Syntax
public static implicit operator CMxValue(MxDataType
val);
Parameter
val
[in] MxDataType value to convert to CMxValue.
Return Value
CMxValue

ArchestrA Object Toolkit Reference Guide


314 Chapter 1 Class Reference

CMxValue Operator Overload


(MxSecurityClassification)
Provides a conversion operator to convert from
MxSecurityClassification to CMxValue
Syntax
public static implicit operator
CMxValue(MxSecurityClassification val);
Parameter
val
[in] MxSecurityClassification value to convert to
CMxValue.
Return Value
CMxValue

CMxValue Operator Overload (MxStatus)


Provides a conversion operator to convert from MxStatus to
CMxValue.
Syntax
public static implicit operator CMxValue(MxStatus val);
Parameter
val
[in] MxStatus value to convert to CMxValue.
Return Value
CMxValue

CMxValue Operator Overload (OpcQuality)


Provides a conversion operator to convert from OpcQuality to
CMxValue.
Syntax
public static implicit operator CMxValue(OpcQuality
val);
Parameter
val
[in] OpcQuality value to convert to CMxValue.
Return Value
CMxValue

ArchestrA Object Toolkit Reference Guide


CMxType Class 315

CMxValue Operator Overload (string)


Provides a conversion operator to convert from string to
CMxValue.
Syntax
public static implicit operator CMxValue(string val);
Parameter
val
[in] string value to convert to CMxValue.
Return Value
CMxValue

CMxValue Operator Overload (TimeSpan)


Provides a conversion operator to convert from TimeSpan to
CMxValue.
Syntax
public static implicit operator CMxValue(TimeSpan val);
Parameter
val
[in] TimeSpan value to convert to CMxValue.
Return Value
CMxValue

CMxType Class
CMxType is an abstract class that provides the methods and
properties available to all classes for supporting
CMx{type}{Array} style classes.
Syntax
public abstract class CMxType

CMxType Properties
The following are the properties of the CMxType class.
• Attribute Property

• AttributeRef Property

• Owner Property

• Runtime Property

• RuntimeSite2 Property

• Attribute Property

• Category Property

ArchestrA Object Toolkit Reference Guide


316 Chapter 1 Class Reference

• Checkpoint Property

• DataType Property

• DefValue Property
• LiteMode Property

• Locked Property

• MxValue Property

• Quality Property

• Time Property
• Security Property

• SetHandlerValue Property

Attribute Property
Provides a property to hold information about the Attribute
from ArchestrA.
Syntax
protected AttributeHandle attribute;
Return Value
AttributeHandle

AttributeRef Property
Provides a property to hold the attribute reference string
when CMxType classes are used to implement properties of
Primitive Attributes.
Syntax
protected string attributeRef;
Return Value
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
protected AObjectBase owner;
Return Value
AObjectBase

ArchestrA Object Toolkit Reference Guide


CMxType Class 317

Runtime Property
Provides a property to hold an indication that the object is
currently servicing the Runtime.
Syntax
protected bool runtime;
Return Value
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
protected IPrimitiveRuntimeSite2 runtimeSite2;
Return Value
IPrimitiveRuntimeSite2

Attribute Property
Provides a property to get and set the AttributeHandle.
Syntax
AttributeHandle Attribute { get; set; }
Return Value
AttributeHandle

Category Property
Provides a property to get the MxAttributeCategory.
Syntax
public virtual MxAttributeCategory Category { get; }
Return Value
MxAttributeCategory

Checkpoint Property
Provides a property to Checkpoint the attribute at runtime.
Syntax
public bool Checkpoint { set; }
Return Value
bool

ArchestrA Object Toolkit Reference Guide


318 Chapter 1 Class Reference

DataType Property
Provides a property to get the MxDataType.
Syntax
public virtual MxDataType DataType { get; }
Return Value
MxDataType

DefValue Property
Provides a property to return the default value as a string.
Syntax
public abstract string DefValue { get; }
Return Value
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
public bool LiteMode { get; }
Return Value
bool

Locked Property
Provides a property to get and set the lock of the Attribute.
Syntax
public bool Locked { get; set; }
Return Value
bool

MxValue Property
Provides a property to get and set the IMxValue of the
Attribute.
Syntax
public virtual IMxValue mxValue { get; set; }
Return Value
MxValueClass

ArchestrA Object Toolkit Reference Guide


CMxType Class 319

Quality Property
Provides a property to get and set the Quality of the
Attribute.
Syntax
public abstract CMxDataQuality Quality { get; set; }
Return Value
CMxDataQuality

Time Property
Provides a property to get and set the Time of the Attribute.
Syntax
public abstract CMxTime Time { get; set; }
Return Value
CMxTime

Security Property
Provides a property to get and set the Security of the
Attribute.
Syntax
public virtual MxSecurityClassification Security { get;
set; }
Return Value
MxSecurityClassification

SetHandlerValue Property
Provides a property to set the value from a
SetHandlerEventArgs value.
Syntax
public virtual SetHandlerEventArgs SetHandlerValue {
set; }
Return Value
SetHandlerEventArgs

ArchestrA Object Toolkit Reference Guide


320 Chapter 1 Class Reference

CMxType Constructor
The following is the constructor of the CMxType class.
• Initialize Method

CMxType Constructor
Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxType(SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

CMxType Methods
The following are the methods of the CMxType class.
• Initialize Method

• CheckConnect Method

• PadMiliseconds Method

• UpdateArrayLength Method

Initialize Method
Provides a method to initialize the attribute with ArchestrA
information.
Syntax
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.

ArchestrA Object Toolkit Reference Guide


CMxType Class 321

CheckConnect Method
Provides a method to verify and connect to ArchestrA if
needed for primitive wrappers.
Syntax
protected void CheckConnect();

PadMiliseconds Method
Provides a method to get the ArchestrA style milliseconds as
a string from a TimeSpan.
Syntax
protected string PadMiliseconds(TimeSpan ts);
Parameter
ts
[in] TimeSpan value.
Return Value
string

UpdateArrayLength Method
Provides a method to set the length of an array to a new
length.
Syntax
protected void UpdateArrayLength(int newLength);
Parameter
newlength
[in] int value that holds the new length of the array.

ArchestrA Object Toolkit Reference Guide


322 Chapter 1 Class Reference

CMxCommon Class
CMxCommon is derived from CMxType and provides the
default implementation for all non-array types.
Syntax
public abstract class CMxCommon : CMxType

CMxCommon Property
The following is the property of the CMxCommon class.
• DefaultValue Property

DefaultValue Property
Provides a property to hold the default value.
Syntax
public object defaultValue;
Return Value
object

CMxCommon Constructors
The following are the constructors of the CMxCommon class.
• CMxCommon Constructor

• CMxCommon Constructor (SupportWrapper, string)

CMxCommon Constructor
Provides a default constructor.
Syntax
CMxCommon();

CMxCommon Constructor (SupportWrapper, string)


Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxCommon(SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds attribute reference.

ArchestrA Object Toolkit Reference Guide


CMxArrayBase Class 323

CMxArrayBase Class
CMxArrayBase is derived from CMxType and provides the
default implementation for all array types.
Syntax
public abstract class CMxArrayBase : CMxType

CMxArrayBase Properties
The following are the properties of the CMxArrayBase class.
• DefLength Property

• Length Property

DefLength Property
Provides a property to return a int of the default value.
Syntax
protected abstract int DefLength { get; set; };
Return Value
int

Length Property
Provides a property to get and set the Length.
Syntax
public int Length { get; set; }
Return Value
int

CMxArrayBase Constructors
The following are the constructors of the CMxArrayBase
class.
• CMxArrayBase Constructor

• CMxArrayBase Constructor (SupportWrapper, string)

CMxArrayBase Constructor
Provides a default constructor.
Syntax
public CMxArrayBase();

ArchestrA Object Toolkit Reference Guide


324 Chapter 1 Class Reference

CMxArrayBase Constructor (SupportWrapper, string)


Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxArrayBase(SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds attribute reference.

CMxArray<T> Class
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
public abstract class CMxArray<T> : CMxArrayBase

CMxArray<T> Constructor
The following is the constructor of the CMxArray<T> class.
• CMxArray

CMxArray
Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxArray(SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

ArchestrA Object Toolkit Reference Guide


CMxBoolean Class 325

CMxBoolean Class
CMxBoolean is derived from CMxCommon and provides
support for Boolean Attributes.
Syntax
public class CMxBoolean : CMxCommon

CMxBoolean Property
The following is the property of the CMxBoolean class.
• Value Property

Value Property
Provides a property to get and set the value as a bool.
Syntax
public bool Value { get; set; }
Return Value
bool

CMxBoolean Constructors
The following are the constructors of the CMxBoolean class.
• CMxBoolean Constructor

• CMxBoolean Constructor (bool)

• CMxBoolean Constructor (SupportWrapper, string)

CMxBoolean Constructor
Provides a default constructor.
Syntax
public CMxBoolean();

CMxBoolean Constructor (bool)


Provides a constructor to initialize the class with a Boolean
default value.
Syntax
public CMxBoolean(bool v);
Parameter
v
[in] bool value to be set.

ArchestrA Object Toolkit Reference Guide


326 Chapter 1 Class Reference

CMxBoolean Constructor (SupportWrapper, string)


Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxBoolean(SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

CMxBoolean Method
The following is the method of the CMxBoolean class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxBoolean.
Syntax
public void Set(CMxBoolean val);
Parameter
val
[in] CMxBoolean value to be set.

CMxBoolean Operator Overloads


The following are the operator overloads of the CMxBoolean
class.
• CMxBoolean Operator Overload (bool)

• CMxValue Operator Overload

• bool Operator Overload

• CMxBoolean Operator Overload (CMxValue)

ArchestrA Object Toolkit Reference Guide


CMxBoolean Class 327

CMxBoolean Operator Overload (bool)


Provides an operator to convert a bool into a CMxBoolean.
Syntax
public static implicit operator CMxBoolean(bool x);
Parameter
x
[in] bool value to convert to CMxBoolean.
Return Value
CMxBoolean

CMxValue Operator Overload


Provides an operator to convert a CMxBoolean into a
CMxValue.
Syntax
public static implicit operator CMxValue(CMxBoolean
val);
Parameter
val
[in] CMxBoolean value to convert to CMxValue.
Return Value
CMxValue

bool Operator Overload


Provides an operator to convert a CMxBoolean into a bool.
Syntax
public static implicit operator bool(CMxBoolean val);
Parameter
val
[in] CMxBoolean value to convert to bool.
Return Value
bool

ArchestrA Object Toolkit Reference Guide


328 Chapter 1 Class Reference

CMxBoolean Operator Overload (CMxValue)


Provides an operator to convert a CMxValue into a
CMxBoolean.
Syntax
public static implicit operator CMxBoolean(CMxValue
val);
Parameter
val
[in] CMxValue value to convert to CMxBoolean.
Return Value
CMxBoolean

CMxBooleanArray Class
CMxBooleanArray is derived from CMxArray and provides
support for Boolean Array Attributes.
Syntax
public class CMxBooleanArray : CMxArray<bool>

CMxBooleanArray Properties
The following are the properties of the CMxBooleanArray
class.
• Value Property

• Property to Get and Set Bool Value using the [ ] operator

Value Property
Provides a property to get and set the value as a bool array.
Syntax
public bool[] Value { get; set; }
Return Value
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
public bool this[short i] { get; set; }
Return Value
bool

ArchestrA Object Toolkit Reference Guide


CMxBooleanArray Class 329

CMxBooleanArray Constructors
The following are the constructors of the CMxBooleanArray
class.
• CMxBooleanArray Constructor (int)

• CMxBooleanArray Constructor (bool[ ])

• CMxBooleanArray Constructor (SupportWrapper, string)

CMxBooleanArray Constructor (int)


Constructor that initializes the array to a default length.
Syntax
public CMxBooleanArray(int length);
Parameter
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
public CMxBooleanArray(bool[] value);
Parameter
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
public CMxBooleanArray (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

ArchestrA Object Toolkit Reference Guide


330 Chapter 1 Class Reference

CMxBooleanArray Method
The following is the method of the CMxBooleanArray class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxBooleanArray.
Syntax
public void Set(CMxBooleanArray newValue);
Parameter
newValue
[in] CMxBooleanArray value to be set.

CMxBooleanArray Operator Overloads


The following are the operator overloads of the
CMxBooleanArray class.
• CMxBooleanArray Operator Overload (bool[ ])

• CMxValue Operator Overload

• Bool[ ] Overload

• CMxBooleanArray Operator Overload (CMxValue)

CMxBooleanArray Operator Overload (bool[ ])


Provides an operator to convert a bool array into a
CMxBooleanArray.
Syntax
public static implicit operator CMxBooleanArray(bool[]
val);
Parameter
val
[in] bool [ ] value to convert to CMxBooleanArray.
Return Value
CMxBooleanArray

ArchestrA Object Toolkit Reference Guide


CMxBooleanArray Class 331

CMxValue Operator Overload


Provides an operator to convert a CMxBooleanArray into a
CMxValue.
Syntax
public static implicit operator
CMxValue(CMxBooleanArray val);
Parameter
val
[in] CMxBooleanArray value to convert to CMxValue.
Return Value
CMxValue

Bool[ ] Overload
Provides an operator to convert a CMxBooleanArray into a
bool array.
Syntax
public static implicit operator bool[](CMxBooleanArray
val);
Parameter
val
[in] CMxBooleanArray value to convert to bool[].
Return Value
bool[ ]

CMxBooleanArray Operator Overload (CMxValue)


Provides an operator to convert a CMxValue into a
CMxBooleanArray.
Syntax
static implicit operator CMxBooleanArray(CMxValue val);
Parameter
val
[in] CMxValue value to convert to CMxBooleanArray.
Return Value
CMxBooleanArray

ArchestrA Object Toolkit Reference Guide


332 Chapter 1 Class Reference

CMxFloat Class
CMxFloat is derived from CMxCommon and provides
support for float Attributes.
Syntax
public class CMxFloat : CMxCommon

CMxFloat Property
The following is the property of the CMxFloat class.
• Value Property

Value Property
Provides a property to get and set the value as a float.
Syntax
public float Value { get; set; }
Return Value
float

CMxFloat Constructors
The following are the constructors of the CMxFloat class.
• CMxFloat Constructor

• CMxFloat Constructor (float)

• CMxFloat Constructor (SupportWrapper, string)

CMxFloat Constructor
Provides a default constructor.
Syntax
public CMxFloat();

CMxFloat Constructor (float)


Provides a constructor to initialize the class with a float
default value.
Syntax
CMxFloat(float v);
Parameter
v
[in] float value to be set.

ArchestrA Object Toolkit Reference Guide


CMxFloat Class 333

CMxFloat Constructor (SupportWrapper, string)


Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxFloat(SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

CMxFloat Method
The following is the method of the CMxFloat class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxFloat.
Syntax
public void Set(CMxFloat val);
Parameter
val
[in] CMxFloat value to be set.

CMxFloat Operator Overloads


The following are the operator overloads of the CMxFloat
class.
• CMxFloat Operator Overload (float)

• CMxValue Operator Overload

• Float Operator Overload

• CMxFloat Operator Overload (CMxValue)

ArchestrA Object Toolkit Reference Guide


334 Chapter 1 Class Reference

CMxFloat Operator Overload (float)


Provides an operator to convert a float into a CMxFloat.
Syntax
public static implicit operator CMxFloat(float x);
Parameter
x
[in] float value to convert to CMxFloat.
Return Value
CMxFloat

CMxValue Operator Overload


Provides an operator to convert a CMxFloat into a
CMxValue.
Syntax
public static implicit operator CMxValue(CMxFloat val);
Parameter
val
[in] CMxFloat to convert to CMxValue.
Return Value
CMxValue

Float Operator Overload


Provides an operator to convert a CMxFloat into a float.
Syntax
public static implicit operator float(CMxFloat val);
Parameter
val
[in] CMxFloat to convert to float.
Return Value
float

CMxFloat Operator Overload (CMxValue)


Provides an operator to convert a CMxValue into a
CMxFloat.
Syntax
public static implicit operator CMxFloat(CMxValue val);
Parameter
val
[in] CMxValue value to convert to CMxFloat.
Return Value
CMxFloat

ArchestrA Object Toolkit Reference Guide


CMxFloatArray Class 335

CMxFloatArray Class
CMxFloatArray is derived from CMxArray and provides
support for float Array Attributes.
Syntax
public class CMxFloatArray : CMxArray<float>

CMxFloatArray Properties
The following are the properties of the CMxFloatArray class.
• Value Property

• Property to get and set using [ ] operator

Value Property
Provides a property to get and set the value as a float array.
Syntax
public float [] Value { get; set; }
Return Value
float [ ]

Property to get and set using [ ] operator


Provides a property to get and set the float value of an
element using [ ] operator.
Syntax
public float this[short i] { get; set; }
Return Value
float

CMxFloatArray Constructors
The following are the constructors of the CMxFloatArray
class.
• CMxFloatArray Constructor (int)

• CMxFloatArray Constructor (float[ ])

• CMxFloatArray Constructor (SupportWrapper, string)

ArchestrA Object Toolkit Reference Guide


336 Chapter 1 Class Reference

CMxFloatArray Constructor (int)


Provides a constructor to initialize the array to a default
length.
Syntax
public CMxFloatArray(int length);
Parameter
length
[in] integer value that holds array length.

CMxFloatArray Constructor (float[ ])


Provides a constructor to initialize the class with a float
array.
Syntax
public CMxFloatArray(float[] value);
Parameter
value
[in] float[ ] value.

CMxFloatArray Constructor (SupportWrapper, string)


Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxFloatArray (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

CMxFloatArray Method
The following is the method of the CMxFloatArray class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxFloat Array.
Syntax
public void Set(CMxFloatArray newValue);
Parameter
newValue
[in] CMxFloatArray value to be set.

ArchestrA Object Toolkit Reference Guide


CMxFloatArray Class 337

CMxFloatArray Operator Overloads


The following are the operator overloads of the
CMxFloatArray class.
• CMxFloatArray Operator Overload (float[ ])

• CMxValue Operator Overload

• Float Operator Overload

• CMxFloatArray Operator Overload (CMxValue)

CMxFloatArray Operator Overload (float[ ])


Provides an operator to convert a float array into a
CMxFloatArray.
Syntax
public static implicit operator CMxFloatArray(float[]
val);
Parameter
val
[in] float[ ] value to convert to CMxFloatArray.
Return Value
CMxFloatArray

CMxValue Operator Overload


Provides an operator to convert a CMxFloatArray into a
CMxValue.
Syntax
public static implicit operator CMxValue(CMxFloatArray
val);
Parameter
val
[in] CMxFloatArray value to convert to CMxValue.
Return Value
CMxValue

ArchestrA Object Toolkit Reference Guide


338 Chapter 1 Class Reference

Float Operator Overload


Provides an operator to convert a CMxFloatArray into a float
array.
Syntax
public static implicit operator float[](CMxFloatArray
val);
Parameter
val
[in] CMxFloatArray value to convert to float[].
Return Value
float[ ]

CMxFloatArray Operator Overload (CMxValue)


Provides an operator to convert a CMxValue into a
CMxFloatArray.
Syntax
public static implicit operator CMxFloatArray(CMxValue
val);
Parameter
val
[in] CMxValue value to convert to CMxFloatArray.
Return Value
CMxFloatArray

CMxDouble Class
CMxDouble is derived from CMxCommon and provides
support for Double Attributes.
Syntax
public class CMxDouble : CMxCommon

CMxDouble Property
The following is the property of the CMxDouble class.
• Value Property

Value Property
Provides a property to get and set the value as a double.
Syntax
public double Value { get; set; }
Return Value
double

ArchestrA Object Toolkit Reference Guide


CMxDouble Class 339

CMxDouble Constructors
The following are the constructors of the CMxDouble class.
• CMxDouble Constructor
• CMxDouble Constructor (double)

• CMxDouble Constructor (SupportWrapper, string)

CMxDouble Constructor
Provides a default constructor.
Syntax
public CMxDouble();

CMxDouble Constructor (double)


Provides a constructor to initialize the class with a double
default value.
Syntax
public CMxDouble (double v);
Parameter
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
public CMxDouble (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in]string value that holds attribute reference.

ArchestrA Object Toolkit Reference Guide


340 Chapter 1 Class Reference

CMxDouble Method
The following is the method of the CMxDouble class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxDouble.
Syntax
public void Set(CMxDouble val);
Parameter
val
[in] CMxDouble value to be set.

CMxDouble Operator Overloads


The following are the operator overloads of the CMxDouble
class.
• CMxDouble Operator Overload (double)

• CMxValue Operator Overload

• Double Operator Overload

• CMxDouble Operator Overload (CMxValue)

CMxDouble Operator Overload (double)


Provides an operator to convert a double into a CMxDouble.
Syntax
public static implicit operator CMxDouble(double x);
Parameter
x
[in] double value to convert to CMxDouble.
Return Value
CMxDouble

ArchestrA Object Toolkit Reference Guide


CMxDouble Class 341

CMxValue Operator Overload


Provides an operator to convert a CMxDouble into a
CMxValue.
Syntax
public static implicit operator CMxValue(CMxDouble
val);
Parameter
val
[in] CMxDouble value to convert to CMxValue.
Return Value
CMxValue

Double Operator Overload


Provides an operator to convert a CMxDouble into a double.
Syntax
public static implicit operator double (CMxDouble val);
Parameter
val
[in] CMxValue value to convert to double.
Return Value
double

CMxDouble Operator Overload (CMxValue)


Provides an operator to convert a CMxValue into a
CMxDouble.
Syntax
public static implicit operator CMxDouble (CMxValue
val);
Parameter
val
[in] CMxValue value to convert to CMxDouble.
Return Value
CMxDouble

ArchestrA Object Toolkit Reference Guide


342 Chapter 1 Class Reference

CMxDoubleArray Class
CMxDoubleArray is derived from CMxArray and provides
support for Double Array Attributes.
Syntax
public class CMxDoubleArray : CMxArray<double>

CMxDoubleArray Properties
The following are the properties of the CMxDoubleArray
class.
• Value Property
• Property to Get and Set Double Value using [ ] Operator

Value Property
Provides a property to get and set the value as a double
array.
Syntax
public double [] Value { get; set; }
Return Value
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
public double this[short i] { get; set; }
Return Value
double

CMxDoubleArray Constructors
The following are the constructors of the CMxDoubleArray
class.
• CMxDoubleArray Constructor (int)

• CMxDoubleArray Constructor (double[ ])

• CMxDoubleArray Constructor (SupportWrapper, string)

CMxDoubleArray Constructor (int)


Provides a constructor to initialize the array to a default
length.

ArchestrA Object Toolkit Reference Guide


CMxDoubleArray Class 343

Syntax
public CMxDoubleArray(int length);
Parameter
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
public CMxDoubleArray(double [] value);
Parameter
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
public CMxDoubleArray (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

CMxDoubleArray Method
The following is the method of the CMxDoubleArray class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxDoubleArray.
Syntax
public void Set(CMxDoubleArray newValue);
Parameter
newValue
[in] CMxDoubleArray value to be set.

ArchestrA Object Toolkit Reference Guide


344 Chapter 1 Class Reference

CMxDoubleArray Operator Overloads


The following are the operator overloads of the
CMxDoubleArray class.
• CMxDoubleArray Operator Overload (double[ ])

• CMxValue Operator Overload

• Double Operator Overload

• CMxDoubleArray Operator Overload (CMxValue)

CMxDoubleArray Operator Overload (double[ ])


Provides an operator to convert a double array into a
CMxDoubleArray.
Syntax
public static implicit operator CMxDoubleArray(double
[] val);
Parameter
val
[in] double [ ] value to convert to CMxDoubleArray.
Return Value
CMxDoubleArray

CMxValue Operator Overload


Provides an operator to convert a CMxDoubleArray into a
CMxValue.
Syntax
public static implicit operator CMxValue(CMxDoubleArray
val);
Parameter
val
[in] CMxDoubleArray value to convert to CMxValue.
Return Value
CMxValue

Double Operator Overload


Provides an operator to convert a CMxDoubleArray into a
double array.
Syntax
public static implicit operator double
[](CMxDoubleArray val);
Parameter
val
[in] CMxDoubleArray value to convert to double [].

ArchestrA Object Toolkit Reference Guide


CMxInteger Class 345

Return Value
double

CMxDoubleArray Operator Overload (CMxValue)


Provides an operator to convert a CMxValue into a
CMxDoubleArray.
Syntax
public static implicit operator CMxDoubleArray(CMxValue
val);
Parameter
val
[in] CMxValue value to convert to CMxDoubleArray.
Return Value
CMxDoubleArray

CMxInteger Class
CMxInteger is derived from CMxCommon and provides
support for Integer Attributes.
Syntax
public class CMxInteger : CMxCommon

CMxInteger Property
The following is the property of the CMxInteger class.
• Value Property

Value Property
Provides a property to get and set the value as an int.
Syntax
public int Value { get; set; }
Return Value
int

ArchestrA Object Toolkit Reference Guide


346 Chapter 1 Class Reference

CMxInteger Constructors
The following are the constructors of the CMxInteger class.
• CMxInteger Constructor
• CMxInteger Constructor (int)

• CMxInteger Constructor (SupportWrapper, string)

CMxInteger Constructor
Provides a default constructor.
Syntax
public CMxInteger();

CMxInteger Constructor (int)


Provides a constructor to initialize the class with an int.
Syntax
public CMxInteger (int v);
Parameter
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
public CMxInteger (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

ArchestrA Object Toolkit Reference Guide


CMxInteger Class 347

CMxInteger Method
The following is the method of the CMxInteger class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxInteger.
Syntax
public void Set(CMxInteger val);
Parameter
val
[in] CMxInteger value to be set.

CMxInteger Operator Overloads


The following are the operator overloads of the CMxInteger
class.
• CMxInteger Operator Overload (int)

• CMxValue Operator Overload

• int Operator Overload (CMxInteger)

• CMxInteger Operator Overload (CMxValue)

CMxInteger Operator Overload (int)


Provides an operator to convert an int into a CMxInteger.
Syntax
public static implicit operator CMxInteger(int x);
Parameter
x
[in] int value to convert to CMxInteger.
Return Value
CMxInteger

ArchestrA Object Toolkit Reference Guide


348 Chapter 1 Class Reference

CMxValue Operator Overload


Provides an operator to convert a CMxInteger into a
CMxValue.
Syntax
public static implicit operator CMxValue(CMxInteger
val);
Parameter
val
[in] CMxInteger value to convert to CMxValue.
Return Value
CMxValue

int Operator Overload (CMxInteger)


Conversion operator that converts from CMxInteger to int.
Syntax
public static implicit operator int (CMxInteger val);
Parameter
val
[i] CMxInteger value to convert to int.
Return Value
int

CMxInteger Operator Overload (CMxValue)


Provides an operator to convert a CMxValue into a
CMxInteger.
Syntax
public static implicit operator CMxInteger (CMxValue
val);
Parameter
val
[in] CMxValue value to convert to CMxInteger.
Return Value
CMxInteger

ArchestrA Object Toolkit Reference Guide


CMxIntegerArray Class 349

CMxIntegerArray Class
CMxIntegerArray is derived from CMxArray and provides
support for Integer Array Attributes.
Syntax
public class CMxIntegerArray : CMxArray<int>

CMxIntegerArray Properties
The following are the properties of the CMxIntegerArray
class.
• Value Property
• Property to Get and Set the Int Value using the [ ]
Operator

Value Property
Provides a property to get and set the value as an int array.
Syntax
public int Value { get; set; }
Return Value
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
public int this[short i] { get; set; }
Return Value
int

ArchestrA Object Toolkit Reference Guide


350 Chapter 1 Class Reference

CMxIntegerArray Constructors
The following are the constructors of the CMxIntegerArray
class.
• CMxIntegerArray Constructor (int)

• CMxIntegerArray Constructor (int[ ])

• CMxIntegerArray Constructor (SupportWrapper, string)

CMxIntegerArray Constructor (int)


Provides a constructor to initialize the array to a default
length.
Syntax
public CMxIntegerArray(int length);
Parameter
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
public CMxIntegerArray(int [] value);
Parameter
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
public CMxIntegerArray (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

ArchestrA Object Toolkit Reference Guide


CMxIntegerArray Class 351

CMxIntegerArray Method
The following is the method of the CMxIntegerArray class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxIntegerArray.
Syntax
public void Set(CMxIntegerArray newValue);
Parameter
newValue
[in] CMxIntegerArray instance value to be set.

CMxIntegerArray Operator Overloads


The following are the operator overloads of the
CMxIntegerArray class.
• CMxIntegerArray Operator Overload (int[ ])

• CMxValue Operator Overload

• int[ ] Operator Overload

• CMxIntegerArray Operator Overload (CMxValue)

CMxIntegerArray Operator Overload (int[ ])


Provides an operator to convert an int array into a
CMxInteger Array.
Syntax
public static implicit operator CMxIntegerArray(int []
val);
Parameter
val
[in] int [ ] value to convert to CMxIntegerArray.
Return Value
CMxIntegerArray

ArchestrA Object Toolkit Reference Guide


352 Chapter 1 Class Reference

CMxValue Operator Overload


Provides an operator to convert a CMxInteger Array into a
CMxValue.
Syntax
public static implicit operator
CMxValue(CMxIntegerArray val);
Parameter
val
[in] CMxIntegerArray to convert to CMxValue.
Return Value
CMxValue

int[ ] Operator Overload


Provides an operator to convert a CMxIntegerArray into an
int array.
Syntax
public static implicit operator int [](CMxIntegerArray
val);
Parameter
val
[in] CMxIntegerArray to convert to int [].
Return Value
int[ ]

CMxIntegerArray Operator Overload (CMxValue)


Provides an operator to convert a CMxValue into a
CMxIntegerArray.
Syntax
public static implicit operator
CMxIntegerArray(CMxValue val);
Parameter
val
[in] CMxValue to convert to CMxIntegerArray.
Return Value
CMxIntegerArray

ArchestrA Object Toolkit Reference Guide


CMxCustomEnum Class 353

CMxCustomEnum Class
CMxCustomEnum is derived from CMxCommon and
provides support for Enum Attributes.
Syntax
public class CMxCustomEnum : CMxCommon

CMxCustomEnum Properties
The following are the properties of the CMxCustomEnum
class.
• Value Property
• Text Property

Value Property
Provides a property to get and set the ordinal value as a
short.
Syntax
public short Value { get; set; }
Return Value
short

Text Property
Provides a property to get and set the text value as a string.
Syntax
public string Text { get; set; }
Return Value
string

ArchestrA Object Toolkit Reference Guide


354 Chapter 1 Class Reference

CMxCustomEnum Constructors
The following are the constructors of the CMxCustomEnum
class.
• CMxCustomEnum Constructor

• CMxCustomEnum Constructor (string, int)

• CMxCustomEnum Constructor (SupportWrapper, string)

• CMxCustomEnum Constructor (string, int, short)

CMxCustomEnum Constructor
Provides a default constructor.
Syntax
public CMxCustomEnum();

CMxCustomEnum Constructor (string, int)


Provides a constructor to initialize the class with the name of
an array and its depth relative to the owning object.
Syntax
public CMxCustomEnum(string arrayAttribute, int depth);
Parameters
arrayAttribute
[in] string value that holds the name of the string array
attribute.
depth
[in] int value that holds the depth of the string array
attribute primitive.

CMxCustomEnum Constructor (SupportWrapper,


string)
Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxCustomEnum(SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference name.

ArchestrA Object Toolkit Reference Guide


CMxCustomEnum Class 355

CMxCustomEnum Constructor (string, int, short)


Provides a constructor to initialize the class with the name of
an array, its depth relative to the owning object and the
default ordinal as a short.
Syntax
public CMxCustomEnum(string arrayAttribute, int depth,
short val);
Parameters
arrayAttribute
String value that holds the name of the referenced string
array attribute.
depth
Int value that holds the depth.
The depth assigned to the reference determines the location
of the String Array reference (0 represents the local
Primitive, -1 represents the Parent, -2 represents the
Parents Parent and so on.)
val
Short value that holds the value index.

CMxCustomEnum Method
The following is the method of the CMxCustomEnum class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxCustomEnum.
Syntax
public void Set(CMxCustomEnum val);
Parameter
val
[in] CMxCustomEnum instance value to be set.

ArchestrA Object Toolkit Reference Guide


356 Chapter 1 Class Reference

CMxCustomEnum Operator Overloads


The following are the operator overloads of the
CMxCustomEnum class.
• CMxValue Operator Overload

• Short Operator Overload

• CMxCustomEnum Operator Overload (CMxValue)

• CMxCustomEnum Operator Overload (short)

CMxValue Operator Overload


Provides an operator to convert a CMxCustomEnum into a
CMxValue
Syntax
public static implicit operator CMxValue(CMxCustomEnum
val);
Parameter
val
[in] CMxCustomEnum value to convert to CMxValue.
Return Value
CMxValue

Short Operator Overload


Provides an operator to convert a CMxCustomEnum into a
ordinal short.
Syntax
public static implicit operator short(CMxCustomEnum
val);
Parameter
val
[in] CMxCustomEnum value to convert to short.
Return Value
short

ArchestrA Object Toolkit Reference Guide


EnumText Class 357

CMxCustomEnum Operator Overload (CMxValue)


Provides an operator to convert a CMxValue into a
CMxCustomEnum.
Syntax
public static implicit operator CMxCustomEnum(CMxValue
val);
Parameter
val
[in] CMxValue value to convert to CMxCustomEnum.
Return Value
CMxCustomEnum

CMxCustomEnum Operator Overload (short)


Provides an operator to convert an ordinal short into a
CMxCustomEnum.
Syntax
public static implicit operator CMxCustomEnum(short x);
Parameter
x
[in] short value to convert to CMxCustomEnum.
Return Value
CMxCustomEnum

EnumText Class
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
public class EnumText

EnumText Property
The following is the property of the EnumText class.
• Property to get and set the value of an element of the
Enum Array

ArchestrA Object Toolkit Reference Guide


358 Chapter 1 Class Reference

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
public string this[short i] { get; set; }
Return Value
string

EnumText Method
The following is the method of the EnumText class.
• EnumText Constructor

EnumText Constructor
Provides a constructor that takes the owning
CMxCustomEnumArray.
Syntax
public EnumText(CMxCustomEnumArray _owner);
Parameter
_owner
[in] CMxCustomEnumArray value to be set.

CMxCustomEnumArray Class
CMxCustomEnumArray is derived from CMxArray and
provides support for Enum Array Attributes.
Syntax
public class CMxCustomEnumArray : CMxArray<short>

CMxCustomEnumArray Properties
The following are the properties of the
CMxCustomEnumArray class.
• Text Property

• Value Property

• Property to get and set the value of an ordinal

ArchestrA Object Toolkit Reference Guide


CMxCustomEnumArray Class 359

Text Property
Provides an EnumText to allow accessing elements as
strings.
Syntax
public EnumText Text;
Return Value
EnumText

Value Property
Provides a property to get and set the values of the ordinals
as a short array.
Syntax
public short[] Value { get; set; }
Return Value
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
public short this[short i] { get; set; }
Return Value
short

CMxCustomEnumArray Constructors
The following are the constructors of the
CMxCustomEnumArray class.
• CMxCustomEnumArray Constructor (string, int, short[ ])

• CMxCustomEnumArray Constructor (string, int, int)

• CMxCustomEnumArray Constructor (SupportWrapper,


string)

ArchestrA Object Toolkit Reference Guide


360 Chapter 1 Class Reference

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
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
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.

ArchestrA Object Toolkit Reference Guide


CMxCustomEnumArray Class 361

CMxCustomEnumArray Constructor
(SupportWrapper, string)
Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxCustomEnumArray(SupportWrapper _wrapper,
string _attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

CMxCustomEnumArray Methods
The following are the methods of the
CMxCustomEnumArray class.
• GetString Method

• SetString Method

• Set Method

GetString Method
Provides a method to get the value of an element from an
ordinal as a short.
Syntax
public string GetString(short i);
Parameter
i
[in] short value that holds the index.
Return Value
string

SetString Method
Provides a method to set the value of an element from a
string.
Syntax
public void SetString(short i, string value);
Parameters
i
[in] short value that holds the index.
value
[in] string value to be set.

ArchestrA Object Toolkit Reference Guide


362 Chapter 1 Class Reference

Set Method
Provides a method to set the value of the Attribute from a
CMxCustomEnumArray.
Syntax
public void Set(CMxCustomEnumArray newValue);
Parameter
newValue
[in] CMxCustomEnumArray value to be set.

CMxCustomEnumArray Operator Overloads


The following are the operator overloads of the
CMxCustomEnumArray class.
• CMxCustomEnumArray Operator Overload (short[ ])

• CMxValue Operator Overload

• Short Operator Overload

• CMxCustomEnumArray Operator Overload

CMxCustomEnumArray Operator Overload (short[ ])


Provides an operator to convert a short array into a
CMxCustomEnumArray.
Syntax
public static implicit operator
CMxCustomEnumArray(short[] val);
Parameter
val
[in] short[ ] value to convert to CMxCustomEnumArray.
Return Value
CMxCustomEnumArray

CMxValue Operator Overload


Provides an operator to convert a CMxCustomEnumArray
into CMxValue.
Syntax
public static implicit operator
CMxValue(CMxCustomEnumArray val);
Parameter
val
[in] CMxCustomEnumArray value to convert to CMxValue.
Return Value
CMxValue

ArchestrA Object Toolkit Reference Guide


CMxCustomStruct Class 363

Short Operator Overload


Provide an operator to convert a CMxCustomEnumArray
into a short array.
Syntax
public static implicit operator
short[](CMxCustomEnumArray val);
Parameter
val
[in] CMxCustomEnumArray value to convert to short[ ].
Return Value
short[ ]

CMxCustomEnumArray Operator Overload


Provides a operator to convert a CMxValue into a
CMxCustomEnumArray.
Syntax
public static implicit operator
CMxCustomEnumArray(CMxValue val);
Parameter
val
[in] CMxValue value to convert to CMxCustomEnumArray.
Return Value
CMxCustomEnumArray

CMxCustomStruct Class
CMxCustomStruct is derived from CMxCommon and
provides support for custom data in the form of a guid and
byte array.
Syntax
public class CMxCustomStruct : CMxCommon

CMxCustomStruct Property
The following is the property of the CMxCustomStruct class.
• Value Property

ArchestrA Object Toolkit Reference Guide


364 Chapter 1 Class Reference

Value Property
Provides a property to get and set the value as an
MxCustomStruct.
Syntax
public MxCustomStruct Value { get; set; }
Return Value
MxCustomStruct

CMxCustomStruct Constructors
The following are the constructors of the CMxCustomStruct
class.
• CMxCustomStruct Constructor

• CMxCustomStruct Constructor (int)

• CMxCustomStruct Constructor (SupportWrapper, string)

CMxCustomStruct Constructor
Provides a default constructor.
Syntax
public CMxCustomStruct();

CMxCustomStruct Constructor (int)


Provides a constructor to initialize struct with an ID.
Syntax
public CMxCustomStruct(int id);
Parameter
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
public CMxCustomStruct(SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

ArchestrA Object Toolkit Reference Guide


CMxCustomStruct Class 365

CMxCustomStruct Method
The following are the methods of the CMxCustomStruct
class.
• GetObject Method

• StoreObject Method

• Set Method

GetObject Method
Provides a method to retrieve a serialized C# object from the
data in a CMxCustomStruct.
Syntax
public object GetObject();
Return Value
object

StoreObject Method
Provides a method to serialize and store a C# object into the
data of a CMxCustomStruct.
Syntax
public void StoreObject(object obj);
Parameter
obj
[in] C# object to be stored.

Set Method
Provides a method to set the value of the Attribute from a
CMxCustomStruct.
Syntax
public void Set(CMxCustomStruct val);
Parameter
val
[in] CMxCustomStruct value to be set.

ArchestrA Object Toolkit Reference Guide


366 Chapter 1 Class Reference

CMxCustomStruct Operator Overloads


The following are the operator overloads of the
CMxCustomStruct class.
• CMxValue Operator Overload

• MxCustomStruct Operator Overload

• CMxCustomStruct Operator Overload (CMxValue)

• CMxCustomStruct Operator Overload (MxCustomStruct)

CMxValue Operator Overload


Provides an operator to convert a CMxCustomStruct into a
CMxValue.
Syntax
public static implicit operator
CMxValue(CMxCustomStruct val);
Parameter
val
[in] CMxCustomStruct value to convert to CMxValue.
Return Value
CMxValue

MxCustomStruct Operator Overload


Provides an operator to convert a CMxCustomStruct into a
MxCustomStruct.
Syntax
public static implicit operator
MxCustomStruct(CMxCustomStruct val);
Parameter
val
[in] CMxCustomStruct value to convert to
MxCustomStruct.
Return Value
MxCustomStruct

ArchestrA Object Toolkit Reference Guide


CMxCustomStructArray Class 367

CMxCustomStruct Operator Overload (CMxValue)


Provides an operator to convert a CMxValue into a
CMxCustomStruct.
Syntax
public static implicit operator
CMxCustomStruct(CMxValue val);
Parameter
val
[in] CMxValue value to convert to CMxCustomStruct.
Return Value
CMxCustomStruct

CMxCustomStruct Operator Overload


(MxCustomStruct)
Provides an operator to convert a MxCustomStruct into a
CMxCustomStruct.
Syntax
public static implicit operator
CMxCustomStruct(MxCustomStruct x);
Parameter
x
[in] MxCustomStruct value to convert to
CMxCustomStruct.
Return Value
CMxCustomStruct

CMxCustomStructArray Class
CMxCustomStructArray is derived from CMxArray and
provides support for an array of custom data in the form of a
guid and byte array.
Syntax
public class CMxCustomStructArray :
CMxArray<MxCustomStruct>

ArchestrA Object Toolkit Reference Guide


368 Chapter 1 Class Reference

CMxCustomStructArray Properties
The following are the properties of the
CMxCustomStructArray class.
• Value Property

• Property to get and set value as a MxCustomStruct

Value Property
Provides a property to get and set the value as an
MxCustomStruct array.
Syntax
public MxCustomStruct[] Value { get; set; }
Return Value
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
public MxCustomStruct this[short i] { get; set; }
Return Value
MxCustomStruct

CMxCustomStructArray Constructors
The following are the constructors of the
CMxCustomStructArray class.
• CMxCustomStructArray Constructor (int)

• CMxCustomStructArray Constructor (int, int)

• CMxCustomStructArray Constructor
(MxCustomStruct[ ])

• CMxCustomStructArray Constructor (SupportWrapper,


string)

CMxCustomStructArray Constructor (int)


Provides a constructor to initialize the CustomStructArray
with a length.
Syntax
public CMxCustomStructArray(int length);
Parameter
length
[in] int value that holds the length of the array.

ArchestrA Object Toolkit Reference Guide


CMxCustomStructArray Class 369

CMxCustomStructArray Constructor (int, int)


Provides a constructor to initialize CustomStructArray with
an ID and length.
Syntax
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
public CMxCustomStructArray(MxCustomStruct[] value);
Parameter
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
public CMxCustomStruct(SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

ArchestrA Object Toolkit Reference Guide


370 Chapter 1 Class Reference

CMxCustomStructArray Method
The following is the method of the CMxCustomStructArray
class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxCustomStructArray.
Syntax
public void Set(CMxCustomStructArray newValue);’
Parameter
newValue
[in] CMxCustomStructArray value to be set.

CMxCustomStructArray Operator Overloads


The following are the operator overloads of the
CMxCustomStructArray class.
• CMxValue Operator Overload

• MxCustomStruct [ ]Operator Overload

• CMxCustomStructArray Operator Overload

• CMxCustomStructArray Operator Overload

CMxValue Operator Overload


Provides an operator to convert a CMxCustomStructArray
into a CMxValue.
Syntax
public static implicit operator
CMxValue(CMxCustomStructArray val);
Parameter
val
[in] CMxCustomStructArray value to convert to CMxValue.
Return Value
CMxValue

MxCustomStruct [ ]Operator Overload


Provides an operator to convert a CMxCustomStructArray
into a MxCustomStruct array.
Syntax
public static implicit operator MxCustomStruct[]
(CMxCustomStructArray val);

ArchestrA Object Toolkit Reference Guide


CMxCustomStructArray Class 371

Parameter
val
[in] CMxCustomStructArray value to convert to
MxCustomStruct[ ].
Return Value
MxCustomStruct[ ]

CMxCustomStructArray Operator Overload


Provides an operator to convert a CMxValue into a
CMxCustomStructArray.
Syntax
public static implicit operator
CMxCustomStructArray(CMxValue val);
Parameter
val
[in] CMxValue value to convert to CMxCustomStructArray.
Return Value
CMxCustomStructArray

CMxCustomStructArray Operator Overload


Provides an operator to convert a MxCustomStruct array
into a CMxCustomStructArray.
Syntax
public static implicit operator
CMxCustomStructArray(MxCustomStruct[] val);
Parameter
val
[in] MxCustomStruct[ ] value to convert to
CMxCustomStructArray.
Return Value
CMxCustomStructArray

ArchestrA Object Toolkit Reference Guide


372 Chapter 1 Class Reference

CMxDataType Class
CMxDataType is derived from CMxCommon and provides
support for MxDataType Attributes.
Syntax
public class CMxDataType : CMxCommon

CMxDataType Property
The following is the property of the CMxDataType class.
• Value Property

Value Property
Provides a property to get and set the value as an
MxDataType.
Syntax
public MxDataType Value { get; set; }
Return Value
MxDataType

CMxDataType Constructors
The following are the constructors of the CMxDataType
class.
• CMxDataType Constructor

• CMxDataType Constructor (MxDataType)

• CMxDataType Constructor (SupportWrapper, string)

CMxDataType Constructor
Provides a default constructor.
Syntax
public CMxDataType();

CMxDataType Constructor (MxDataType)


Provides a constructor to initialize the class with a
MxDataType default value.
Syntax
public CMxDataType (MxDataType v);
Parameter
v
[in] MxDataType value to be set.

ArchestrA Object Toolkit Reference Guide


CMxDataType Class 373

CMxDataType Constructor (SupportWrapper, string)


Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxDataType (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
SupportWrapper.
_attributeRef
string value that holds the attribute reference.

CMxDataType Method
The following are the methods of the CMxDataType class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxDataType.
Syntax
public void Set(CMxDataType val);
Parameter
val
[in] CMxDataType value to be set

CMxDataType Operator Overloads


The following are the operator overloads of the
CMxDataType class.
• CMxDataType Operator Overload (MxDataType)

• CMxValue Operator Overload

• MxDataType Operator Overload

• CMxDataType Operator Overload (CMxValue)

ArchestrA Object Toolkit Reference Guide


374 Chapter 1 Class Reference

CMxDataType Operator Overload (MxDataType)


Provides an operator to convert a MxDataType into a
CMxDataType.
Syntax
public static implicit operator CMxDataType(MxDataType
x);
Parameter
x
[in] MxDataType value to convert to CMxDataType.
Return Value
CMxDataType

CMxValue Operator Overload


Provides an operator to convert a CMxDataType into a
CMxValue.
Syntax
public static implicit operator CMxValue(CMxDataType
val);
Parameter
val
[in] CMxDataType value to convert to CMxValue.
Return Value
CMxValue

MxDataType Operator Overload


Provides an operator to convert a CMxDataType into a
MxDataType.
Syntax
public static implicit operator MxDataType(CMxDataType
val);
Parameter
val
[in] CMxDataType value to convert to MxDataType.
Return Value
MxDataType

ArchestrA Object Toolkit Reference Guide


CMxDataTypeArray Class 375

CMxDataType Operator Overload (CMxValue)


Provides an operator to convert a CMxValue into a
CMxDataType.
Syntax
public static implicit operator CMxDataType(CMxValue
val);
Parameter
val
[in] CMxValue value to convert to CMxDataType.

CMxDataTypeArray Class
CMxDataTypeArray is derived from CMxArray and provides
support for MxDataType Array Attributes.
Syntax
public class CMxDataTypeArray : CMxArray<MxDataType>

CMxDataTypeArray Properties
The following are the properties of the CMxDataTypeArray
class.
• Value Property

• Property to Get and Set the MxDatatype using the [ ]


Operator

Value Property
Provides a property to get and set the value as a
MxDataType array.
Syntax
public MxDataType[] Value { get; set; }
Return Value
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
public MxDataType this[short i] { get; set; }
Return Value
MxDataType

ArchestrA Object Toolkit Reference Guide


376 Chapter 1 Class Reference

CMxDataTypeArray Constructors
The following are the constructors of the CMxDataTypeArray
class.
• CMxDataTypeArray Constructor (int)

• CMxDataTypeArray Constructor (MxDataType[ ])

• CMxDataTypeArray Constructor (SupportWrapper,


string)

CMxDataTypeArray Constructor (int)


Provides a constructor to initialize the array to a default
length.
Syntax
public CMxDataTypeArray(int length);
Parameter
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
public CMxDataTypeArray (MxDataType[] value);
Parameter
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
public CMxDataTypeArray (SupportWrapper _wrapper,
string _attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

ArchestrA Object Toolkit Reference Guide


CMxDataTypeArray Class 377

CMxDataTypeArray Method
The following are the methods of the CMxDataTypeArray
class.
• CMxDataTypeArray Constructor (SupportWrapper,
string)

Set Method
Provides a method to set the value of the Attribute from a
CMxDataTypeArray.
Syntax
public void Set(CMxDataTypeArray newValue);
Parameter
newValue
[in] CMxDataTypeArray value to be set

CMxDataTypeArray Operator Overloads


The following are the operator overloads of the
CMxDataTypeArray class.
• CMxDataTypeArray Operator Overload (MxDataType[ ])

• CMxValue Operator Overload

• MxDataType Operator Overload

• CMxDataTypeArray Operator Overload (CMxValue)

CMxDataTypeArray Operator Overload


(MxDataType[ ])
Provides a operator to convert a MxDataType array into a
CMxDataTypeArray.
Syntax
public static implicit operator
CMxDataTypeArray(MxDataType[] val);
Parameter
val
[in] MxDataType[ ] value to convert to CMxDataTypeArray.
Return Value
CMxDataTypeArray

ArchestrA Object Toolkit Reference Guide


378 Chapter 1 Class Reference

CMxValue Operator Overload


Provides an operator to convert a CMxDataTypeArray into a
CMxValue.
Syntax
public static implicit operator
CMxValue(CMxDataTypeArray val);
Parameter
val
[in] CMxDataTypeArray value to convert to CMxValue.
Return Value
CMxValue

MxDataType Operator Overload


Provides an operator to convert a CMxDataTypeArray into a
MxDataType array.
Syntax
public static implicit operator
MxDataType[](CMxDataTypeArray val);
Parameter
val
[in] CMxDataTypeArray value to convert to MxDataType[ ].
Return Value
MxDataType[ ]

CMxDataTypeArray Operator Overload (CMxValue)


Provides an operator to convert a CMxValue into a
CMxDataTypeArray.
Syntax
public static implicit operator CMxDataTypeArray
(CMxValue val);
Parameter
val
CMxDataTypeArray
Return Value
[in] CMxValue value to convert to DataTypeArray.

ArchestrA Object Toolkit Reference Guide


CMxElapsedTime Class 379

CMxElapsedTime Class
CMxElapsedTime is derived from CMxCommon and provides
support for Elapsed time/Timespan Attributes.
Syntax
public class CMxElapsedTime : CMxCommon

CMxElapsedTime Property
The following is the property of the CMxElapsedTime class.
• Value Property

Value Property
Provides a property to get and set the value as a TimeSpan.
Syntax
public TimeSpan Value { get; set; }
Return Value
TimeSpan

CMxElapsedTime Constructors
The following are the constructors of the CMxElapsedTime
class.
• CMxElapsedTime Constructor

• CMxElapsedTime Constructor (TimeSpan)

• CMxElapsedTime Constructor (string)

• CMxElapsedTime Constructor (SupportWrapper, string)

CMxElapsedTime Constructor
Provides a default constructor.
Syntax
public CMxElapsedTime();

CMxElapsedTime Constructor (TimeSpan)


Provides a constructor to initialize the class with a TimeSpan
default value.
Syntax
public CMxElapsedTime (TimeSpan v);
Parameter
v
[in] TimeSpan value to be set.

ArchestrA Object Toolkit Reference Guide


380 Chapter 1 Class Reference

CMxElapsedTime Constructor (string)


Provides a constructor to initialize the class with a formatted
time string default value.
Syntax
public CMxElapsedTime(string timeString);
Parameter
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
public CMxElapsedTime (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

CMxElapsedTime Method
The following is the method of the CMxElapsedTime class.
• Set Method

Set Method
Sets the value of the Attribute from a CMxElapsedTime.
Syntax
public void Set(CMxElapsedTime val);
Parameter
val
[in] CMxElapsedTime value to be set.

ArchestrA Object Toolkit Reference Guide


CMxElapsedTime Class 381

CMxElapsedTime Operator Overloads


The following are the operator overloads of the
CMxElapsedTime class.
• CMxElapsedTime Operator Overload (TimeSpan)

• CMxValue Operator Overload

• TimeSpan Operator Overload

• CMxElapsedTime Operator Overload (CMxValue)

• - Operator Overload (CMxElapsedTime)

• - Operator Overload (CMxElapsedTime, TimeSpan)

• != Operator Overload

• + Operator Overload (CMxElapsedTime)

• + Operator Overload (CMxElapsedTime, TimeSpan)

• < Operator Overload

• <= Operator Overload

• == Operator Overload

• > Operator Overload

• >= Operator Overload

CMxElapsedTime Operator Overload (TimeSpan)


Provides an operator to convert a MxDataType into a
CMxElapsedTime.
Syntax
public static implicit operator CMxElapsedTime(TimeSpan
x);
Parameter
x
[in] TimeSpan value to convert to CMxElapsedTime.
Return Value
CMxElapsedTime

ArchestrA Object Toolkit Reference Guide


382 Chapter 1 Class Reference

CMxValue Operator Overload


Provides an operator to convert a CMxElapsedTime into a
CMxValue.
Syntax
public static implicit operator CMxValue(CMxElapsedTime
val);
Parameter
val
[in] CMxElapsedTime value to convert to CMxValue.
Return Value
CMxValue

TimeSpan Operator Overload


Provides an operator to convert a CMxElapsedTime into a
MxDataType.
Syntax
public static implicit operator TimeSpan
(CMxElapsedTime val);
Parameter
val
[in] CMxElapsedTime value to convert to TimeSpan.
Return Value
TimeSpan

CMxElapsedTime Operator Overload (CMxValue)


Provides an operator to convert a CMxValue into a
CMxElapsedTime.
Syntax
public static implicit operator CMxElapsedTime
(CMxValue val);
Parameter
val
[in] CMxValue value to convert to CMxElapsedTime.
Return Value
CMxElapsedTime

ArchestrA Object Toolkit Reference Guide


CMxElapsedTime Class 383

- Operator Overload (CMxElapsedTime)


Provides an operator to subtract a CMxElapsedTime from a
CMxElapsedTime.
Syntax
public static TimeSpan operator -(CMxElapsedTime t);
Parameter
t
[in] CMxElapsedTime value.
Return Value
TimeSpan

- Operator Overload (CMxElapsedTime, TimeSpan)


Provides an operator to subtract a TimeSpan from a
CMxElapsedTime.
Syntax
public static TimeSpan operator -(CMxElapsedTime t1,
TimeSpan t2);
Parameters
t1
[in] CMxElapsedTime value.
t2
[in] TimeSpan value.
Return Value
TimeSpan

!= Operator Overload
Provides an operator to compare a CMxElapsedtime with a
TimeSpan.
Syntax
public static bool operator !=(CMxElapsedTime t1,
TimeSpan t2);
Parameters
t1
[in] CMxElapsedTime value.
t2
[in] TimeSpan value.
Return Value
bool

ArchestrA Object Toolkit Reference Guide


384 Chapter 1 Class Reference

+ Operator Overload (CMxElapsedTime)


Provides an operator to add a CMxElapsedTime to a
TimeSpan.
Syntax
public static TimeSpan operator +(CMxElapsedTime t);
Parameter
t
[in] CMxElapsedTime value.
Return Value
TimeSpan

+ Operator Overload (CMxElapsedTime, TimeSpan)


Provides an operator to add a TimeSpan to a
CMxElapsedTime.
Syntax
public static TimeSpan operator +(CMxElapsedTime t,
TimeSpan ts);
Parameters
t
[in] CMxElapsedTime value.
ts
[in] TimeSpan value.
Return Value
TimeSpan

< Operator Overload


Provides an operator to test if a CMxElapsedTime is less
than a TimeSpan.
Syntax
public static bool operator <(CMxElapsedTime t1,
TimeSpan t2);
Parameters
t1
[in] CMxElapsedTime value.
t2
[in] TimeSpan.
Return Value
bool

ArchestrA Object Toolkit Reference Guide


CMxElapsedTime Class 385

<= Operator Overload


Provides an operator to test if a CMxElapsedTime is less
than or equal to a TimeSpan.
Syntax
public static bool operator <=(CMxElapsedTime t1,
TimeSpan t2);
Parameters
t1
[in] CMxElapsedTime value.
t2
[in] TimeSpan value.
Return Value
bool

== Operator Overload
Provides an operator to test if a CMxElapsedTime and a
TimeSpan are equal.
Syntax
public static bool operator ==(CMxElapsedTime t1,
TimeSpan t2);
Parameters
t1
[in] CMxElapsedTime value.
t2
[in] TimeSpan value.
Return Value
bool

> Operator Overload


Provides an operator to test if a CMxElapsedTime is greater
than a TimeSpan.
Syntax
public static bool operator >(CMxElapsedTime t1,
TimeSpan t2);
Parameters
t1
[in] CMxElapsedTime value.
t2
[in] TimeSpan value.
Return Value
bool

ArchestrA Object Toolkit Reference Guide


386 Chapter 1 Class Reference

>= Operator Overload


Provides an operator to test if a CMxElapsedTime is greater
than or equal to a TimeSpan.
Syntax
public static bool operator >=(CMxElapsedTime t1,
TimeSpan t2);
Parameters
t1
[in] CMxElapsedTime value.
t2
[in] TimeSpan value.
Return Value
bool

CMxElapsedTimeArray Class
CMxElapsedTimeArray is derived from CMxArray and
provides support for Elapsed time/Timespan Array
Attributes.
Syntax
public class CMxElapsedTimeArray : CMxArray<TimeSpan>

CMxElapsedTimeArray Properties
The following are the properties of the
CMxElapsedTimeArray class.
• Value Property

• Property to Get and Set the TimeSpan Value using the [ ]


Operator

Value Property
Provides a property to get and set the value as a TimeSpan
array.
Syntax
public TimeSpan[] Value { get; set; }
Return Value
TimeSpan[ ]

ArchestrA Object Toolkit Reference Guide


CMxElapsedTimeArray Class 387

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
public TimeSpan this[short i] { get; set; }
Return Value
TimeSpan

CMxElapsedTimeArray Constructors
The following are the constructors of the
CMxElapsedTimeArray class.
• CMxElapsedTimeArray Constructor (int)
• CMxElapsedTimeArray Constructor (TimeSpan)

• CMxElapsedTimeArray Constructor (string)

• CMxElapsedTimeArray Constructor

CMxElapsedTimeArray Constructor (int)


Provides a constructor to initialize the array to a default
length.
Syntax
public CMxElapsedTimeArray(int length);
Parameter
length
[in] int value that holds the array length.

CMxElapsedTimeArray Constructor (TimeSpan)


Provide a constructor to initialize the class with a TimeSpan
array.
Syntax
public CMxElapsedTimeArray (TimeSpan[] value);
Parameter
value
[in] TimeSpan[ ] value to be set.

ArchestrA Object Toolkit Reference Guide


388 Chapter 1 Class Reference

CMxElapsedTimeArray Constructor (string)


Provides a constructor to initialize the class with a formatted
time string array.
Syntax
public CMxElapsedTimeArray (string[] value);
Parameter
value
[in] string[ ] value to be set.

CMxElapsedTimeArray Constructor
Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxElapsedTimeArray (SupportWrapper _wrapper,
string _attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string that holds the attribute reference.

CMxElapsedTimeArray Method
The following is the method of the CMxElapsedTimeArray
class.
• Set Method

Set Method
Sets the value of the Attribute from a
CMxElapsedTimeArray.
Syntax
public void Set(CMxElapsedTimeArray newValue);
Parameter
newValue
[in] CMxElapsedTimeArray value to be set.

ArchestrA Object Toolkit Reference Guide


CMxElapsedTimeArray Class 389

CMxElapsedTimeArray Operator Overloads


The following are the operator overloads of the
CMxElapsedTimeArray class.
• CMxElapsedTimeArray Operator Overload (TimeSpan)

• CMxValue Operator Overload

• TimeSpan Operator Overload

• CMxElapsedTimeArray Operator Overload (CMxValue)

CMxElapsedTimeArray Operator Overload


(TimeSpan)
Provides an operator to convert a TimeSpan array into a
CMxElapsedTimeArray.
Syntax
public static implicit operator
CMxElapsedTimeArray(TimeSpan[] val);
Parameter
val
[in] TimeSpan[ ] value to convert to
CMxElapsedTimeArray.
Return Value
CMxElapsedTimeArray

CMxValue Operator Overload


Provides an operator to convert a CMxElapsedTimeArray
into a CMxValue.
Syntax
public static implicit operator
CMxValue(CMxElapsedTimeArray val);
Parameter
val
[in] CMxElapsedTimeArray value to convert to CMxValue.
Return Value
CMxValue

ArchestrA Object Toolkit Reference Guide


390 Chapter 1 Class Reference

TimeSpan Operator Overload


Provides an operator to convert a CMxElapsedTimeArray
into a TimeSpan array.
Syntax
public static implicit operator
TimeSpan[](CMxElapsedTimeArray val);
Parameter
val
[in] CMxElapsedTimeArray value to convert to
TimeSpan[ ].
Return Value
TimeSpan[ ]

CMxElapsedTimeArray Operator Overload (CMxValue)


Provides an operator to convert a CMxValue into a
CMxElapsedTimeArray.
Syntax
public static implicit operator CMxElapsedTimeArray
(CMxValue val);
Parameter
val
[in] CMxValue value to convert to CMxElapsedTimeArray.
Return Value
CMxElapsedTimeArray

CMxInternationalizedString Class
CMxInternationalizedString is derived from CMxCommon
and provides support for Internationalized string Attributes.
Syntax
public class CMxInternationalizedString : CMxCommon

CMxInternationalizedString Properties
The following are the properties of the
CMxInternationalizedString class.
• Value Property

• Locale Property

ArchestrA Object Toolkit Reference Guide


CMxInternationalizedString Class 391

Value Property
Provides a property to get and set the value as an
MxDataType.
Syntax
public MxDataType Value { get; set; }
Return Value
MxDataType

Locale Property
Provides a method return a string of the default value.
Syntax
public int Locale { get; set; }
Return Value
int

CMxInternationalizedString Constructors
The following are the constructors of the
CMxInternationalizedString class.
• CMxInternationalizedString Constructor

• CMxInternationalizedString Constructor CMxValue

• CMxInternationalizedString Constructor string

• CMxInternationalizedString Constructor
SupportWrapper, string

CMxInternationalizedString Constructor
Provides a default constructor.
Syntax
public CMxInternationalizedString ();

CMxInternationalizedString Constructor CMxValue


Provides a constructor that initializes the class with a
CMxValue default Value.
Syntax
public CMxInternationalizedString (CMxValue v);
Parameter
v
[in] CMxValue instance value.

ArchestrA Object Toolkit Reference Guide


392 Chapter 1 Class Reference

CMxInternationalizedString Constructor string


Provides a constructor that initializes the class with a string
default Value.
Syntax
public CMxInternationalizedString (string v);
Parameter
v
[in] string value.

CMxInternationalizedString Constructor
SupportWrapper, string
Provides a constructor that initializes the class for use in a
primitive wrapper.
Syntax
public CMxInternationalizedString (SupportWrapper
_wrapper, string _attributeRef);
Parameters
_wrapper
[in] SupportWrapper
_attributeRef
[in] string value that holds the attribute reference.

CMxInternationalizedString Methods
The following are the methods of the
CMxInternationalizedString class.
• GetString Method

• SetString Method

• Set Method

GetString Method
Provides a method to get the value of the Attribute for a
specified locale.
Syntax
public string GetString(int _locale);
Parameter
Locale
[in] int value that holds the locale.
Return Value
string

ArchestrA Object Toolkit Reference Guide


CMxInternationalizedString Class 393

SetString Method
Provides a method to set the value of the Attribute for a
specified locale.
Syntax
public void SetString(int _locale, string val);
Parameter
Locale
[in] int value that holds the locale to be set.

Set Method
Provides a method to set the value of the Attribute from a
CMxInternationalizedString.
Syntax
public void Set(CMxInternationalizedString newValue);
Parameter
newValue
[in] CMxInternationalizedString value to be set.

CMxInternationalizedString Operator
Overloads
The following are the operator overloads of the
CMxInternationalizedString class.
• CMxValue Operator Overload

• CMxString Operator Overload

• string operator Overload


• CMxInternationalizedString Operator Overload
CMxString

• CMxInternationalizedString Operator Overload


CMxValue
• CMxInternationalizedString Operator Overload string

ArchestrA Object Toolkit Reference Guide


394 Chapter 1 Class Reference

CMxValue Operator Overload


Provides an operator that converts from
CMxInternationalizedString to CMxValue.
Syntax
public static implicit operator
CMxValue(CMxInternationalizedString val);
Parameter
val
[in] CMxInternationalizedString instance.
Return Value
CMxValue

CMxString Operator Overload


Provides an operator that converts from
CMxInternationalizedString to CMxString.
Syntax
public static implicit operator
CMxString(CMxInternationalizedString val);
Parameter
val
[in] CMxInternationalizedString instance.
Return Value
CMxString

string operator Overload


Provides an operator that converts from
CMxInternationalizedString to string.
Syntax
public static implicit operator
string(CMxInternationalizedString val);
Parameter
val
[in] CMxInternationalizedString instance value.
Return Value
string

ArchestrA Object Toolkit Reference Guide


CMxInternationalizedString Class 395

CMxInternationalizedString Operator Overload


CMxString
Provides an operator that converts from CMxString to
CMxInternationalizedString.
Syntax
public static implicit operator
CMxInternationalizedString(CMxString val);
Parameter
val
[in] CMxString instance value.
Return Value
CMxInternationalizedString

CMxInternationalizedString Operator Overload


CMxValue
Provides an operator that converts from CMxValue to
CMxInternationalizedString.
Syntax
public static implicit operator
CMxInternationalizedString(CMxValue val);
Parameter
val
[in] CMxValue value.
Return Value
CMxInternationalizedString

CMxInternationalizedString Operator Overload string


Provides an operator that converts from string to
CMxInternationalizedString.
Syntax
public static implicit operator
CMxInternationalizedString(string x);
Parameter
x
[in] string.
Return Value
CMxInternationalizedString

ArchestrA Object Toolkit Reference Guide


396 Chapter 1 Class Reference

CMxInternationalizedStringArray Class
CMxInternationalizedStringArray is derived from CMxArray
and provides support for Arrays of Internationalized Strings.
Syntax
public class CMxInternationalizedStringArray :
CMxArray<string>

CMxInternationalizedStringArray Properties
The following are the properties of the
CMxInternationalizedStringArray class.
• Locale Property

• Value Property

• Property to get and set current locale as a string

Locale Property
Provides a property to gets or set the current locale.
Syntax
public int Locale { get; set; }
Return Value
int

Value Property
Provides a property to get and set the value of the current
locale as an array of strings.
Syntax
public string[] Value { get; set; }
Return Value
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
public string this[short i] { get; set; }
Return Value
string

ArchestrA Object Toolkit Reference Guide


CMxInternationalizedStringArray Class 397

CMxInternationalizedStringArray Constructors
The following are the constructors of the
CMxInternationalizedStringArray class.
• CMxInternationalizedStringArray Constructor int

• CMxInternationalizedStringArray Constructor string[]

• CMxInternationalizedStringArray Constructor
SupportWrapper, string

CMxInternationalizedStringArray Constructor int


Provides a constructor to initialize the array to a default
length.
Syntax
public CMxInternationalizedStringArray(int length);
Parameter
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
public CMxInternationalizedStringArray(string[] value);
Parameter
value
[in] string[ ].

CMxInternationalizedStringArray Constructor
SupportWrapper, string
Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxInternationalizedStringArray(SupportWrapper
_wrapper, string _attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

ArchestrA Object Toolkit Reference Guide


398 Chapter 1 Class Reference

CMxInternationalizedStringArray Methods
The following are the methods of the
CMxInternationalizedStringArray class.
• GetString Method

• GetStrings Method

• SetString Method

• Set Method

GetString Method
Provides a method to get the value of an element by locale.
Syntax
public string GetString(short index, int _locale);
Parameter
index
[in] index of the element.
locale
[in] int value that holds the locale.
Return Value
string

GetStrings Method
Provides a method to get the value of all elements by locale.
Syntax
public string[] GetStrings(int _locale);
Parameter
locale
[in] Int value that holds the locale.
Return Value
string[ ]

ArchestrA Object Toolkit Reference Guide


CMxInternationalizedStringArray Class 399

SetString Method
Provides a method to set the value of a element by locale.
Syntax
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
public void Set(CMxInternationalizedStringArray
newValue);
Parameter
val
[in] CMxInternationalizedStringArray value to be set.

CMxInternationalizedStringArray Operator
Overloads
The following are the operator overloads of the
CMxInternationalizedStringArray class.
• string[ ] Operator Overload

• CMxValue Operator Overload


• CMxStringArray Operator Overload

• CMxInternationalizedStringArray Operator Overload


CMxStringArray

• CMxInternationalizedStringArray Operator Overload


CMxValue
• CMxInternationalizedStringArray Operator Overload
string[ ]

ArchestrA Object Toolkit Reference Guide


400 Chapter 1 Class Reference

string[ ] Operator Overload


Provides an operator that converts from
CMxInternationalizedStringArray to string array.
Syntax
public static implicit operator
string[](CMxInternationalizedStringArray val);
Parameter
val
[in] CMxInternationalizedStringArray instance value.
Return Value
string[ ]

CMxValue Operator Overload


Provides an operator that converts from
CMxInternationalizedStringArray to CMxValue.
Syntax
public static implicit operator
CMxValue(CMxInternationalizedStringArray val);
Parameter
val
[in] CMxInternationalizedStringArray instance value.
Return Value
CMxValue

CMxStringArray Operator Overload


Provides an operator that converts from
CMxInternationalizedStringArray to CMxStringArray.
Syntax
public static implicit operator
CMxStringArray(CMxInternationalizedStringArray val);
Parameter
val
[in] CMxInternationalizedStringArray instance value.
Return Value
CMxStringArray

ArchestrA Object Toolkit Reference Guide


CMxInternationalizedStringArray Class 401

CMxInternationalizedStringArray Operator Overload


CMxStringArray
Provides an operator that converts from CMxStringArray to
CMxInternationalizedStringArray.
Syntax
public static implicit operator
CMxInternationalizedStringArray(CMxStringArray val);
Parameter
val
[in] CMxStringArray instance value.
Return Value
CMxInternationalizedStringArray

CMxInternationalizedStringArray Operator Overload


CMxValue
Provides an operator that converts from CMxValue to
CMxInternationalizedStringArray.
Syntax
public static implicit operator
CMxInternationalizedStringArray(CMxValue val);
Parameter
val
[in] CMxValue instance value.
Return Value
CMxInternationalizedStringArray

CMxInternationalizedStringArray Operator Overload


string[ ]
Provides an operator that converts from string array to
CMxInternationalizedStringArray.
Syntax
public static implicit operator
CMxInternationalizedStringArray(string[] val);
Parameter
val
[in] string[ ].
Return Value
CMxInternationalizedStringArray

ArchestrA Object Toolkit Reference Guide


402 Chapter 1 Class Reference

CMxReference Class
CMxReference is derived from CMxCommon and provides
support for Reference Attributes.
Syntax
public class CMxReference : CMxCommon

CMxReference Property
The following is the property of the CMxReference class.
• Value Property

Value Property
Provides a property to get or set the value as a full reference
string.
Syntax
public string Value { get; set; }
Return Value
string

CMxReference Constructors
The following are the constructors of the CMxReference
class.
• CMxReference Constructor

• CMxReference Constructor string

• CMxReference Constructor SupportWrapper, string

CMxReference Constructor
Provides a default constructor.
Syntax
public CMxReference ();

CMxReference Constructor string


Provides a constructor to initialize the class with a full
reference string.
Syntax
public CMxReference (string v);
Parameter
v
[in] string value that holds the reference.

ArchestrA Object Toolkit Reference Guide


CMxReference Class 403

CMxReference Constructor SupportWrapper, string


Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxReference (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

CMxReference Method
The following is the method of the CMxReference class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxReference.
Syntax
public void Set(CMxReference val);
Parameter
val
[in] CMxReference value.

CMxReference Operator Overloads


The following are the operator overloads of the
CMxReference class.
• CMxReference Operator Overload string
• CMxValue Operator Overload

• string Operator Overload

• CMxReference Operator Overload CMxValue

ArchestrA Object Toolkit Reference Guide


404 Chapter 1 Class Reference

CMxReference Operator Overload string


Provides an operator that converts from full reference string
to CMxReference.
Syntax
public static implicit operator CMxReference (string
x);
Parameter
x
[in] string to convert to CMxReference.
Return Value
CMxReference

CMxValue Operator Overload


Provides an operator that converts from CMxReference to
CMxValue.
Syntax
public static implicit operator CMxValue(CMxReference
val);
Parameter
val
[in] CMxReference value to convert to CMxValue.
Return Value
CMxValue

string Operator Overload


Provides an operator that converts from CMxReference to
full reference string.
Syntax
public static implicit operator string (CMxReference
val);
Parameter
val
[in] CMxReference value to convert to string.
Return Value
string

ArchestrA Object Toolkit Reference Guide


CMxReferenceArray Class 405

CMxReference Operator Overload CMxValue


Provides an operator that converts from CMxValue to
CMxReference.
Syntax
public static implicit operator CMxReference (CMxValue
val);
Parameter
val
[in] CMxValue value to convert to CMxReference.
Return Value
CMxReference

CMxReferenceArray Class
CMxReferenceArray is derived from CMxArray and provides
support for Reference Array Attributes.
Syntax
public class CMxReferenceArray : CMxArray<string>

CMxReferenceArray Properties
The following are the properties of the CMxReferenceArray
class.
• Value Property

• Property to Get and Set an Element using the [ ]


Operator

Value Property
Provides a property to get or set the value as a string array.
Syntax
public string[] Value { get; set; }
Return Value
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
public string this[short i] { get; set; }
Return Value
string

ArchestrA Object Toolkit Reference Guide


406 Chapter 1 Class Reference

CMxReferenceArray Constructors
The following are the constructors of the CMxReferenceArray
class.
• CMxReferenceArray Constructor int

• CMxReferenceArray Constructor string[ ]

• CMxReferenceArray Constructor SupportWrapper,


string

CMxReferenceArray Constructor int


Provides a constructor to initialize the array to a default
length.
Syntax
public CMxReferenceArray(int length);
Parameter
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
public CMxReferenceArray (string[] value);
Parameter
value
[in] string[ ].

CMxReferenceArray Constructor SupportWrapper,


string
Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxReferenceArray (SupportWrapper _wrapper,
string _attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] int value that holds the array length.

ArchestrA Object Toolkit Reference Guide


CMxReferenceArray Class 407

CMxReferenceArray Method
The following is the method of the CMxReferenceArray class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxReferenceArray.
Syntax
public void Set(CMxReferenceArray newValue);
Parameter
newValue
[in] CMxReferenceArray instance value.

CMxReferenceArray Operator Overloads


The following are the operator overloads of the
CMxReferenceArray class.
• CMxReferenceArray Operator Overload string[ ]

• CMxValue Operator Overload

• String[ ] Operator Overload

• CMxReferenceArray Operator Overload CMxValue

CMxReferenceArray Operator Overload string[ ]


Provides an operator that converts from string array to
CMxReferenceArray.
Syntax
public static implicit operator
CMxReferenceArray(string [] val);
Parameter
val
[in] string [ ].
Return Value
CMxReferenceArray

ArchestrA Object Toolkit Reference Guide


408 Chapter 1 Class Reference

CMxValue Operator Overload


Provides an operator that converts from CMxReferenceArray
to CMxValue.
Syntax
public static implicit operator
CMxValue(CMxReferenceArray val);
Parameter
val
[in] CMxReferenceArray instance value.
Return Value
CMxValue

String[ ] Operator Overload


Provides an operator that converts from CMxReferenceArray
to string array.
Syntax
public static implicit operator string
[](CMxReferenceArray val);
Parameter
val
[in] CMxReferenceArray instance value.
Return Value
string [ ]

CMxReferenceArray Operator Overload CMxValue


Provides an operator that converts from CMxValue to
CMxReferenceArray.
Syntax
public static implicit operator CMxReferenceArray
(CMxValue val);
Parameter
val
[in] CMxValue instance value.
Return Value
CMxReferenceArray

ArchestrA Object Toolkit Reference Guide


CMxStatus Class 409

CMxStatus Class
CMxStatus is derived from CMxCommon and provides
support for MxStatus Attributes.
Syntax
public class CMxStatus : CMxCommon

CMxStatus Property
The following is the property of the CMxStatus class.
• Value Property

Value Property
Provides a Property to get and set the value as an MxStatus.
Syntax
public MxStatus Value { get; set; }
Return Value
MxStatus

CMxStatus Constructors
The following are the constructors of the CMxStatus class.
• CMxStatus Constructor

• CMxStatus Constructor MxStatus

• CMxStatus Constructor SupportWrapper, string

CMxStatus Constructor
Provides a default constructor.
Syntax
public CMxStatus();

CMxStatus Constructor MxStatus


Provides a constructor to initialize the class with an
MxStatus.
Syntax
public CMxStatus (MxStatus v);
Parameter
v
[in] MxStatus value to be set.

ArchestrA Object Toolkit Reference Guide


410 Chapter 1 Class Reference

CMxStatus Constructor SupportWrapper, string


Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
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
The following is the method of the CMxStatus class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxStatus.
Syntax
public void Set(CMxStatus val);
Parameter
val
[in] CMxStatus value to be set.

CMxStatus Operator Overloads


The following are the operator overloads of the CMxStatus
class.
• CMxStatus Operator Overload MxStatus
• CMxStatus Operator Overload CMxValue

• CMxValue Operator Overload CMxStatus

• MxStatus Operator Overload CMxStatus

ArchestrA Object Toolkit Reference Guide


CMxStatus Class 411

CMxStatus Operator Overload MxStatus


Provides an operator that converts from MxStatus to
CMxStatus.
Syntax
public static implicit operator CMxStatus(MxStatus x);
Parameter
x
[in] MxStatus value to convert to CMxStatus.
Return Value
CMxStatus

CMxStatus Operator Overload CMxValue


Provides an operator that converts from CMxValue to
CMxStatus.
Syntax
public static implicit operator CMxStatus(CMxValue
val);
Parameter
val
[in] CMxValue value to convert to CMxStatus.
Return Value
CMxStatus

CMxValue Operator Overload CMxStatus


Provides an operator that converts from CMxStatus to
CMxValue.
Syntax
public static implicit operator CMxValue (CMxStatus
val);
Parameter
val
[in] CMxStatus value to convert to CMxValue.
Return Value
CMxValue

ArchestrA Object Toolkit Reference Guide


412 Chapter 1 Class Reference

MxStatus Operator Overload CMxStatus


Provides an operator that converts from CMxStatus to
MxStatus.
Syntax
public static implicit operator MxStatus (CMxStatus
val);
Parameter
val
[in] CMxStatus value to convert to MxStatus.
Return Value
MxStatus

CMxStatusArray Class
CMxStatusArray is derived from CMxArray and provides
support for MxStatus Array Attributes.
Syntax
public class CMxStatusArray : CMxArray<MxStatus>

CMxStatusArray Properties
The following are the properties of the CMxStatusArray
class.
• Value Property

• Property to Get and Set the MxStatus Value using the [ ]


Operator

Value Property
Provides a Property to get and set the value as a MxStatus
array.
Syntax
public MxStatus[] Value { get; set; }
Return Value
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
public MxStatus this[short i] { get; set; }
Return Value
MxStatus

ArchestrA Object Toolkit Reference Guide


CMxStatusArray Class 413

CMxStatusArray Constructors
The following are the constructors of the CMxStatusArray
class.
• CMxStatusArray Constructor int

• CMxStatusArray Constructor MxStatus[ ]

• CMxStatusArray Constructor SupportWrapper, string

CMxStatusArray Constructor int


Provides a constructor to initialize the array to a default
length.
Syntax
public CMxStatusArray(int length);
Parameter
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
public CMxStatusArray (MxStatus[] value);
Parameter
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
public CMxStatusArray (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

ArchestrA Object Toolkit Reference Guide


414 Chapter 1 Class Reference

CMxStatusArray Method
The following is the method of the CMxStatusArray class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxStatusArray.
Syntax
public void Set(CMxStatusArray newValue);
Parameter
newValue
[in] CMxStatusArray value to be set.

CMxStatusArray Operator Overloads


The following are the operator overloads of the
CMxStatusArray class.
• CMxStatusArray Operator Overload MxStatus[ ]

• CMxStatusArray Operator Overload CMxValue

• MxStatus[ ] Operator Overload CMxStatusArray

• CMxValue Operator Overload CMxStatusArray

CMxStatusArray Operator Overload MxStatus[ ]


Provides an operator that converts from MxStatus array to
CMxStatusArray.
Syntax
public static implicit operator
CMxStatusArray(MxStatus[] val);
Parameter
val
[in] MxStatus[ ] value to convert to CMxStatusArray.
Return Value
CMxStatusArray

ArchestrA Object Toolkit Reference Guide


CMxStatusArray Class 415

CMxStatusArray Operator Overload CMxValue


Provides an operator that converts from CMxValue to
CMxStatusArray.
Syntax
public static implicit operator CMxStatusArray(CMxValue
val);
Parameter
val
[in] CMxValue value to convert to CMxStatusArray.
Return Value
CMxStatusArray

MxStatus[ ] Operator Overload CMxStatusArray


Provides an operator that converts from CMxStatusArray to
a MxStatus array.
Syntax
public static implicit operator
MxStatus[](CMxStatusArray val);
Parameter
val
[in] CMxStatusArray value to convert to MxStatus[ ].
Return Value
MxStatus[ ]

CMxValue Operator Overload CMxStatusArray


Provides an operator that converts from CMxStatusArray to
CMxValue.
Syntax
public static implicit operator CMxValue(CMxStatusArray
val);
Parameter
val
[in] CMxStatusArray value to convert to CMxValue.
Return Value
CMxValue

ArchestrA Object Toolkit Reference Guide


416 Chapter 1 Class Reference

CMxString Class
CMxString is derived from CMxCommon and provides
support for string Attributes.
Syntax
public class CMxString : CMxCommon

CMxString Property
The following is the property of the CMxString class.
• Value Property

Value Property
Provides a property to get and set the value as a string.
Syntax
public string Value { get; set; }
Return Value
string

CMxString Constructors
The following are the constructors of the CMxString class.
• CMxString Constructor

• CMxString Constructor string

• CMxString Constructor SupportWrapper, string

CMxString Constructor
Provides a default constructor.
Syntax
public CMxString();

CMxString Constructor string


Provides a constructor to initialize the class with a string.
Syntax
public CMxStatus (string v);
Parameter
v
[in] string value to be set.

ArchestrA Object Toolkit Reference Guide


CMxString Class 417

CMxString Constructor SupportWrapper, string


Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxString (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

CMxString Method
The following is the method of the CMxString class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxString.
Syntax
public void Set(CMxString val);
Parameter
val
[in] CMxString value to be set.

CMxString Operator Overloads


The following are the operator overloads of the CMxString
class.
• CMxString Operator Overload string
• CMxString Operator Overload CMxValue

• CMxValue Operator Overload CMxString

• string Operator Overload CMxString

ArchestrA Object Toolkit Reference Guide


418 Chapter 1 Class Reference

CMxString Operator Overload string


Provides an operator that converts from string to CMxString.
Syntax
public static implicit operator CMxString (string x);
Parameter
x
[in] string value to convert to CMxString.
Return Value
CMxString

CMxString Operator Overload CMxValue


Provides an operator that converts from CMxValue to
CMxString.
Syntax
public static implicit operator CMxString (CMxValue
val);
Parameter
val
[in] CMxValue value to convert to CMxString.
Return Value
CMxString

CMxValue Operator Overload CMxString


Provides an operator that converts from CMxString to
CMxValue.
Syntax
public static implicit operator CMxValue(CMxString
val);
Parameter
val
[in] CMxString value to convert to CMxValue.
Return Value
CMxValue

ArchestrA Object Toolkit Reference Guide


CMxStringArray Class 419

string Operator Overload CMxString


Provides an operator that converts from CMxString to string.
Syntax
public static implicit operator string (CMxString val);
Parameter
val
[in] CMxString value to convert to string.
Return Value
string

CMxStringArray Class
CMxStringArray is derived from CMxArray and provides
support for string Array Attributes.
Syntax
public class CMxStringArray : CMxArray<string>

CMxStringArray Properties
The following are the properties of the CMxStringArray
class.
• Value Property

• Property to Get and Get the String using the [ ] Operator

Value Property
Provides a property to get and set the value as a string array.
Syntax
public string[] Value { get; set; }
Return Value
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
public string this[short i] { get; set; }
Return Value
string

ArchestrA Object Toolkit Reference Guide


420 Chapter 1 Class Reference

CMxStringArray Constructors
The following are the constructors of the CMxStringArray
class.
• CMxStringArray Constructor int

• CMxStringArray Constructor string[ ]

• CMxStringArray Constructor SupportWrapper, string

CMxStringArray Constructor int


Provides a constructor to initialize the array to a default
length.
Syntax
public CMxStringArray(int length);
Parameter
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
public CMxStringArray(string[] value);
Parameter
value
[in] string[ ] value

CMxStringArray Constructor SupportWrapper, string


Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxStringArray (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

ArchestrA Object Toolkit Reference Guide


CMxStringArray Class 421

CMxStringArray Method
The following is the method of the CMxStringArray class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxStringArray.
Syntax
public void Set(CMxStringArray newValue);
Parameter
newValue
[in] CMxStringArray value to be set.

CMxStringArray Operator Overloads


The following are the operator overloads of the
CMxStringArray class.
• CMxStringArray Operator Overload string[ ]

• CMxStringArray Operator Overload CMxValue

• string[ ] Operator Overload CMxStringArray

• CMxValue Operator Overload CMxStringArray

CMxStringArray Operator Overload string[ ]


Provides an operator that converts from string array to
CMxStringArray.
Syntax
public static implicit operator CMxStringArray
(string[] val);
Parameter
val
[in] string[ ] to convert to CMxStringArray.
Return Value
CMxStringArray

ArchestrA Object Toolkit Reference Guide


422 Chapter 1 Class Reference

CMxStringArray Operator Overload CMxValue


Provides an operator that converts from CMxValue to
CMxStringArray.
Syntax
public static implicit operator CMxStringArray
(CMxValue val);
Parameter
val
[in] CMxValue value to convert to CMxStringArray.
Return Value
CMxStringArray

string[ ] Operator Overload CMxStringArray


Provides an operator that converts from CMxStringArray to
string array.
Syntax
public static implicit operator string[](CMxStringArray
val);
Parameter
val
[in] CMxStringArray value to convert to string array.
Return Value
string[ ]

CMxValue Operator Overload CMxStringArray


Provides an operator that converts from CMxStringArray to
CMxValue.
Syntax
public static implicit operator CMxValue(CMxStringArray
val);
Parameter
val
[in] CMxStringArray value to convert to CMxValue.
Return Value
CMxValue

ArchestrA Object Toolkit Reference Guide


CMxTime Class 423

CMxTime Class
CMxTime is derived from CMxCommon and provides support
for Time/DateTime Attributes.
Syntax
public class CMxTime : CMxCommon

CMxTime Property
The following is the property of the CMxTime class.
• Value Property

Value Property
Provides a property to get and set the value as a DateTime.
Syntax
public DateTime Value { get; set; }
Return Value
DateTime

CMxTime Constructors
The following are the constructors of the CMxTime class.
• CMxTime Constructor

• CMxTime Constructor DateTime

• CMxTime Constructor string

• CMxTime Constructor SupportWrapper, string

CMxTime Constructor
Provides a default constructor.
Syntax
public CMxTime();

CMxTime Constructor DateTime


Provides a constructor to initialize the class with a DateTime
default value.
Syntax
public CMxTime (DateTime v);
Parameter
v
[in] DateTime instance value to be set.

ArchestrA Object Toolkit Reference Guide


424 Chapter 1 Class Reference

CMxTime Constructor string


Provides a constructor to initialize the class with a formatted
time string default value.
Syntax
public CMxTime(string v);
Parameter
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
public CMxTime (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

CMxTime Method
The following is the method of the CMxTime class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxTime.
Syntax
public void Set(CMxTime val);
Parameter
val
[in] CMxTime value to be set.

ArchestrA Object Toolkit Reference Guide


CMxTime Class 425

CMxTime Operator Overloads


The following are the operator overloads of the CMxTime
class.
• CMxTime Operator Overload DateTime

• CMxTime Operator Overload CMxValue

• CMxValue Operator Overload CMxTime

• DateTime Operator Overload CMxTime

• - Operator Overload CMxTime, DateTime (TimeSpan)

• - Operator Overload CMxTime, TimeSpan (DateTime)

• != Operator Overload CMxTime, DateTime (bool)

• + Operator Overload CMxTime, TimeSpan (DateTime)

• < Operator Overload CMxTime, DateTime (bool)

• <= Operator Overload CMxTime, DateTime (bool)

• == Operator Overload CMxTime, DateTime (bool)

• > Operator Overload CMxTime, DateTime (bool)

• >= Operator Overload CMxTime, DateTime (bool)

CMxTime Operator Overload DateTime


Provides an operator that converts from DateTime to
CMxTime.
Syntax
public static implicit operator CMxTime(DateTime x);
Parameter
x
[in] DateTime value to convert to CMxTime.
Return Value
CMxTime

ArchestrA Object Toolkit Reference Guide


426 Chapter 1 Class Reference

CMxTime Operator Overload CMxValue


Provides an operator that converts from CMxValue to
CMxTime.
Syntax
public static implicit operator CMxTime (CMxValue val);
Parameter
val
[in] CMxValue value to convert to CMxTime.
Return Value
CMxTime

CMxValue Operator Overload CMxTime


Provides an operator that converts from CMxTime to
CMxValue.
Syntax
public static implicit operator CMxValue(CMxTime val);
Parameter
val
[in] CMxTime value to convert to CMxValue.
Return Value
CMxValue

DateTime Operator Overload CMxTime


Provides an operator that converts from CMxTime to
DateTime.
Syntax
public static implicit operator DateTime (CMxTime val);
Parameter
val
[in] CMxTime value to convert to DateTime.
Return Value
DateTime

ArchestrA Object Toolkit Reference Guide


CMxTime Class 427

- Operator Overload CMxTime, DateTime (TimeSpan)


Provides an operator to subtract a DateTime from a
CMxTime.
Syntax
public static TimeSpan operator -(CMxTime t1, DateTime
t2);
Parameters
t1
[in] CMxTime value.
t2
[in] DateTime value.
Return Value
TimeSpan

- Operator Overload CMxTime, TimeSpan (DateTime)


Provides an operator to subtract a TimeSpan from a
CMxTime.
Syntax
public static DateTime operator -(CMxTime t1, TimeSpan
t2);
Parameters
t1
[in] CMxTime value.
t2
[in] TimeSpan value.
Return Value
DateTime

!= Operator Overload CMxTime, DateTime (bool)


Provides an operator to check if a CMxTime and DateTime
are not equal.
Syntax
public static bool operator !=(CMxTime t1, DateTime
t2);
Parameters
t1
[in] CMxTime value.
t2
[in] DateTime value.
Return Value
bool

ArchestrA Object Toolkit Reference Guide


428 Chapter 1 Class Reference

+ Operator Overload CMxTime, TimeSpan (DateTime)


Provides an operator to add a TimeSpan to a CMxTime.
Syntax
public static DateTime operator +(CMxTime t, TimeSpan
ts);
Parameters
t
[in] CMxTime value.
ts
[in] TimeSpan value.
Return Value
DateTime

< Operator Overload CMxTime, DateTime (bool)


Provides an operator to check if a CMxTime is less than a
DateTime.
Syntax
public static bool operator <(CMxTime t1, DateTime t2);
Parameters
t1
[in] CMxTime value.
t2
[in] DateTime value.
Return Value
bool

<= Operator Overload CMxTime, DateTime (bool)


Provides an operator to check if a CMxTime is less than or
equal to a DateTime.
Syntax
public static bool operator <=(CMxTime t1, DateTime
t2);
Parameters
t1
[in] CMxTime value.
t2
[in] DateTime value.
Return Value
bool

ArchestrA Object Toolkit Reference Guide


CMxTime Class 429

== Operator Overload CMxTime, DateTime (bool)


Provides an operator to check if a CMxTime is equal to a
DateTime.
Syntax
public static bool operator ==(CMxTime t1, DateTime
t2);
Parameters
t1
[in] CMxTime value.
t2
[in] DateTime value.
Return Value
bool

> Operator Overload CMxTime, DateTime (bool)


Provides an operator to check if a CMxTime is greater than a
DateTime.
Syntax
public static bool operator >(CMxTime t1, DateTime t2);
Parameters
t1
[in] CMxTime value.
t2
[in] DateTime value.
Return Value
bool

>= Operator Overload CMxTime, DateTime (bool)


Provides an operator to check if a CMxTime is greater than
or equal to a DateTime.
Syntax
public static bool operator >=(CMxTime t1, DateTime
t2);
Parameters
t1
[in] CMxTime value.
t2
[in] DateTime value.
Return Value
bool

ArchestrA Object Toolkit Reference Guide


430 Chapter 1 Class Reference

CMxTimeArray Class
CMxTimeArray is derived from CMxArray and provides
support for Time/DateTime Array Attributes.
Syntax
public class CMxTimeArray : CMxArray<DateTime>

CMxTimeArray Properties
The following are the properties of the CMxTimeArray class.
• Value Property

• Property to get and set the DateTime using [ ] operator

Value Property
Provides a property to get and set the value as a DateTime
array.
Syntax
public DateTime[] Value { get; set; }
Return Value
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
public DateTime this[short i] { get; set; }
Return Value
DateTime

CMxTimeArray Constructors
The following are the constructors of the CMxTimeArray
class.
• CMxTimeArray Constructor int

• CMxTimeArray Constructor DateTime[ ]

• CMxTimeArray Constructor string[ ]

• CMxTimeArray Constructor SupportWrapper, string

ArchestrA Object Toolkit Reference Guide


CMxTimeArray Class 431

CMxTimeArray Constructor int


Provides a constructor to initialize the array to a default
length.
Syntax
public CMxTimeArray(int length);
Parameter
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
public CMxTimeArray (DateTime[] value);
Parameter
value
[in] DateTime[ ].

CMxTimeArray Constructor string[ ]


Provides a constructor to initialize the class with a formatted
time string array default value.
Syntax
public CMxTimeArray (string[] value);
Parameter
value
[in] string[ ] value.

CMxTimeArray Constructor SupportWrapper, string


Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxTimeArray (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

ArchestrA Object Toolkit Reference Guide


432 Chapter 1 Class Reference

CMxTimeArray Method
The following is the method of the CMxTimeArray class.
• Set Method

Set Method
Provides a method to set the value of the Attribute from a
CMxTimeArray.
Syntax
public void Set(CMxTimeArray newValue);
Parameter
newValue
[in] CMxTimeArray value to be set.

CMxTimeArray Operator Overloads


The following are the operator overloads of the
CMxTimeArray class.
• CMxTimeArray Operator Overload DateTime[ ]

• CMxTimeArray Operator Overload CMxValue

• DateTime[ ] Operator Overload CMxTimeArray

• CMxValue Operator Overload CMxTimeArray

CMxTimeArray Operator Overload DateTime[ ]


Provides an operator that converts from DateTime array to
CMxTimeArray.
Syntax
public static implicit operator CMxTimeArray(DateTime[]
val);
Parameter
val
[in] DateTime[ ] value to convert to CMxTimeArray.
Return Value
CMxTimeArray

ArchestrA Object Toolkit Reference Guide


CMxTimeArray Class 433

CMxTimeArray Operator Overload CMxValue


Provides an operator that converts from CMxValue to
CMxTimeArray.
Syntax
public static implicit operator CMxTimeArray (CMxValue
val);
Parameter
val
[in] CMxValue value to convert to CMxTimeArray.
Return Value
CMxTimeArray

DateTime[ ] Operator Overload CMxTimeArray


Provides an operator that converts from CMxTimeArray to
DateTime array.
Syntax
public static implicit operator DateTime[](CMxTimeArray
val);
Parameter
val
[in] CMxTimeArray value to convert to DateTime[ ].
Return Value
DateTime[ ]

CMxValue Operator Overload CMxTimeArray


Provides an operator that converts from CMxTimeArray to
CMxValue.
Syntax
public static implicit operator CMxValue(CMxTimeArray
val);
Parameter
val
[in] CMxTimeArray value to convert to CMxValue.
Return Value
CMxValue

ArchestrA Object Toolkit Reference Guide


434 Chapter 1 Class Reference

CMxVariant Class
CMxVariant class is derived from CMxCommon and provides
support for variant Attributes.
Syntax
public class CMxVariant : CMxCommon

CMxVariant Property
The following is the property of the CMxVariant class.
• Value Property

Value Property
Provides a property to get and set the value as a string.
Syntax
public CMxValue Value { get; set; }
Return Value
CMxValue

CMxVariant Constructors
The following are the constructors of the CMxVariant class.
• CMxVariant Constructor

• CMxVariant Constructor CMxValue

• CMxVariant Constructor SupportWrapper, string

CMxVariant Constructor
Provides a default constructor.
Syntax
public CMxVariant();

CMxVariant Constructor CMxValue


Provides a constructor to initialize the object with a
CMxValue.
Syntax
public CMxVariant(CMxValue v);
Parameter
v
[in] CMxValue value.

ArchestrA Object Toolkit Reference Guide


CMxVariant Class 435

CMxVariant Constructor SupportWrapper, string


Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxStatus (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

CMxVariant Methods
The following are the methods of the CMxVariant class.
• Set Method
• SetDataType Method

Set Method
Provide a method to set the value of the Attribute from a
CMxVariant
Syntax
public void Set(CMxVariant val);
Parameter
val
[in] CMxVariant value to be set.

SetDataType Method
Provides a method to set the MxDataType of the Attribute.
Syntax
public void SetDataType(MxDataType dtype);
Parameter
dtype
[in] MxDataType value to be set.

ArchestrA Object Toolkit Reference Guide


436 Chapter 1 Class Reference

CMxVariant Operator Overloads


The following are the operator overloads of the CMxVariant
class.
• CMxValue Operator Overload CMxVariant

• CMxVariant Operator Overload CMxValue

CMxValue Operator Overload CMxVariant


Provides an operator that converts from CMxVariant to
CMxValue.
Syntax
public static implicit operator CMxValue(CMxVariant
val);
Parameter
val
[in] CMxVariant value to convert to CMxValue.
Return Value
CMxValue

CMxVariant Operator Overload CMxValue


Provides an operator that converts from CMxValue to
CMxVariant.
Syntax
public static implicit operator CMxVariant(CMxValue
val);
Parameter
val
[in] CMxValue value to convert to CMxVariant.
Return Value
CMxVariant

CMxVariantArray Class
CMxVariantArray is derived from CMxArray and provides
support for Variant Array Attributes.
Syntax
public class CMxVariantArray : CMxArray<CMxValue)

ArchestrA Object Toolkit Reference Guide


CMxVariantArray Class 437

CMxVariantArray Properties
The following are the properties of the CMxVariantArray
class.
• Value Property

• Property to Get and Set the CMxValue Value using the [ ]


Operator

Value Property
Provides a property to get and set the value as a CMxValue
array.
Syntax
public CMxValue [] Value { get; set; }
Return Value
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
public CMxValue this[short i] { get; set; }
Return Value
CMxValue

CMxVariantArray Constructors
The following are the constructors of the CMxVariantArray
class.
• CMxVariantArray Constructor int

• CMxVariantArray Constructor CMxValue[ ]


• CMxVariantArray Constructor SupportWrapper, string

CMxVariantArray Constructor int


Provides a constructor to initialize the array to a default
length.
Syntax
public CMxVariantArray(int length);
Parameter
length
[in] integer value that holds the array length.

ArchestrA Object Toolkit Reference Guide


438 Chapter 1 Class Reference

CMxVariantArray Constructor CMxValue[ ]


Provides a constructor to initialize the class with a
CMxValue array default value.
Syntax
public CMxVariantArray (CMxValue[] value);
Parameter
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
public CMxVariantArray (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

CMxVariantArray Methods
The following are the methods of the CMxVariantArray
class.
• Set Method

• SetDataType Method

Set Method
Provides a method to set the value of the Attribute from a
CMxVariantArray.
Syntax
public void Set(CMxVariantArray newValue);
Parameter
newValue
[in] CMxVariantArray value to be set.

ArchestrA Object Toolkit Reference Guide


CMxVariantArray Class 439

SetDataType Method
Provides a method to set the value of the MxDataType of the
Attribute.
Syntax
public void SetDataType(MxDataType dtype);
Parameter
dtype
[in] MxDataType value.

CMxVariantArray Operator Overloads


The following are the operator overloads of the
CMxVariantArray class.
• CMxValue Operator Overload CMxVariantArray

• CMxVariantArray Operator Overload CMxValue

CMxValue Operator Overload CMxVariantArray


Provides an operator that converts from CMxVariantArray to
CMxValue.
Syntax
public static implicit operator
CMxValue(CMxVariantArray val);
Parameter
val
[in] CMxVariantArray value to convert to CMxValue.
Return Value
CMxValue

CMxVariantArray Operator Overload CMxValue


Provides an operator that converts from CMxValue to
CMxVariantArray.
Syntax
public static implicit operator CMxVariantArray
(CMxValue val);
Parameter
val
[in] CMxValue value to convert to CMxVariantArray.
Return Value
CMxVariantArray

ArchestrA Object Toolkit Reference Guide


440 Chapter 1 Class Reference

CMxBigString Class
CMxBigString is derived from CMxString and provides
support for BigString Attributes.
Syntax
public class CMxBigString : CMxString

CMxBigString Constructors
The following are the constructors of the CMxBigString class.
• CMxBigString Constructor

• CMxBigString Constructor string

• CMxBigString Constructor SupportWrapper, string

CMxBigString Constructor
Provides a default constructor.
Syntax
public CMxBigString();

CMxBigString Constructor string


Provides a constructor to initialize the object with a string.
Syntax
public CMxBigString (string v);
Parameter
v
[in] string to be set.

CMxBigString Constructor SupportWrapper, string


Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxBigString (SupportWrapper _wrapper, string
_attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

ArchestrA Object Toolkit Reference Guide


CMxBigString Class 441

CMxBigString Operator Overloads


The following are the operator overloads of the
CMxBigString class.
• CMxValue Operator Overload CMxBigString

• String Operator Overload CMxBigString

• CMxBigString Operator Overload CMxValue

• CMxBigString Operator Overload string

CMxValue Operator Overload CMxBigString


Provides an operator to convert CMxBigString to CMxValue.
Syntax
public static implicit operator CMxValue(CMxBigString
val);
Parameter
val
[in] CMxBigString value to convert to CMxValue.
Return Value
CMxValue

String Operator Overload CMxBigString


Provides an operator to convert CMxBigString to string.
Syntax
public static implicit operator string(CMxBigString
val);
Parameter
val
[in] CMxBigString value to convert to string.
Return Value
string

CMxBigString Operator Overload CMxValue


Provides an operator to convert CMxValue to CMxBigString.
Syntax
public static implicit operator CMxBigString(CMxValue
val);
Parameter
val
[in] CMxValue value to convert to CMxBigString.
Return Value
CMxBigString

ArchestrA Object Toolkit Reference Guide


442 Chapter 1 Class Reference

CMxBigString Operator Overload string


Provides an operator to convert string to CMxBigString.
Syntax
public static implicit operator CMxBigString(string
val);
Parameter
val
[in] string value to convert to CMxBigString.
Return Value
CMxBigString

CMxBigStringArray Class
CMxBigStringArray is derived from CMxStringArray and
provides support for BigString Array Attributes.
Syntax
public class CMxBigStringArray : CMxStringArray

CMxBigStringArray Constructors
The following are the constructors of the CMxBigStringArray
class.
• CMxBigStringArray Constructor int

• CMxBigStringArray Constructor string[ ]

• CMxBigStringArray Constructor SupportWrapper, string

CMxBigStringArray Constructor int


Provides a constructor to initialize the array to a default
length.
Syntax
public CMxBigStringArray(int length);
Parameter
length
[in] integer value that holds the array length.

ArchestrA Object Toolkit Reference Guide


CMxBigStringArray Class 443

CMxBigStringArray Constructor string[ ]


Provides a constructor to initialize the class with a string
array default value.
Syntax
public CMxBigStringArray (string[] value);
Parameter
value
[in] string[ ].

CMxBigStringArray Constructor SupportWrapper,


string
Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxBigStringArray (SupportWrapper _wrapper,
string _attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

CMxBigStringArray Operator Overloads


The following are the operator overloads of the
CMxBigStringArray class.
• CMxValue Operator Overload CMxBigStringArray

• String[] Operator Overload CMxBigStringArray


• CMxBigStringArray Operator Overload CMxValue
• CMxBigStringArray Operator Overload string[ ]

CMxValue Operator Overload CMxBigStringArray


Provides an operator to convert CMxBigStringArray to
CMxValue.
Syntax
public static implicit operator
CMxValue(CMxBigStringArray val);
Parameter
val
[in] CMxBigStringArray value to convert to CMxValue.
Return Value
CMxValue

ArchestrA Object Toolkit Reference Guide


444 Chapter 1 Class Reference

String[] Operator Overload CMxBigStringArray


Provides an operator to convert CMxBigStringArray to string
array.
Syntax
public static implicit operator
string[](CMxBigStringArray val);
Parameter
val
[in] CMxBigStringArray value to convert to string[ ].
Return Value
string[ ]

CMxBigStringArray Operator Overload CMxValue


Provides an operator to convert CMxValue to
CMxBigStringArray.
Syntax
public static implicit operator CMxBigStringArray
(CMxValue val);
Parameter
val
[in] CMxValue value to convert to CMxBigStringArray.
Return Value
CMxBigStringArray

CMxBigStringArray Operator Overload string[ ]


Provides an operator to convert string array to
CMxBigStringArray.
Syntax
public static implicit operator CMxBigStringArray
(string[] val);
Parameter
val
[in] string[ ] value to convert to CMxBigStringArray.

Return Value
CMxBigStringArray

ArchestrA Object Toolkit Reference Guide


CMxInternalDumpLoadData Class 445

CMxInternalDumpLoadData Class
CMxInternalDumpLoadData class is derived from
CMxCustomStruct and provides support for dump/load at
Configtime.
Syntax
public class CMxInternalDumpLoadData : CMxCustomStruct

CMxInternalDumpLoadData Property
The following is the property of the
CMxInternalDumpLoadData class.
• StructID Property

StructID Property
Provides a property to indicate the struct ID for
CMxInternalDumpLoadData.
Syntax
public const int structId = 369875326;
Return Value
int

CMxInternalDumpLoadData Constructors
The following are the constructors of the
CMxInternalDumpLoadData class.
• CMxInternalDumpLoadData Constructor

• CMxInternalDumpLoadData Constructor
SupportWrapper, string

CMxInternalDumpLoadData Constructor
Provides a default constructor.
Syntax
public CMxInternalDumpLoadData();

ArchestrA Object Toolkit Reference Guide


446 Chapter 1 Class Reference

CMxInternalDumpLoadData Constructor
SupportWrapper, string
Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxInternalDumpLoadData(SupportWrapper _wrapper,
string _attributeRef);
Parameters
_wrapper
[in] SupportWrapper.
_attributeRef
[in] string value that holds the attribute reference.

CMxInternalFailoverData Class
CMxInternalFailoverData class is derived from
CMxCustomStruct and provides support for failover at
Runtime.
Syntax
public class CMxInternalFailoverData : CMxCustomStruct

CMxInternalFailoverData Property
The following is the property of the
CMxInternalFailoverData class.
• StructID Property

StructID Property
Provides a property to indicate the struct ID for
CMxInternalFailoverData.
Syntax
public const int structId = 369875325;
Return Value
int

CMxInternalFailoverData Constructors
The following are the constructors of the
CMxInternalFailoverData class.
• CMxInternalFailoverData Constructor

• CMxInternalFailoverData Constructor SupportWrapper,


string

ArchestrA Object Toolkit Reference Guide


CMxDataQuality Class 447

CMxInternalFailoverData Constructor
Provides a default constructor.
Syntax
public CMxInternalFailoverData ();

CMxInternalFailoverData Constructor
SupportWrapper, string
Provides a constructor to initialize the class for use in a
primitive wrapper.
Syntax
public CMxInternalFailoverData (SupportWrapper
_wrapper, string _attributeRef);
Parameters
_wrapper
[in] SupportWrapper
_attributeRef
[in] string value that holds the attribute reference.

CMxDataQuality Class
A wrapper class for handling MxDataQuality. Indicates the
data quality of an associated value as the OPC-compliant
data quality word.
Syntax
public class CMxDataQuality
Remarks
The high order byte is reserved by ArchestrA (do not use) as
allowed by the OPC specification.

CMxDataQuality Property
The following is the property of the CMxDataQuality class.
• Quality Property

Quality Property
Provides a property to store the quality as a short.
Syntax
public short quality;
Return Value
short

ArchestrA Object Toolkit Reference Guide


448 Chapter 1 Class Reference

CMxDataQuality Constructors
The following are the constructors of the CMxDataQuality
class.
• CMxDataQuality Constructor

• CMxDataQuality Constructor DataQuality

• CMxDataQuality Constructor OpcQuality

• CMxDataQuality Constructor short

CMxDataQuality Constructor
Provides a constructor that creates a data quality with a
default initial value (bad).
Syntax
public CMxDataQuality();

CMxDataQuality Constructor DataQuality


Provides a constructor to create a data quality with an initial
value of DataQuality type.
Syntax
public CMxDataQuality(DataQuality dataQuality);
Parameter
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
public CMxDataQuality(OpcQuality opcQuality);
Parameter
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
public CMxDataQuality(short q);
Parameter
q
[in] short.

ArchestrA Object Toolkit Reference Guide


CMxDataQuality Class 449

CMxDataQuality Methods
The following are the methods of the CMxDataQuality class.
• IsBad Method
• IsGood Method

• IsInitializing Method

• IsUncertain Method

IsBad Method
Provides a method to check if the current quality is bad.
Syntax
public bool isBad { get; }
Return Value
bool

IsGood Method
Provides a method to check if the current quality is good.
Syntax
public bool isGood { get; }
Return Value
bool

IsInitializing Method
Provides a method to check if the current quality is
initializing.
Syntax
public bool isInitializing { get; }
Return Value
bool

IsUncertain Method
Provides a method to check if the current quality is
uncertain.
Syntax
public bool isUncertain { get; }
Return Value
bool

ArchestrA Object Toolkit Reference Guide


450 Chapter 1 Class Reference

CMxDataQuality Operator Overloads


The following are the operator overloads of the
CMxDataQuality class.
• CMxValue Operator Overload CMxDataQuality

• DataQuality Operator Overload CMxDataQuality

• CMxDataQuality Operator Overload DataQuality

• CMxDataQuality Operator Overload OpcQuality

CMxValue Operator Overload CMxDataQuality


Provides an operator that converts from CMxDataQuality to
CMxValue.
Syntax
public static implicit operator CMxValue(CMxDataQuality
x);
Parameter
x
[in] CMxDataQuality value to convert to CMxValue.
Return Value
CMxValue

DataQuality Operator Overload CMxDataQuality


Provides an operator that converts from CMxDataQuality to
DataQuality.
Syntax
public static implicit operator
DataQuality(CMxDataQuality x);
Parameter
x
[in] CMxDataQuality value to convert to DataQuality.
Return Value
DataQuality

ArchestrA Object Toolkit Reference Guide


CMxIndirectBase Class 451

CMxDataQuality Operator Overload DataQuality


Provides an operator that converts from DataQuality to
CMxDataQuality.
Syntax
public static implicit operator
CMxDataQuality(DataQuality x);
Parameter
x
[in] DataQuality value to convert to CMxDataQuality.
Return Value
CMxDataQuality

CMxDataQuality Operator Overload OpcQuality


Provides an operator that converts from OpcQuality to
CMxDataQuality.
Syntax
public static implicit operator
CMxDataQuality(OpcQuality x);
Parameter
x
[in] OpcQuality value to convert to CMxDataQuality.
Return Value
CMxDataQuality

CMxIndirectBase Class
CMxIndirectBase is an inherited class that provides methods
and properties common to the two types of Indirects:
CMxIndirect and CMxIndirectWriteOnly.
Syntax
public class CMxIndirectBase

ArchestrA Object Toolkit Reference Guide


452 Chapter 1 Class Reference

CMxIndirectBase Properties
The following are the properties of the CMxIndirectBase
class.
• Context Property

• FullReferenceString Property

• HasTimedOut Property

• RefHandle Property

• StatusId Property

• StatusIndex Property

• StatusOfLastWrite Property

• TimeOut Property

Context Property
The context that was used to create the indirect.
Syntax
public string Context { get; }
Return Value
string

FullReferenceString Property
The reference string that was used to create the
CMXIndirectBase instance.
Syntax
public string FullReferenceString { get; }
Return Value
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
public bool HasTimedOut { get; }
Return Value
bool

ArchestrA Object Toolkit Reference Guide


CMxIndirectBase Class 453

RefHandle Property
The RefHandle is the ArchestrA id for the reference bound to
this Indirect.
Syntax
public int RefHandle { get; }
Return Value
int

StatusId Property
The status of a write is written to a dynamic attribute array.
This is attribute id of the dynamic array.
Syntax
public short StatusId { get; }
Return Value
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
public int StatusIndex { get; }
Return Value
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
public MxStatus StatusOfLastWrite { get; }
Return Value
MxStatus

TimeOut Property
Allows the user the set the TimeOut used by HasTimedOut.
Syntax
public TimeSpan TimeOut { get; set; }
Return Value
TimeSpan

ArchestrA Object Toolkit Reference Guide


454 Chapter 1 Class Reference

CMxIndirectBase Constructor
The following is the constructor of the CMxIndirectBase
class.
• CMxIndirectBase Constructor string, string,
ArchestrA.Core.IMxSupervisoryConnection3, RuntimeBase,
int, short, int

CMxIndirectBase Constructor string, string,


ArchestrA.Core.IMxSupervisoryConnection3,
RuntimeBase, int, short, int
This is an internal constructor intended for use only by
derived classes.
Syntax
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.

ArchestrA Object Toolkit Reference Guide


CMxIndirectBase Class 455

CMxIndirectBase Methods
The following are the methods of the CMxIndirectBase class.
• Activate Method

• Activate Method(ArchestrA.MessageExchange.IMxCallback2)
• Set Method(CMxValue, DateTime)
• Suspend Method
• Suspend Method (ArchestrA.MessageExchange.IMxCallback2)
• Unbind Method

Activate Method
Activates a suspended indirect.
Syntax
public bool Activate();
Return Value
bool

Activate
Method(ArchestrA.MessageExchange.IMxCallback2)
Activates a suspended indirect and allows the user to supply
a callback variable.
Syntax
public bool
Activate(ArchestrA.MessageExchange.IMxCallback2
callback)
Parameter
callback
[in] The callback supplied by the user to be called when the
Activate has finished.
Return Value
bool

ArchestrA Object Toolkit Reference Guide


456 Chapter 1 Class Reference

Set Method(CMxValue, DateTime)


Writes the value and timestamp to the indirect in a single
operation.
Syntax
public bool Set(CMxValue value, DateTime timeStamp)
Parameters
value
[in] The value to be written.
timeStamp
[in] The timestamp for the value.
Return Value
bool

Suspend Method
Suspends an active indirect.
Syntax
public bool Suspend()
Return Value
bool

Suspend Method
(ArchestrA.MessageExchange.IMxCallback2)
Suspends an active indirect and allows the user to supply a
callback variable.
Syntax
public bool
Suspend(ArchestrA.MessageExchange.IMxCallback2
callback)
Parameter
callback
[in] The callback supplied by the user to be called when the
Suspend has finished.
Return Value
bool

Unbind Method
Unbinds the indirect, releasing the ArchestrA reference and
dynamic status array index.
Syntax
public void Unbind()

ArchestrA Object Toolkit Reference Guide


CMxIndirectWriteOnly Class 457

CMxIndirectWriteOnly Class
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
public class CMxIndirectWriteOnly : CMxIndirectBase

CMxIndirectWriteOnly Property
The following is the property of the CMxIndirectWriteOnly
class.
• Value Property

Value Property
Allows a user to set the value of the referenced attribute.
Syntax
public CMxValue Value { set; }
Return Value
CMxValue

CMxIndirectWriteOnly Constructor
The following is the constructor of the
CMxIndirectWriteOnly class.
• CMxIndirectWriteOnly Constructor string, string,
IMxSupervisoryConnection3, RuntimeBase, int, short, int

CMxIndirectWriteOnly Constructor string, string,


IMxSupervisoryConnection3, RuntimeBase, int,
short, int
This is an internal constructor intended for use only in
BindToWriteOnly.
Syntax
CMxIndirectWriteOnly(string _fullRefString