GetOptions - OT GetOptions version modi64257ed version OT GetOptions rarr Longint Parameter Type Function result Longint larr A set bit Discussion GetOptions returns 32bit number contains bits representing different options ObjectTools use bit test operator test state given option bit set bit clear operators set clear individual options Currently two options de64257ned ObjectTools provides named constants testing options Option Bit Default OT off OT ExactTagMatch off OT on OT VariantItems off OT default item cannot found OT routines return default value OT option set default value still returned but ObjectTools generate error set OK zero OT ExactTagMatch new version By default tag names matched regard case but diacritical marks are OT ExactTagMatch option set tag names matched exactly using both case diacritical marks Example To turn exact tag matching would use following code GetOptions ExactTagMatch OT SetOptions options OT new version Previous ObjectTools add embedded objects another object had create embedded object put clear it was tedious ultimately unnecessary ObjectTools autocreate embedded objects default whenever put item tag contains embedded item references example NewOT above example after call OT PutString obj contains embedded object contains embedded object contains string This facility make considerably easier create complex object hierarchies than ObjectTools 1x OT VariantItems new version By default try put value item different type error generated rationale behind behavior prevent unintended changing type carelessness negligence However what want change type items such your desire now setting OT VariantItems option example NewOT This generates errorSet allow variant item types try againOT GetOptions This work item now longintSee

OT GetOptions

OT GetOptions version 1 modiﬁed version 2.0

OT GetOptions → Longint
Parameter	Type		Description
Function result	Longint	←	A set of 32 bit ﬂags
Discussion

OT GetOptions returns a 32-bit number which contains bits representing the different options for ObjectTools. You can use the 4D ?? bit test operator to test the state of a given option and the ?+ (bit set) or ?- (bit clear) operators to set or clear individual options.

Currently, there are two options deﬁned. ObjectTools provides named constants for testing the options.

Option Bit Default

OT FailOnItemNotFound	0	0 (off)
OT ExactTagMatch	1	0 (off)
OT AutoCreateObjects	2	1 (on)
OT VariantItems	3	0 (off)
OT FailOnItemNotFound

By default, if an item cannot be found, the OT Get<type> routines will return a default value. If the OT FailOnItemNotFound option is set, a default value will still be returned but ObjectTools will generate an error and set OK to zero.

OT ExactTagMatch (new in version 1.6)

By default, tag names are matched without regard to case (but diacritical marks are signiﬁcant). If the OT ExactTagMatch option is set, tag names are matched exactly, using both case and diacritical marks.

Example

To turn exact tag matching on, you would use the following code:

C_LONGINT($options)

$options:=OT GetOptions

$options:=$options ?+ OT ExactTagMatch

OT SetOptions ($options)

OT AutoCreateObjects (new in version 2.0)

Previous to ObjectTools 2.0, to add an embedded objects to another object, you had to create the embedded object, put it, then clear it. This was tedious and ultimately unnecessary.

ObjectTools 2.0 will auto-create embedded objects by default whenever you put an item with a tag that contains embedded item references. For example:

C_LONGINT($obj)$obj:=OT New
OT PutString($obj;"one.two.three";"way cool!")

In the above example, after the call to OT PutString $obj contains the embedded object “one”, which contains the embedded object “two”, which contains a string “three”.

This facility will make it considerably easier to create complex object hierarchies than in ObjectTools 1.x.

OT VariantItems (new in version 2.0)

By default, if you try to put a value into an item of a different type, an error is generated. The rationale behind this behavior is to prevent unintended changing of the type by carelessness or negligence.

However, what if you want to change the type of items? If such is your desire, you can now do so by setting the OT VariantItems option. For example:

C_LONGINT($obj)$obj:=OT New
OT PutString($obj;"test";"way cool!")
OT PutLong($obj;"test";7) `This generates an error

`Set the ﬂag to allow variant item types and try again

OT SetOptions(OT GetOptions | OT VariantItems)
OT PutLong($obj;"test";7) `This will work, the item is now a longint