CPPCli::PtzLock Class Reference

The PtzLock class represents a lock for a ptz controller. More...

#include <PtzLock.h>

Public Member Functions
	PtzLock (VxSdk::IVxPtzLock *vxPtzLock)
	Constructor. More...
virtual	~PtzLock ()
	Destructor. More...
	!PtzLock ()
	Finaliser. More...
Results::Value	Lock (int expireTime)
	Lock the ptz control. More...
Results::Value	Refresh ()
	Update this instances properties. More...
Results::Value	Unlock ()
	Unlock the ptz control. More...

Package Functions
int	_GetExpireTime ()
bool	_GetLockState ()
System::String^	_GetOwner ()

Package Attributes
VxSdk::IVxPtzLock *	_ptzLock

Properties
int	ExpireTime [get]
	Gets the amount of time (in seconds) that the ptz lock will be held. More...
System::String^	Id [get]
	Gets the unique identifier of the ptz lock. More...
bool	IsLocked [get]
	Gets a value indicating whether the lock is active. More...
System::String^	Owner [get]
	Gets the name of the user that has locked the ptz controller, if any. More...

Detailed Description

The PtzLock class represents a lock for a ptz controller.

Definition at line 13 of file PtzLock.h.

Constructor & Destructor Documentation

CPPCli::PtzLock::PtzLock

(

VxSdk::IVxPtzLock *

vxPtzLock

)

Constructor.

Implements the ptz lock class.

Parameters

vxPtzLock

The ptz lock.

Definition at line 6 of file PtzLock.cpp.

                                                 {
    _ptzLock = vxPtzLock;
}

virtual CPPCli::PtzLock::~PtzLock ( )

inlinevirtual

Destructor.

Definition at line 25 of file PtzLock.h.

                           {
            this->!PtzLock();
        }

CPPCli::PtzLock::!PtzLock

(

)

Finaliser.

Definition at line 10 of file PtzLock.cpp.

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

Member Function Documentation

int CPPCli::PtzLock::_GetExpireTime ( )

package

Definition at line 31 of file PtzLock.cpp.

                                  {
    // Get and return the expire time
    int expireTime;
    _ptzLock->GetExpireTime(expireTime);
    return expireTime;
}

bool CPPCli::PtzLock::_GetLockState ( )

package

Definition at line 38 of file PtzLock.cpp.

                                  {
    // Get and return the current lock state
    bool lockStatus;
    _ptzLock->GetLockState(lockStatus);
    return lockStatus;
}

System::String CPPCli::PtzLock::_GetOwner ( )

package

Definition at line 45 of file PtzLock.cpp.

                                       {
    char* owner = nullptr;
    int size = 0;

    // The owner can be empty if the ptz controller is not currently locked. If that is the case then the result
    // returned will be VxSdk::VxResult::kOk and owner will remain a nullptr. Otherwise the return is
    // VxSdk::VxResult::kInsufficientSize
    VxSdk::VxResult::Value result = _ptzLock->GetOwner(owner, size);
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for owner
        owner = new char[size];
        // The result should now be kOK since we have allocated enough space
        _ptzLock->GetOwner(owner, size);
    }
    return gcnew System::String(owner);
}

CPPCli::Results::Value CPPCli::PtzLock::Lock

(

int

expireTime

)

Lock the ptz control.

Parameters

expireTime

The amount of time (in seconds) that the ptz lock will be held. The lock will not expire until it is explicitly unlocked if set to 0.

Returns

The Result of the request.

Definition at line 15 of file PtzLock.cpp.

                                                     {
    // Call Lock and return the result
    VxSdk::VxResult::Value result = _ptzLock->Lock(expireTime);
    return CPPCli::Results::Value(result);
}

CPPCli::Results::Value CPPCli::PtzLock::Refresh

(

)

Update this instances properties.

Returns

The Result of updating the properties.

Definition at line 21 of file PtzLock.cpp.

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

CPPCli::Results::Value CPPCli::PtzLock::Unlock

(

)

Unlock the ptz control.

Returns

The Result of the request.

Definition at line 25 of file PtzLock.cpp.

                                         {
    // Call Unlock and return the result
    VxSdk::VxResult::Value result = _ptzLock->Unlock();
    return CPPCli::Results::Value(result);
}

Member Data Documentation

VxSdk::IVxPtzLock* CPPCli::PtzLock::_ptzLock

package

Definition at line 91 of file PtzLock.h.

Property Documentation

int CPPCli::PtzLock::ExpireTime

get

Gets the amount of time (in seconds) that the ptz lock will be held.

The lock expire time in seconds.

Definition at line 58 of file PtzLock.h.

System:: String^ CPPCli::PtzLock::Id

get

Gets the unique identifier of the ptz lock.

The unique identifier.

Definition at line 67 of file PtzLock.h.

bool CPPCli::PtzLock::IsLocked

get

Gets a value indicating whether the lock is active.

true if locked, false if not.

Definition at line 76 of file PtzLock.h.

System:: String^ CPPCli::PtzLock::Owner

get

Gets the name of the user that has locked the ptz controller, if any.

The owner if it is set, else nullptr.

Definition at line 85 of file PtzLock.h.

---

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

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