Skip to content

Latest commit

 

History

History
94 lines (71 loc) · 2.18 KB

datacollectiontarget.adoc

File metadata and controls

94 lines (71 loc) · 2.18 KB

DataCollectionTarget

Abstract class that represents any object that can collect data. Extends [class-netobj].

Instance attributes

templates ⇒ Array

Returns array of templates ([class-template]) applied on this object. Return value also affected by trusted nodes settings.

Example
// Log names and ids of all accessible templates for current node
templates = $node.templates;
foreach(t : templates)
{
	trace(1, "Template object: name='" .. t.name .. "' id=" .. t.id);
}

Instance methods

applyTemplate(template) ⇒ void
Note
This method is enabled by default, but can be disabled by setting configuration parameter "NXSL.EnableContainerFunctions".

Apply template to node

Table 1. Parameters

template

[class-template]

Template object to apply

enableConfigurationPolling(flag) ⇒ void

Enable or disable configuration polling for a node

Table 2. Parameters

flag

Boolean

If configuration polling should be enabled.

enableDataCollection(flag) ⇒ void

Enable or disable data collection polling for a node.

Table 3. Parameters

flag

Boolean

If data collection polls should be enabled.

enableStatusPolling(flag) ⇒ void

Enable or disable status polling for a node.

Table 4. Parameters

flag

Boolean

If status polls should be enabled.

readInternalParameter(name) ⇒ String

Reads object internal metric (metric with source "Internal").

Table 5. Parameters

name

String

Metric name.

readInternalTable(name) ⇒ String

Reads object internal table metric (metric with source "Internal").

Table 6. Parameters

name

String

Metric name.

removeTemplate(template) ⇒ void
Note
This method is enabled by default, but can be disabled by setting configuration parameter "NXSL.EnableContainerFunctions".

Remove template from node

Table 7. Parameters

template

[class-template]

Template object to remove