Latest revision as of 18:14, 15 June 2015

ADE User Guide > ADE Server Class Reference > CAEngine

Other languages:

English • ‎中文

New to ADE 4.6

Description

A bit field of flags that control certain properties of ADE.

1 = Allow hiding and unhiding of definitions.
When this is not set, you cannot change the Att__CloakDefn attribute from ADE. Since applications in ADE are usually using a model that was previously build in Analytica, you will usually want this off. If you wanted to allow a user to hide or unhide definitions from your application, as they can in Analytica Enterprise, then you would need set this flag.

Data Type

unsigned long

Access

read/write

Example Usage

CAEngine ade = new CAEngine;
ade.Flags = ade.Flags | 0x0001;          // allow hiding / unhiding.  | is the bit-OR operator in C#, C++ and other languages.

Setting Att__cloakDefn =

Errors will result if you attempt to set Att__cloakdefn without the 0x0001 flag.

ade.Flags = ade.Flags & ~1;              // disallow hiding/unhiding of definitions
CAObject xObj = ade.Get("X");
xObj.SetAttribute("Att__cloakDefn",0);    // fails
if (ade.ErrorCode!=0) {
  // Error code is 36 = Attribute could not be set.
  // OutputBuffer is "You cannot hide or unhide the definition of x"
}

@@ Line 1: / Line 1: @@
-[[CAEngine|<< class CAEngine]]
+[[Category:ADE User Guide]]
+[[ADE User Guide]] > [[ADE Server Class Reference]] > [[CAEngine]]
+<languages />
+<translate>
+<!--T:1-->
 ''New to [[Analytica 4.6|ADE 4.6]]''
-= Description =
+= Description = <!--T:2-->
+<!--T:3-->
 A bit field of flags that control certain properties of ADE.
 * 1 = Allow hiding and unhiding of definitions.
 *::When this is not set, you cannot change the Att__CloakDefn attribute from ADE. Since applications in ADE are usually using a model that was previously build in Analytica, you will usually want this off. If you wanted to allow a user to hide or unhide definitions from your application, as they can in Analytica Enterprise, then you would need set this flag.
-= Data Type =
+= Data Type = <!--T:4-->
+<!--T:5-->
 unsigned long
-= Access =
+= Access = <!--T:6-->
+<!--T:7-->
 read/write
-= Example Usage =
+= Example Usage = <!--T:8-->
-  [[CAEngine]] ade = new [[CAEngine]];
+  <!--T:9-->
+[[CAEngine]] ade = new [[CAEngine]];
   ade.Flags = ade.Flags | 0x0001;          // allow hiding / unhiding.  | is the bit-OR operator in C#, C++ and other languages.
-== Setting Att__cloakDefn ===
+== Setting Att__cloakDefn === <!--T:10-->
 Errors will result if you attempt to set Att__cloakdefn without the 0x0001 flag.
-  ade.Flags = ade.Flags & ~1;              // disallow hiding/unhiding of definitions
+  <!--T:11-->
+ade.Flags = ade.Flags & ~1;              // disallow hiding/unhiding of definitions
   [[CAObject]] xObj = ade.[[CAEngine::Get|Get]]("X");
   xObj.SetAttribute("Att__cloakDefn",0);    // fails
@@ Line 33: / Line 42: @@
   }
-= See Also =
+= See Also = <!--T:12-->
+</translate>

Difference between revisions of "CAEngine::Flags"