Table of Contents

Class IOnvifClient.PullpointTopic

Namespace
VAST.ONVIF
Assembly
VAST.ONVIF.dll

Represents an ONVIF pullpoint event topic, including its metadata, associated rules, and helper methods for generating display names and identifier reference names.

public class IOnvifClient.PullpointTopic
Inheritance
IOnvifClient.PullpointTopic
Inherited Members

Constructors

PullpointTopic() 

public PullpointTopic()

Fields

MessageCount

The message key identifying the count element within a notification message.

public static readonly string MessageCount

Field Value

string

MessageIsInside

The message key identifying the "is inside" element within a notification message.

public static readonly string MessageIsInside

Field Value

string

MessageSource

The message key identifying the source element within a notification message.

public static readonly string MessageSource

Field Value

string

MessageState

The message key identifying the state element within a notification message.

public static readonly string MessageState

Field Value

string

MotionAlarmMessageKey

The message key used to identify motion alarm notifications.

public static readonly string MotionAlarmMessageKey

Field Value

string

TagsToIgnore

Tags that should be ignored when processing topic information.

public static readonly string[] TagsToIgnore

Field Value

string[]

TypeBoolean

The type name for boolean-valued topic messages.

public static readonly string TypeBoolean

Field Value

string

TypeInt

The type name for integer-valued topic messages.

public static readonly string TypeInt

Field Value

string

Properties

DisplayName

Gets the human-readable display name for this topic, composed from topic, service, and message.

public string DisplayName { get; }

Property Value

string

DisplayNameStarted

Gets the display name for this topic with a "Started" suffix appended.

public string DisplayNameStarted { get; }

Property Value

string

DisplayNameStopped

Gets the display name for this topic with a "Stopped" suffix appended.

public string DisplayNameStopped { get; }

Property Value

string

IdRefName

Gets the dot-separated identifier reference name for this topic, composed from topic, service, and message.

public string IdRefName { get; }

Property Value

string

IdRefNameStarted

Gets the dot-separated identifier reference name for this topic with a "Started" suffix appended.

public string IdRefNameStarted { get; }

Property Value

string

IdRefNameStopped

Gets the dot-separated identifier reference name for this topic with a "Stopped" suffix appended.

public string IdRefNameStopped { get; }

Property Value

string

Message

Gets or sets the message name associated with the topic.

public string Message { get; set; }

Property Value

string

Rules

Gets or sets the list of rules associated with this topic.

public List<IOnvifClient.PullpointRule> Rules { get; set; }

Property Value

List<IOnvifClient.PullpointRule>

Service

Gets or sets the service name associated with the topic.

public string Service { get; set; }

Property Value

string

Topic

Gets or sets the topic name.

public string Topic { get; set; }

Property Value

string

Type

Gets or sets the data type of the topic value.

public string Type { get; set; }

Property Value

string

Methods

DisplayNameIOT(string, string, string)

Gets the human-readable display name for an I/O event topic.

public string DisplayNameIOT(string category, string catCode, string profileName)

Parameters

category string

The event category name.

catCode string

The category code.

profileName string

The profile name associated with the event.

Returns

string

A formatted display name for the I/O event topic.

DisplayNameProfile(string, string)

Gets the human-readable display name for a specific source and profile.

public string DisplayNameProfile(string source, string profileName)

Parameters

source string

The source identifier.

profileName string

The profile name.

Returns

string

The display name including the source and profile name.

DisplayNameRule(string)

Gets the human-readable display name for a specific rule.

public string DisplayNameRule(string ruleName)

Parameters

ruleName string

The name of the rule.

Returns

string

The display name including the rule name.

DisplayNameRuleStarted(string)

Gets the human-readable display name for a specific rule with a "Started" suffix.

public string DisplayNameRuleStarted(string ruleName)

Parameters

ruleName string

The name of the rule.

Returns

string

The display name including the rule name and "Started" suffix.

DisplayNameRuleStopped(string)

Gets the human-readable display name for a specific rule with a "Stopped" suffix.

public string DisplayNameRuleStopped(string ruleName)

Parameters

ruleName string

The name of the rule.

Returns

string

The display name including the rule name and "Stopped" suffix.

IdRefNameProfile(string, string)

Gets the dot-separated identifier reference name for a specific source and profile.

public string IdRefNameProfile(string source, string profileName)

Parameters

source string

The source identifier.

profileName string

The profile name.

Returns

string

The dot-separated identifier reference name including the source and profile name.

IdRefNameRule(string)

Gets the dot-separated identifier reference name for a specific rule.

public string IdRefNameRule(string ruleName)

Parameters

ruleName string

The name of the rule.

Returns

string

The dot-separated identifier reference name including the rule name.

IdRefNameRuleStarted(string)

Gets the dot-separated identifier reference name for a specific rule with a "Started" suffix.

public string IdRefNameRuleStarted(string ruleName)

Parameters

ruleName string

The name of the rule.

Returns

string

The dot-separated identifier reference name including the rule name and "Started" suffix.

IdRefNameRuleStopped(string)

Gets the dot-separated identifier reference name for a specific rule with a "Stopped" suffix.

public string IdRefNameRuleStopped(string ruleName)

Parameters

ruleName string

The name of the rule.

Returns

string

The dot-separated identifier reference name including the rule name and "Stopped" suffix.

ToString()

Returns a string representation of this topic using the DisplayName property.

public override string ToString()

Returns

string

The human-readable display name of the topic.