new ArchTraverseContext()
Extends
Members
-
static, readonly displayTypeName :string
-
Returns the display type name string 'ArchTraverseContext'.
-
readonly hierarchy :Array.<ArchTraverseHierarchyItem>
-
Returns the current traversal hierarchy for the traverse callback as an array of
ArchTraverseHierarchyItem
instances. For example, if you calledtraverse
on atask
and the traversal code was going through the actions available off of the actions property and it was on the second action, you would see one hierarchical item in this array that hierarchical item hold a pointer to the task in thearchBaseObject
property, theproperty name
would be 'actions' and theindex
property value would be 1. -
readonly hierarchyStr :string
-
Returns the
ArchTraverseHierarchyItem#hierarchyStr
string value from the last item in the hierarchy item array. If there are no items in the hierarchy array, this returns the string ''. This string is meant to be more informational than anything else. Instead of trying to parse the contents of the hierarchy string, we recommend using the ArchTraverseContext#hierarchy
array itself since it'll have the information that was used to build up this string as well as actual Architect Scripting object references as well. -
readonly isArchTraverseContext :boolean
-
Returns true indicating that this is an ArchTraverseContext instance.
-
readonly logStr :string
-
A string suitable for logging that contains information about this definition.
- Overrides:
-
readonly logStrTypeOnly :string
-
This is a string suitable for logging information about this object where it's just the object's type. This is normally used when logging errors that occur in constructor parameter checking because the scripting object isn't set up and the normal logging str contents wouldn't be set up.
- Overrides:
Methods
-
isFilterMatch(archFilterObject) → {boolean}
-
Returns whether or not this Architect Scripting object is a match for the supplied ArchFilterObject instance.
Parameters:
Name Type Description archFilterObject
ArchFilterObject the object filter to use to determine if it's a match.
Returns:
boolean- Overrides:
-
logError(errorStr)
-
Logs an error to the logging service with a log header from this object's
logStr
property value whenArchLogging#logErrors
is true.Parameters:
Name Type Description errorStr
string the error string to log.
- Overrides:
-
logErrorAndThrow(errorStr)
-
Logs an error to the logging service with a log header from this object's
logStr
property value whenArchLogging#logErrors
is true and then throws the string in the errorStr parameter.Parameters:
Name Type Description errorStr
string the error string to log. This should be a non-blank string.
Throws:
- Throws the submitted error string.
- Overrides:
-
logNote(noteStr)
-
Logs a note to the logging service with a log header from this object's
logStr
property value whenArchLogging#logNotes
is true.Parameters:
Name Type Description noteStr
string the note string to log. This should be a non-blank string.
- Overrides:
-
logNoteVerbose(noteStr)
-
Logs a note to the logging service with a log header from this object's
logStr
property value whenArchLogging#logNotesVerbose
is true.Parameters:
Name Type Description noteStr
string the note string to log. This should be a non-blank string.
- Overrides:
-
logWarning(warningStr)
-
Logs a warning to the logging service with a log header from this object's
logStr
property value whenArchLogging#logWarnings
is true.Parameters:
Name Type Description warningStr
string the warning string to log. This should be a non-blank string.
- Overrides: