ResultQuery Object


Description:

Results that match this query will be related to the parent ResultDataSet object using the parent's ResultChild relation.

Parents: ResultDataSet

Children: ChartAxisMapping

Result children (automatically created): ExternalEquationResultProperty

Relations:

Side name
(Type)
Relative Description
ResultFilter
(ResultFilters)

CounterResultFilter, RxPortResultFilter, StreamBlockResultFilter

Parent query.

ResultQuery Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
ArchivingOption

Archiving option.

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

None.

PERIODIC

Periodic.

UPDATE

Update.

ConfigClassId

Type of object that is the parent of the result (specified in ResultClassId). For example, if ResultClassId is dhcpv4.Dhcpv4PortResults, then the ConfigClassId can be either dhcpv4.Dhcpv4PortConfig, core.Port, or framework.Project.

Type: classId

Default: 0

PropertyHandleArray

Handles of the properties to get.

Type: handle

Default: 0

PropertyIdArray

Properties to get. The properties must be properties of ResultClassId.

Type: propertyId

Default: 0

ResultClassId

Type of result object.

Type: classId

Default: 0

ResultOptions

Currently only used when subscribing to event messages. In this case it is a ;-delimited string of event message types.

Type: string

Default: "" (empty string)

ResultRootList

A list of object handles under which to search for results. For example, if it contains handle of project, query refers to all results; if it contains the handles for port1 and port2, it refers to all results under port 1 and 2.

Type: handle

Default: 0

ResultQuery Read-Only Attributes

There are no read-only attributes.