|
<NAME>
|
The
Name title indicates the name string used to identify the law symbol; however, this is not necessarily the string that is entered when using the law symbol.
|
|
|
The
Names are presented in uppercase letters. In the default law parsing mode, law symbol names are not case sensitive and are converted in the internal representation to uppercase.
|
|
|
Several law symbols contain only symbolic characters, such as +, -, /, *, and ^, and not alphanumeric characters. In these cases, the
Name is in lowercase letters and is not the actual symbolic character(s), but rather a string that relates to the class used to implement the law symbol. The
Syntax field shows the actual symbolic character(s) to use.
|
|
|
The
Nameconstant, referring to the
C++constant_law class, refers to a constant integer or real number. The
Syntax field shows the character #, which means a number (generally an integer) should be entered in its place.
|
|
|
The symbol # is also used in the
Name field to indicate that an integer must be used as part of the law symbol. For example,
A# (from the
identity_law class) means that
A0,
A1, etc. is entered when using the law symbol. Similarly,
EDGE#,
WIRE#, and
SURF# require integers as part of their usage.
|
|
|
Action:
|
The
Action field summarizes what the law symbol does.
|
|
|
Derivation:
|
The
Derivation field specifies the class and its derivation for the given law symbol. The class for the law symbol is always listed on the left, followed by its parent, grandparent, etc. The last class in the list is always a base class, indicated by a trailing hyphen (-). Classes with no parents (base classes) show only the class name and a trailing hyphen (-).
|
|
|
Syntax:
|
The
Syntax field describes how the law symbol is entered by the user. The following font and punctuation conventions are used to represent different components of the syntax:
|
|
|
Bold
|
Bold-faced letters denote the law symbol name. Nonbold-faced letters denote arguments to the law symbol, if applicable. The arguments are other law symbols. The law symbol name is presented in uppercase. However, in the default law parsing mode, law symbol names are not case sensitive.
|
|
|
()
|
Parentheses surround all of the arguments to the law symbol.
|
|
|
[]
|
Square brackets represent optional syntax elements.
|
|
|
...
|
Horizontal ellipsis points indicate the omission of several items in a list. In the following example, the law symbol takes a list of two or more laws and one or more step numbers as arguments:
|
|
|
|
STEP (<law1>, num1, ..., <law>, num)
|
|
|
#
|
Indicates that a number should be entered in place of the #.
|
|
|
Description:
|
The
Description field describes the law symbol, its use, its arguments, the dimensions of its arguments, and the surrounding conditions.
|
|
|
Example:
|
The
Example field contains a Scheme example that illustrates how the law symbol can be used. The law symbol may be used in combination with others to build a law function string. When the string containing the law function is passed into the
law Scheme extension (which defines a law Scheme data type), it is enclosed within double-quotation marks. The quotation marks surround only the outer-most law symbol in the law function definition.
|
|
|
Comment lines are indicated in the Scheme example by a leading single semicolon
(;). Text lines returned as output by the extension are indicated by leading double semicolons (;;). Refer to the
Scheme Extension Template description in the
3D ACIS Online Help User's Guide for more information on Scheme examples.
|