Represents a particular situation configuration that specifies how corresponding events shall be generated and handled when the situation is detected. More...

#include <IVxSituation.h>

Public Member Functions
virtual VxResult::Value	AddNotification (IVxNotification &notification) const =0
	Adds a notification to the list of notifications that this situation serves. More...

virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...

virtual VxResult::Value	DeleteSituation () const =0
	Deletes this situation from the VideoXpert system. More...

virtual VxResult::Value	GetLinks (VxCollection< IVxDataSource ** > &dataSourceCollection) const =0
	Gets the data sources associated with this situation. More...

virtual VxResult::Value	GetLinks (VxCollection< IVxDevice ** > &deviceCollection) const =0
	Gets the devices associated with this situation. More...

virtual VxResult::Value	GetNotifications (VxCollection< IVxNotification ** > &notificationCollection) const =0
	Gets the notifications associated with this situation. More...

virtual VxResult::Value	Link (IVxDataSource &dataSource) const =0
	Associates a data source with this situation. More...

virtual VxResult::Value	Link (IVxDevice &device) const =0
	Associates a device with this situation. More...

virtual VxResult::Value	Refresh ()=0
	Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...

virtual VxResult::Value	RemoveNotification (IVxNotification &notification) const =0
	Removes a notification from the list of notifications that this situation serves. More...

virtual VxResult::Value	SetAckNeeded (bool isAckNeeded)=0
	Sets whether the generated events shall have an initial state of AckNeeded or NoAckNeeded. More...

virtual VxResult::Value	SetAudibleLoopDelay (int audibleLoopDelay)=0
	Sets the audible loop delay property. More...

virtual VxResult::Value	SetAudiblePlayCount (int audiblePlayCount)=0
	Sets the audible play count property. More...

virtual VxResult::Value	SetAudiblyNotify (bool shouldAudiblyNotify)=0
	Sets whether a notification sound should play on supporting clients when an event is received. More...

virtual VxResult::Value	SetAutoAcknowledgeTime (int autoAcknowledgeTime)=0
	Sets the auto acknowledge time property. More...

virtual VxResult::Value	SetExpandBanner (bool shouldExpandBanner)=0
	Sets whether the notification banner on clients should be expanded by default. More...

virtual VxResult::Value	SetLog (bool shouldLog)=0
	Sets whether events generated from this situation shall be persisted or immediately be discarded. More...

virtual VxResult::Value	SetNotify (bool shouldNotify)=0
	Sets whether an event generated from the situation will generate notifications. More...

virtual VxResult::Value	SetName (char name[64])=0
	Sets the name property. More...

virtual VxResult::Value	SetSeverity (int severity)=0
	Sets the severity property. More...

virtual VxResult::Value	SetSnoozeIntervals (int *snoozeIntervals, int snoozeIntervalSize)=0
	Sets the snooze intervals for a generated event. More...

virtual VxResult::Value	UnLink (IVxDataSource &dataSource) const =0
	Removes a data source association from this situation. More...

virtual VxResult::Value	UnLink (IVxDevice &device) const =0
	Removes a device association from this situation. More...

Public Attributes
bool	isAckNeeded
	Indicates whether the generated events shall have an initial state of AckNeeded or NoAckNeeded. More...

bool	shouldAudiblyNotify
	Indicates whether a notification sound should play on supporting clients when an event is received. More...

bool	shouldExpandBanner
	Indicates whether the notification banner on clients should be expanded by default. More...

bool	shouldLog
	Indicates whether events generated from this situation shall be persisted or immediately be discarded. More...

bool	shouldNotify
	Indicates whether an event generated from the situation shall generate notifications. More...

char	name [64]
	The friendly name of the situation. More...

char	servicePropertyId [64]
	The name of the key in the properties map corresponding to the service identifier for the source of this situation, if any. More...

char	serviceType [64]
	Specifies the resource type of the service corresponding to the source of this situation, if any. More...

char	sourceDeviceId [64]
	The unique identifier of the source device. More...

char	type [128]
	The situation type. More...

char **	notificationIds
	The unique identifiers of the notifications configured for this situation. More...

int	autoAcknowledgeTime
	The number of seconds after which a generated event state will be set to AutoAcked. More...

int	audibleLoopDelay
	The seconds to wait between audible notifications. More...

int	audiblePlayCount
	The amount of times to play audible notifications. More...

int	notificationIdSize
	The size of notificationIds. More...

int	severity
	The severity of the generated event, from 1 (highest) to 10 (lowest). More...

int	snoozeIntervalSize
	The size of snoozeIntervals. More...

int *	snoozeIntervals
	The default snooze intervals, in seconds, for a generated event. More...

Protected Member Functions
void	Clear ()
	Clears this instance. More...

Detailed Description

Represents a particular situation configuration that specifies how corresponding events shall be generated and handled when the situation is detected.

Definition at line 13 of file IVxSituation.h.

Member Function Documentation

virtual VxResult::Value VxSdk::IVxSituation::AddNotification ( IVxNotification & notification ) const

pure virtual

Adds a notification to the list of notifications that this situation serves.

Parameters

notification The notification to be added.

Returns: The Result of the request.

void VxSdk::IVxSituation::Clear ( )

inlineprotected

Clears this instance.

Definition at line 233 of file IVxSituation.h.

                      {
             this->isAckNeeded = false;
             this->shouldAudiblyNotify = false;
             this->shouldExpandBanner = false;
             this->shouldLog = false;
             this->shouldNotify = false;
             VxZeroArray(this->name);
             VxZeroArray(this->servicePropertyId);
             VxZeroArray(this->serviceType);
             VxZeroArray(this->sourceDeviceId);
             VxZeroArray(this->type);
             this->notificationIds = nullptr;
             this->autoAcknowledgeTime = 0;
             this->audibleLoopDelay = 0;
             this->audiblePlayCount = 0;
             this->notificationIdSize = 0;
             this->severity = 0;
             this->snoozeIntervalSize = 0;
             this->snoozeIntervals = nullptr;
         }

virtual VxResult::Value VxSdk::IVxSituation::Delete ( ) const

pure virtual

Deletes this instance.

Returns: The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxSituation::DeleteSituation ( ) const

pure virtual

Deletes this situation from the VideoXpert system.

Returns: The Result of deleting the situation.

virtual VxResult::Value VxSdk::IVxSituation::GetLinks ( VxCollection< IVxDataSource ** > & dataSourceCollection ) const

pure virtual

Gets the data sources associated with this situation.

Available filters: kAllTags, kAllPrivateTags, kModifiedSince.

Parameters

dataSourceCollection The data sources associated with this situation.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSituation::GetLinks ( VxCollection< IVxDevice ** > & deviceCollection ) const

pure virtual

Gets the devices associated with this situation.

Available filters: kAllTags, kAllPrivateTags, kModifiedSince.

Parameters

deviceCollection The devices associated with this situation.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSituation::GetNotifications ( VxCollection< IVxNotification ** > & notificationCollection ) const

pure virtual

Gets the notifications associated with this situation.

Available filters: kModifiedSince.

Parameters

notificationCollection A VxCollection of notifications associated with this situation.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSituation::Link ( IVxDataSource & dataSource ) const

pure virtual

Associates a data source with this situation.

Parameters

dataSource The data source to associate the situation with.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSituation::Link ( IVxDevice & device ) const

pure virtual

Associates a device with this situation.

Parameters

device The device to associate the situation with.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSituation::Refresh ( )

pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns: The Result of refreshing the member values for this object.

virtual VxResult::Value VxSdk::IVxSituation::RemoveNotification ( IVxNotification & notification ) const

pure virtual

Removes a notification from the list of notifications that this situation serves.

Parameters

notification The notification to be removed.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSituation::SetAckNeeded ( bool isAckNeeded )

pure virtual

Sets whether the generated events shall have an initial state of AckNeeded or NoAckNeeded.

Parameters

isAckNeeded True to set initial state to AckNeeded. False for NoAckNeeded.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxSituation::SetAudibleLoopDelay ( int audibleLoopDelay )

pure virtual

Sets the audible loop delay property.

Parameters

audibleLoopDelay The audible loop delay value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxSituation::SetAudiblePlayCount ( int audiblePlayCount )

pure virtual

Sets the audible play count property.

Parameters

audiblePlayCount The audible play count value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxSituation::SetAudiblyNotify ( bool shouldAudiblyNotify )

pure virtual

Sets whether a notification sound should play on supporting clients when an event is received.

Parameters

shouldAudiblyNotify True to audibly notify, otherwise false.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxSituation::SetAutoAcknowledgeTime ( int autoAcknowledgeTime )

pure virtual

Sets the auto acknowledge time property.

Parameters

autoAcknowledgeTime The auto acknowledge time value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxSituation::SetExpandBanner ( bool shouldExpandBanner )

pure virtual

Sets whether the notification banner on clients should be expanded by default.

Parameters

shouldExpandBanner True to expand banner, otherwise false.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxSituation::SetLog ( bool shouldLog )

pure virtual

Sets whether events generated from this situation shall be persisted or immediately be discarded.

Parameters

shouldLog True to log events, otherwise false.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxSituation::SetName ( char name[64] )

pure virtual

Sets the name property.

Parameters

name	The new name value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxSituation::SetNotify ( bool shouldNotify )

pure virtual

Sets whether an event generated from the situation will generate notifications.

Parameters

shouldNotify True to send notifications, otherwise false.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxSituation::SetSeverity ( int severity )

pure virtual

Sets the severity property.

Parameters

severity The new severity value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxSituation::SetSnoozeIntervals	(	int *	snoozeIntervals,
		int	snoozeIntervalSize
	)

pure virtual

Sets the snooze intervals for a generated event.

Parameters

snoozeIntervals	The snooze intervals, in seconds.
snoozeIntervalSize	The size of snoozeIntervals.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxSituation::UnLink ( IVxDataSource & dataSource ) const

pure virtual

Removes a data source association from this situation.

Parameters

dataSource The data source to remove association with.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSituation::UnLink ( IVxDevice & device ) const

pure virtual

Removes a device association from this situation.

Parameters

device The device to remove association with.

Returns: The Result of the request.

Member Data Documentation

int VxSdk::IVxSituation::audibleLoopDelay

The seconds to wait between audible notifications.

Definition at line 207 of file IVxSituation.h.

int VxSdk::IVxSituation::audiblePlayCount

The amount of times to play audible notifications.

Definition at line 211 of file IVxSituation.h.

int VxSdk::IVxSituation::autoAcknowledgeTime

The number of seconds after which a generated event state will be set to AutoAcked.

Definition at line 203 of file IVxSituation.h.

bool VxSdk::IVxSituation::isAckNeeded

Indicates whether the generated events shall have an initial state of AckNeeded or NoAckNeeded.

Definition at line 159 of file IVxSituation.h.

char VxSdk::IVxSituation::name[64]

The friendly name of the situation.

Definition at line 179 of file IVxSituation.h.

char** VxSdk::IVxSituation::notificationIds

The unique identifiers of the notifications configured for this situation.

Definition at line 199 of file IVxSituation.h.

int VxSdk::IVxSituation::notificationIdSize

The size of notificationIds.

Definition at line 215 of file IVxSituation.h.

char VxSdk::IVxSituation::servicePropertyId[64]

The name of the key in the properties map corresponding to the service identifier for the source of this situation, if any.

Definition at line 183 of file IVxSituation.h.

char VxSdk::IVxSituation::serviceType[64]

Specifies the resource type of the service corresponding to the source of this situation, if any.

Definition at line 187 of file IVxSituation.h.

int VxSdk::IVxSituation::severity

The severity of the generated event, from 1 (highest) to 10 (lowest).

Definition at line 219 of file IVxSituation.h.

bool VxSdk::IVxSituation::shouldAudiblyNotify

Indicates whether a notification sound should play on supporting clients when an event is received.

Definition at line 163 of file IVxSituation.h.

bool VxSdk::IVxSituation::shouldExpandBanner

Indicates whether the notification banner on clients should be expanded by default.

Definition at line 167 of file IVxSituation.h.

bool VxSdk::IVxSituation::shouldLog

Indicates whether events generated from this situation shall be persisted or immediately be discarded.

Definition at line 171 of file IVxSituation.h.

bool VxSdk::IVxSituation::shouldNotify

Indicates whether an event generated from the situation shall generate notifications.

Definition at line 175 of file IVxSituation.h.

int* VxSdk::IVxSituation::snoozeIntervals

The default snooze intervals, in seconds, for a generated event.

Definition at line 227 of file IVxSituation.h.

int VxSdk::IVxSituation::snoozeIntervalSize

The size of snoozeIntervals.

Definition at line 223 of file IVxSituation.h.

char VxSdk::IVxSituation::sourceDeviceId[64]

The unique identifier of the source device.

Definition at line 191 of file IVxSituation.h.

char VxSdk::IVxSituation::type[128]

The situation type.

Definition at line 195 of file IVxSituation.h.

The documentation for this struct was generated from the following file:

C:/Git/VXSDK_M3/VxSdk/Include/IVxSituation.h

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation