Represents a physical alarm input. More...

#include <IVxAlarmInput.h>

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

virtual VxResult::Value	GetHostDevice (IVxDevice *&hostDevice) const =0
	Gets the IVxDevice that hosts this alarm input. 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	SetDescription (char *description)=0
	Sets the description property. More...

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

Public Attributes
char	description [256]
	The friendly description of the alarm input. More...

char	id [64]
	The unique identifier of the alarm input. More...

char	name [64]
	The friendly name of the alarm input. More...

VxAlarmState::Value	state
	The current state of the alarm input. More...

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

Detailed Description

Represents a physical alarm input.

Definition at line 14 of file IVxAlarmInput.h.

Member Function Documentation

void VxSdk::IVxAlarmInput::Clear ( )

inlineprotected

Clears this instance.

Definition at line 67 of file IVxAlarmInput.h.

                      {
             VxZeroArray(this->description);
             VxZeroArray(this->id);
             VxZeroArray(this->name);
             this->state = VxAlarmState::kUnknown;
         }

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

pure virtual

Deletes this instance.

Returns: The Result of deleting this instance.

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

pure virtual

Gets the IVxDevice that hosts this alarm input.

Parameters

hostDevice The host IVxDevice.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxAlarmInput::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::IVxAlarmInput::SetDescription ( char * description )

pure virtual

Sets the description property.

Parameters

description The new description value.

Returns: The Result of setting the property.

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

pure virtual

Sets the name property.

Parameters

name	The new name value.

Returns: The Result of setting the property.

Member Data Documentation

char VxSdk::IVxAlarmInput::description[256]

The friendly description of the alarm input.

Definition at line 49 of file IVxAlarmInput.h.

char VxSdk::IVxAlarmInput::id[64]

The unique identifier of the alarm input.

Definition at line 53 of file IVxAlarmInput.h.

char VxSdk::IVxAlarmInput::name[64]

The friendly name of the alarm input.

Definition at line 57 of file IVxAlarmInput.h.

VxAlarmState::Value VxSdk::IVxAlarmInput::state

The current state of the alarm input.

Definition at line 61 of file IVxAlarmInput.h.

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation