Represents a VideoXpert system and allows the user to manage the system and devices. More...

#include <IVxSystem.h>

Public Member Functions
virtual VxResult::Value	AddBookmark (VxNewBookmark &newBookmark) const =0
	Adds a new bookmark on the VideoXpert system. More...

virtual VxResult::Value	AddDataObject (VxNewDataObject &newDataObject) const =0
	Creates a new data object. More...

virtual VxResult::Value	AddDevice (VxNewDevice &newDevice) const =0
	Adds a device to the VideoXpert system. More...

virtual VxResult::Value	AddDrawing (VxNewDrawing &newDrawing) const =0
	Creates a new drawing. More...

virtual VxResult::Value	AddManualRecording (VxNewManualRecording &newManualRecording, IVxManualRecording *&manualRecordingItem) const =0
	Adds a new manual recording to the VideoXpert system. More...

virtual VxResult::Value	AddNotification (VxNewNotification &newNotification, IVxNotification *&notificationItem) const =0
	Creates a new notification. More...

virtual VxResult::Value	AddRole (const char *roleName) const =0
	Adds a new role to the system. More...

virtual VxResult::Value	AddSchedule (VxNewSchedule &newSchedule) const =0
	Adds a new schedule to the system. More...

virtual VxResult::Value	AddSituation (VxNewSituation &newSituation) const =0
	Adds a new situation to the system. More...

virtual VxResult::Value	AddTag (VxNewTag &newTag) const =0
	Adds a new tag to the system. More...

virtual VxResult::Value	AddUser (VxNewUser &newUser) const =0
	Adds a new user to the system. More...

virtual VxResult::Value	AutoAddDevices () const =0
	Initiates a network search on the VideoXpert system which automatically adds any new Pelco devices discovered. More...

virtual VxResult::Value	CreateExport (VxNewExport &newExport, IVxExport *&exportItem) const =0
	Creates a new export on the VideoXpert system. More...

virtual VxResult::Value	CreateMonitor (VxNewMonitor &newMonitor) const =0
	Adds a new monitor to the system. More...

virtual VxResult::Value	CreateQuickLog (IVxQuickLog *&quickLog) const =0
	Creates a quick log on the VideoXpert system. More...

virtual VxResult::Value	CreateQuickReport (VxNewQuickReport &newQuickReport, IVxQuickReport *&quickReport) const =0
	Creates a quick system health report on the VideoXpert system. More...

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

virtual VxResult::Value	GetAlarmInputs (VxCollection< IVxAlarmInput ** > &alarmInputCollection) const =0
	Gets the alarm inputs residing on the system. More...

virtual VxResult::Value	GetBookmarks (VxCollection< IVxBookmark ** > &bookmarkCollection) const =0
	Gets the bookmarks residing on the system. More...

virtual VxResult::Value	GetClusterConfiguration (IVxConfiguration::Cluster *&clusterConfig) const =0
	Gets the cluster configuration. More...

virtual VxResult::Value	GetCurrentUser (IVxUser *&user) const =0
	Gets the user currently accessing the system. More...

virtual VxResult::Value	GetDataObjects (VxCollection< IVxDataObject ** > &dataObjectCollection) const =0
	Gets the data objects residing on the system. More...

virtual VxResult::Value	GetDataSources (VxCollection< IVxDataSource ** > &dataSourceCollection) const =0
	Gets the data sources from the VideoXpert system. More...

virtual VxResult::Value	GetDataStorages (VxCollection< IVxDataStorage ** > &dataStorageCollection) const =0
	Gets the data storages residing on the system. More...

virtual VxResult::Value	GetDeviceAssignments (VxCollection< IVxDeviceAssignment ** > &deviceAssignmentCollection) const =0
	Gets the device assignments residing on the system. More...

virtual VxResult::Value	GetDevices (VxCollection< IVxDevice ** > &deviceCollection) const =0
	Gets the devices from the VideoXpert system. More...

virtual VxResult::Value	GetDeviceSearchStatus (VxDeviceSearchStatus::Value &status) const =0
	Gets the current VxDeviceSearchStatus of an `AutoAddDevices` search. More...

virtual VxResult::Value	GetDrawings (VxCollection< IVxDrawing ** > &drawingCollection) const =0
	Gets the drawings from the VideoXpert system. More...

virtual VxResult::Value	GetEvents (VxCollection< IVxEvent ** > &eventCollection) const =0
	Gets the events residing on the system. More...

virtual VxResult::Value	GetExports (VxCollection< IVxExport ** > &exportCollection) const =0
	Gets the exports residing on the system. More...

virtual VxResult::Value	GetHostDevice (IVxDevice *&hostDevice) const =0
	Gets the IVxDevice that hosts this system. More...

virtual VxResult::Value	GetLicense (IVxLicense *&license) const =0
	Gets the license for the system. More...

virtual VxResult::Value	GetManualRecordings (VxCollection< IVxManualRecording ** > &manualRecordingCollection) const =0
	Gets the manual recordings residing on the system. More...

virtual VxResult::Value	GetMonitors (VxCollection< IVxMonitor ** > &monitorCollection) const =0
	Gets the monitors residing on the system. More...

virtual VxResult::Value	GetNotifications (VxCollection< IVxNotification ** > &notificationCollection) const =0
	Gets the notifications residing on the system. More...

virtual VxResult::Value	GetRelayOutputs (VxCollection< IVxRelayOutput ** > &relayOutputCollection) const =0
	Gets the relay outputs residing on the system. More...

virtual VxResult::Value	GetRoles (VxCollection< IVxRole ** > &roleCollection) const =0
	Gets the roles residing on the system. More...

virtual VxResult::Value	GetSchedules (VxCollection< IVxSchedule ** > &scheduleCollection) const =0
	Gets the schedules residing on the system. More...

virtual VxResult::Value	GetSituations (VxCollection< IVxSituation ** > &situationCollection) const =0
	Gets the situations residing on the system. More...

virtual VxResult::Value	GetTags (VxCollection< IVxTag ** > &tagCollection) const =0
	Gets the tags residing on the system. More...

virtual VxResult::Value	GetUsers (VxCollection< IVxUser ** > &userCollection) const =0
	Gets the users residing on the system. More...

virtual VxResult::Value	InsertEvent (VxNewEvent &newEvent) const =0
	Inserts a new event into the system. 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	SetName (char name[64])=0
	Sets the name property. More...

virtual VxResult::Value	StartInternalNotifications (VxInternalEventCallback callback) const =0
	Start receiving internal event notifications sent by the VxSDK. More...

virtual VxResult::Value	StartNotifications (VxEventCallback callback) const =0
	Start receiving event notifications using the settings for the current user. More...

virtual VxResult::Value	StartNotifications (VxEventCallback callback, VxCollection< IVxSituation ** > &situationCollection) const =0
	Start receiving event notifications by situation type, regardless of user settings. More...

virtual VxResult::Value	StopInternalNotifications () const =0
	Stop receiving all internal event notifications. More...

virtual VxResult::Value	StopNotifications () const =0
	Stop receiving all event notifications. More...

Public Attributes
char	id [64]
	The unique identifier of the VideoXpert system. More...

char	name [64]
	The friendly name of the VideoXpert system. More...

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

Detailed Description

Represents a VideoXpert system and allows the user to manage the system and devices.

Definition at line 34 of file IVxSystem.h.

Member Function Documentation

virtual VxResult::Value VxSdk::IVxSystem::AddBookmark ( VxNewBookmark & newBookmark ) const

pure virtual

Adds a new bookmark on the VideoXpert system.

Parameters

newBookmark The new bookmark to be added to the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::AddDataObject ( VxNewDataObject & newDataObject ) const

pure virtual

Creates a new data object.

Parameters

newDataObject The new data object to be added.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::AddDevice ( VxNewDevice & newDevice ) const

pure virtual

Adds a device to the VideoXpert system.

Parameters

newDevice The new device to be added.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::AddDrawing ( VxNewDrawing & newDrawing ) const

pure virtual

Creates a new drawing.

Parameters

newDrawing The new drawing to be added.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::AddManualRecording	(	VxNewManualRecording &	newManualRecording,
		IVxManualRecording *&	manualRecordingItem
	)		const

pure virtual

Adds a new manual recording to the VideoXpert system.

Parameters

newManualRecording	The new manual recording to be added to the system.
manualRecordingItem	`nullptr` if it fails, else the new IVxManualRecording.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::AddNotification	(	VxNewNotification &	newNotification,
		IVxNotification *&	notificationItem
	)		const

pure virtual

Creates a new notification.

Parameters

newNotification	The new notification to be added.
notificationItem	`nullptr` if it fails, else the new IVxNotification.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::AddRole ( const char * roleName ) const

pure virtual

Adds a new role to the system.

Parameters

roleName The new role to be added.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::AddSchedule ( VxNewSchedule & newSchedule ) const

pure virtual

Adds a new schedule to the system.

Parameters

newSchedule The new schedule to be added.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::AddSituation ( VxNewSituation & newSituation ) const

pure virtual

Adds a new situation to the system.

Parameters

newSituation The new situation to be added to the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::AddTag ( VxNewTag & newTag ) const

pure virtual

Adds a new tag to the system.

Parameters

newTag The new tag to be added.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::AddUser ( VxNewUser & newUser ) const

pure virtual

Adds a new user to the system.

Parameters

newUser The new user to be added.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::AutoAddDevices ( ) const

pure virtual

Initiates a network search on the VideoXpert system which automatically adds any new Pelco devices discovered.

Returns: The Result of the request.

void VxSdk::IVxSystem::Clear ( )

inlineprotected

Clears this instance.

Definition at line 368 of file IVxSystem.h.

                      {
             VxZeroArray(this->id);
             VxZeroArray(this->name);
         }

virtual VxResult::Value VxSdk::IVxSystem::CreateExport	(	VxNewExport &	newExport,
		IVxExport *&	exportItem
	)		const

pure virtual

Creates a new export on the VideoXpert system.

Parameters

newExport	The new export to be added to the system.
exportItem	`nullptr` if it fails, else the new IVxExport.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::CreateMonitor ( VxNewMonitor & newMonitor ) const

pure virtual

Adds a new monitor to the system.

Parameters

newMonitor The new monitor to be added to the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::CreateQuickLog ( IVxQuickLog *& quickLog ) const

pure virtual

Creates a quick log on the VideoXpert system.

Parameters

quickLog nullptr if it fails, else the new IVxQuickLog.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::CreateQuickReport	(	VxNewQuickReport &	newQuickReport,
		IVxQuickReport *&	quickReport
	)		const

pure virtual

Creates a quick system health report on the VideoXpert system.

Parameters

newQuickReport	The new quick report to be generated on the system.
quickReport	`nullptr` if it fails, else the new IVxQuickReport.

Returns: The Result of the request.

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

pure virtual

Deletes this instance.

Returns: The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxSystem::GetAlarmInputs ( VxCollection< IVxAlarmInput ** > & alarmInputCollection ) const

pure virtual

Gets the alarm inputs residing on the system.

Available filters: kModifiedSince, kName, kState.

Parameters

alarmInputCollection A VxCollection of the alarm inputs residing on the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetBookmarks ( VxCollection< IVxBookmark ** > & bookmarkCollection ) const

pure virtual

Gets the bookmarks residing on the system.

Available filters: kDataSourceId, kDataSourceName, kDataSourceNumber, kDescription, kModifiedSince, kName, kSearchEndTime, kSearchStartTime, kTime.

Parameters

bookmarkCollection A VxCollection of the bookmarks residing on the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetClusterConfiguration ( IVxConfiguration::Cluster *& clusterConfig ) const

pure virtual

Gets the cluster configuration.

Parameters

clusterConfig The cluster configuration..

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetCurrentUser ( IVxUser *& user ) const

pure virtual

Gets the user currently accessing the system.

Parameters

user	The user currently accessing the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetDataObjects ( VxCollection< IVxDataObject ** > & dataObjectCollection ) const

pure virtual

Gets the data objects residing on the system.

Available filters: kClientType, kModifiedSince, kOwned, kOwner.

Parameters

dataObjectCollection A VxCollection of data objects residing on the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetDataSources ( VxCollection< IVxDataSource ** > & dataSourceCollection ) const

pure virtual

Gets the data sources from the VideoXpert system.

Available filters: kAllTags, kAllPrivateTags, kCapturing, kId, kIp, kManualRecording, kModifiedSince, kName, kNumber, kRecording, kState, kType, kUnassigned.

Parameters

dataSourceCollection A VxCollection of the data sources associated with the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetDataStorages ( VxCollection< IVxDataStorage ** > & dataStorageCollection ) const

pure virtual

Gets the data storages residing on the system.

Available filters: kId, kModifiedSince, kName, kType.

Parameters

dataStorageCollection A VxCollection of data storages residing on the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetDeviceAssignments ( VxCollection< IVxDeviceAssignment ** > & deviceAssignmentCollection ) const

pure virtual

Gets the device assignments residing on the system.

Available filters: kDataSourceId, kModifiedSince.

Parameters

deviceAssignmentCollection A VxCollection of the device assignments.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetDevices ( VxCollection< IVxDevice ** > & deviceCollection ) const

pure virtual

Gets the devices from the VideoXpert system.

Available filters: kAllTags, kAllPrivateTags, kCommissioned, kHasStatus, kId, kIp, kModel, kModifiedSince, kName, kSerial, kState, kType, kVendor, kVersion.

Parameters

deviceCollection A VxCollection of the devices associated with the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetDeviceSearchStatus ( VxDeviceSearchStatus::Value & status ) const

pure virtual

Gets the current VxDeviceSearchStatus of an AutoAddDevices search.

Parameters

status The current status of an AutoAddDevices search.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetDrawings ( VxCollection< IVxDrawing ** > & drawingCollection ) const

pure virtual

Gets the drawings from the VideoXpert system.

Available filters: kModifiedSince, kName.

Parameters

drawingCollection A VxCollection of the drawings associated with the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetEvents ( VxCollection< IVxEvent ** > & eventCollection ) const

pure virtual

Gets the events residing on the system.

Available filters: kAckState, kAckUser, kGeneratorDeviceId, kId, kModifiedSince, kNotifies, kSearchEndTime, kSearchStartTime, kSeverity, kSituationType, kSourceDeviceId, kSourceUserName, kTime.

Parameters

eventCollection A VxCollection of the events residing on the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetExports ( VxCollection< IVxExport ** > & exportCollection ) const

pure virtual

Gets the exports residing on the system.

Available filters: kDataSourceAllTags, kDataSourceAllPrivateTags, kDataSourceName, kDataSourceNumber, kModifiedSince, kName, kOwner, kPercentComplete, kSize, kStatus.

Parameters

exportCollection A VxCollection of the exports residing on the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetHostDevice ( IVxDevice *& hostDevice ) const

pure virtual

Gets the IVxDevice that hosts this system.

Parameters

hostDevice The host IVxDevice.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetLicense ( IVxLicense *& license ) const

pure virtual

Gets the license for the system.

Parameters

license The license for the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetManualRecordings ( VxCollection< IVxManualRecording ** > & manualRecordingCollection ) const

pure virtual

Gets the manual recordings residing on the system.

Available filters: kDataSourceId, kId, kModifiedSince, kOwner.

Parameters

manualRecordingCollection A VxCollection of the manual recordings residing on the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetMonitors ( VxCollection< IVxMonitor ** > & monitorCollection ) const

pure virtual

Gets the monitors residing on the system.

Available filters: kModifiedSince, kName, kNumber.

Parameters

monitorCollection A VxCollection of the monitors residing on the system.

Returns: The Result of the request.

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

pure virtual

Gets the notifications residing on the system.

Available filters: kModifiedSince.

Parameters

notificationCollection A VxCollection of the notifications residing on the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetRelayOutputs ( VxCollection< IVxRelayOutput ** > & relayOutputCollection ) const

pure virtual

Gets the relay outputs residing on the system.

Available filters: kModifiedSince, kName, kState.

Parameters

relayOutputCollection A VxCollection of the relay outputs residing on the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetRoles ( VxCollection< IVxRole ** > & roleCollection ) const

pure virtual

Gets the roles residing on the system.

Available filters: kId, kInternal, kModifiedSince, kName.

Parameters

roleCollection A VxCollection of roles residing on the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetSchedules ( VxCollection< IVxSchedule ** > & scheduleCollection ) const

pure virtual

Gets the schedules residing on the system.

Available filters: kAction, kModifiedSince, kName.

Parameters

scheduleCollection A VxCollection of schedules residing on the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetSituations ( VxCollection< IVxSituation ** > & situationCollection ) const

pure virtual

Gets the situations residing on the system.

Available filters: kAudibleNotify, kHasProperty, kLog, kModifiedSince, kName, kNotify, kServicePropertyId, kSeverity, kSourceDeviceId, kType.

Parameters

situationCollection A VxCollection of the situations residing on the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetTags ( VxCollection< IVxTag ** > & tagCollection ) const

pure virtual

Gets the tags residing on the system.

Available filters: kId, kModifiedSince, kName, kOwned, kOwner, kResourceId, kResourceType.

Parameters

tagCollection A VxCollection of tags residing on the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::GetUsers ( VxCollection< IVxUser ** > & userCollection ) const

pure virtual

Gets the users residing on the system.

Available filters: kFirstName, kLastName, kModifiedSince, kName.

Parameters

userCollection A VxCollection of users residing on the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::InsertEvent ( VxNewEvent & newEvent ) const

pure virtual

Inserts a new event into the system.

Parameters

newEvent The new event to be injected into the system.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::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::IVxSystem::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::IVxSystem::StartInternalNotifications ( VxInternalEventCallback callback ) const

pure virtual

Start receiving internal event notifications sent by the VxSDK.

Parameters

callback The callback to be used when an internal event is received.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::StartNotifications ( VxEventCallback callback ) const

pure virtual

Start receiving event notifications using the settings for the current user.

Parameters

callback The callback to be used when an event is received.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::StartNotifications	(	VxEventCallback	callback,
		VxCollection< IVxSituation ** > &	situationCollection
	)		const

pure virtual

Start receiving event notifications by situation type, regardless of user settings.

Parameters

callback	The callback to be used when an event is received.
situationCollection	The situations to subscribe to.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::StopInternalNotifications ( ) const

pure virtual

Stop receiving all internal event notifications.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSystem::StopNotifications ( ) const

pure virtual

Stop receiving all event notifications.

Returns: The Result of the request.

Member Data Documentation

char VxSdk::IVxSystem::id[64]

The unique identifier of the VideoXpert system.

Definition at line 358 of file IVxSystem.h.

char VxSdk::IVxSystem::name[64]

The friendly name of the VideoXpert system.

Definition at line 362 of file IVxSystem.h.

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation