The AlarmInput class represents a physical alarm input. More...

#include <AlarmInput.h>

Public Types
enum	AlarmStates { AlarmStates::Unknown, AlarmStates::Active, AlarmStates::Inactive }
	Values that represent the state of an alarm input. More...

Public Member Functions
	AlarmInput (VxSdk::IVxAlarmInput *vxAlarmInput)
	Constructor. More...

virtual	~AlarmInput ()
	Destructor. More...

	!AlarmInput ()
	Finaliser. More...

Results::Value	Refresh ()
	Refreshes this instances properties. More...

Package Functions
CPPCli::Device^	_GetHostDevice ()

Package Attributes
VxSdk::IVxAlarmInput *	_alarmInput

Properties
System::String^	Description `[get, set]`
	Gets or sets the friendly description of the alarm input. More...

CPPCli::Device^	HostDevice `[get]`
	Gets the device that hosts this alarm input. More...

System::String^	Id `[get]`
	Gets the unique alarm input identifier. More...

System::String^	Name `[get, set]`
	Gets or sets the friendly name. More...

AlarmStates	State `[get]`
	Gets the current state of this alarm input. More...

Detailed Description

The AlarmInput class represents a physical alarm input.

Definition at line 14 of file AlarmInput.h.

Member Enumeration Documentation

enum CPPCli::AlarmInput::AlarmStates

strong

Values that represent the state of an alarm input.

Enumerator
Unknown	An error or unknown value was returned.
Active	The alarm input is active.
Inactive	The alarm input is inactive.

Definition at line 20 of file AlarmInput.h.

                                {
             Unknown,
 
             Active,
 
             Inactive
         };

Constructor & Destructor Documentation

CPPCli::AlarmInput::AlarmInput ( VxSdk::IVxAlarmInput * vxAlarmInput )

Constructor.

Parameters

vxAlarmInput The vx alarm input.

Definition at line 9 of file AlarmInput.cpp.

                                                              {
     _alarmInput = vxAlarmInput;
 }

virtual CPPCli::AlarmInput::~AlarmInput ( )

inlinevirtual

Destructor.

Definition at line 40 of file AlarmInput.h.

                               {
             this->!AlarmInput();
         }

CPPCli::AlarmInput::!AlarmInput ( )

Finaliser.

Definition at line 13 of file AlarmInput.cpp.

                               {
     _alarmInput->Delete();
     _alarmInput = nullptr;
 }

Member Function Documentation

CPPCli::Device CPPCli::AlarmInput::_GetHostDevice ( )

package

Definition at line 22 of file AlarmInput.cpp.

                                                {
     // Get the host device
     VxSdk::IVxDevice* device = nullptr;
     VxSdk::VxResult::Value result = _alarmInput->GetHostDevice(device);
 
     // Return the host device if GetHostDevice was successful
     if (result == VxSdk::VxResult::kOK)
         return gcnew CPPCli::Device(device);
 
     return nullptr;
 }

CPPCli::Results::Value CPPCli::AlarmInput::Refresh ( )

Refreshes this instances properties.

Returns: The Result of updating the properties.

Definition at line 18 of file AlarmInput.cpp.

                                              {
     return (CPPCli::Results::Value)_alarmInput->Refresh();
 }

Member Data Documentation

VxSdk::IVxAlarmInput* CPPCli::AlarmInput::_alarmInput

package

Definition at line 111 of file AlarmInput.h.

Property Documentation

System:: String^ CPPCli::AlarmInput::Description

getset

Gets or sets the friendly description of the alarm input.

The friendly description.

Definition at line 59 of file AlarmInput.h.

CPPCli:: Device^ CPPCli::AlarmInput::HostDevice

get

Gets the device that hosts this alarm input.

The host device.

Definition at line 73 of file AlarmInput.h.

System:: String^ CPPCli::AlarmInput::Id

get

Gets the unique alarm input identifier.

The unique identifier.

Definition at line 82 of file AlarmInput.h.

System:: String^ CPPCli::AlarmInput::Name

getset

Gets or sets the friendly name.

The friendly name.

Definition at line 91 of file AlarmInput.h.

AlarmStates CPPCli::AlarmInput::State

get

Gets the current state of this alarm input.

The alarm input state.

Definition at line 105 of file AlarmInput.h.

The documentation for this class was generated from the following files:

C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/AlarmInput.h
C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/AlarmInput.cpp

Public Types

Public Member Functions

Package Functions