CPPCli::RelayOutput Class Reference

The RelayOutput class represents a physical relay output. More...

#include <RelayOutput.h>

Public Types
enum	RelayStates {   RelayStates::Unknown,   RelayStates::Active,   RelayStates::Inactive }
	Values that represent the state of a relay output. More...

Public Member Functions
	RelayOutput (VxSdk::IVxRelayOutput *vxRelayOutput)
	Constructor. More...
virtual	~RelayOutput ()
	Destructor. More...
	!RelayOutput ()
	Finaliser. More...
Results::Value	Refresh ()
	Refreshes this instances properties. More...

Package Functions
CPPCli::Device^	_GetHostDevice ()
void	_SetRelayState (RelayStates state)

Package Attributes
VxSdk::IVxRelayOutput *	_relayOutput

Properties
System::String^	Description [get, set]
	Gets or sets the friendly description of the relay output. More...
CPPCli::Device^	HostDevice [get]
	Gets the device that hosts this relay output. More...
System::String^	Id [get]
	Gets the unique relay output identifier. More...
System::String^	Name [get, set]
	Gets or sets the friendly name. More...
RelayStates	State [get, set]
	Gets the current state of this relay output. More...

Detailed Description

The RelayOutput class represents a physical relay output.

Definition at line 14 of file RelayOutput.h.

Member Enumeration Documentation

enum CPPCli::RelayOutput::RelayStates

strong

Values that represent the state of a relay output.

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

Definition at line 20 of file RelayOutput.h.

                               {
            Unknown,

            Active,

            Inactive
        };

Constructor & Destructor Documentation

CPPCli::RelayOutput::RelayOutput

(

VxSdk::IVxRelayOutput *

vxRelayOutput

)

Constructor.

Parameters

vxRelayOutput

The vx relay output.

Definition at line 9 of file RelayOutput.cpp.

                                                                 {
    _relayOutput = vxRelayOutput;
}

virtual CPPCli::RelayOutput::~RelayOutput ( )

inlinevirtual

Destructor.

Definition at line 40 of file RelayOutput.h.

                               {
            this->!RelayOutput();
        }

CPPCli::RelayOutput::!RelayOutput

(

)

Finaliser.

Definition at line 13 of file RelayOutput.cpp.

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

Member Function Documentation

CPPCli::Device CPPCli::RelayOutput::_GetHostDevice ( )

package

Definition at line 22 of file RelayOutput.cpp.

                                                {
    // Get the host device
    VxSdk::IVxDevice* device = nullptr;
    VxSdk::VxResult::Value result = _relayOutput->GetHostDevice(device);

    // Return the host device if GetHostDevice was successful
    if (result == VxSdk::VxResult::kOK)
        return gcnew CPPCli::Device(device);

    return nullptr;
}

void CPPCli::RelayOutput::_SetRelayState ( RelayStates  state )

package

Definition at line 34 of file RelayOutput.cpp.

                                                        {
    switch(state) {
        case RelayStates::Active:
            _relayOutput->Activate();
            return;
        case RelayStates::Inactive:
            _relayOutput->Deactivate();
            return;
        case RelayStates::Unknown:
            return;
    }
}

CPPCli::Results::Value CPPCli::RelayOutput::Refresh

(

)

Refreshes this instances properties.

Returns

The Result of updating the properties.

Definition at line 18 of file RelayOutput.cpp.

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

Member Data Documentation

VxSdk::IVxRelayOutput* CPPCli::RelayOutput::_relayOutput

package

Definition at line 112 of file RelayOutput.h.

Property Documentation

System:: String^ CPPCli::RelayOutput::Description

getset

Gets or sets the friendly description of the relay output.

The friendly description.

Definition at line 59 of file RelayOutput.h.

CPPCli:: Device^ CPPCli::RelayOutput::HostDevice

get

Gets the device that hosts this relay output.

The host device.

Definition at line 73 of file RelayOutput.h.

System:: String^ CPPCli::RelayOutput::Id

get

Gets the unique relay output identifier.

The unique identifier.

Definition at line 82 of file RelayOutput.h.

System:: String^ CPPCli::RelayOutput::Name

getset

Gets or sets the friendly name.

The friendly name.

Definition at line 91 of file RelayOutput.h.

RelayStates CPPCli::RelayOutput::State

getset

Gets the current state of this relay output.

The relay output state.

Definition at line 105 of file RelayOutput.h.

---

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

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