CPPCli::DataObject Class Reference

The DataObject class represents an object that contains a custom serialized data object submitted by a client and stored on the server. The data is completely opaque to the server and other types of clients. More...

#include <DataObject.h>

Public Member Functions
	DataObject (VxSdk::IVxDataObject *vxDataObject)
	Constructor. More...
virtual	~DataObject ()
	Destructor. More...
	!DataObject ()
	Finaliser. More...
Results::Value	Refresh ()
	Refreshes this instances properties. More...

Package Functions
System::String^	_GetData ()
CPPCli::User^	_GetOwner ()
void	_SetData (System::String^ )

Package Attributes
VxSdk::IVxDataObject *	_dataObject

Properties
System::String^	Data [get, set]
	Gets or sets the serialized data. More...
System::String^	ClientType [get]
	Gets the client identifier. More...
System::String^	Id [get]
	Gets the unique identifier for this data object. More...
CPPCli::User^	Owner [get]
	Gets the User that owns this data object. More...
System::String^	OwnerName [get]
	Gets the name of the user that owns this data object. More...

Detailed Description

The DataObject class represents an object that contains a custom serialized data object submitted by a client and stored on the server. The data is completely opaque to the server and other types of clients.

Definition at line 16 of file DataObject.h.

Constructor & Destructor Documentation

CPPCli::DataObject::DataObject

(

VxSdk::IVxDataObject *

vxDataObject

)

Constructor.

Parameters

vxDataObject

The vx data object.

Definition at line 10 of file DataObject.cpp.

                                                             {
    _dataObject = vxDataObject;
}

virtual CPPCli::DataObject::~DataObject ( )

inlinevirtual

Destructor.

Definition at line 28 of file DataObject.h.

                              {
            this->!DataObject();
        }

CPPCli::DataObject::!DataObject

(

)

Finaliser.

Definition at line 14 of file DataObject.cpp.

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

Member Function Documentation

System::String CPPCli::DataObject::_GetData ( )

package

Definition at line 23 of file DataObject.cpp.

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

    // If the data is not available on the data object the result will return VxSdk::VxResult::kActionUnavailable,
    // otherwise VxSdk::VxResult::kInsufficientSize
    VxSdk::VxResult::Value result = _dataObject->GetData(data, size);
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for the data
        data = new char[size];
        // The result should now be kOK since we have allocated enough space
        _dataObject->GetData(data, size);
    }
    return gcnew System::String(data);
}

CPPCli::User CPPCli::DataObject::_GetOwner ( )

package

Definition at line 39 of file DataObject.cpp.

                                        {
    // Get the user object
    VxSdk::IVxUser* user = nullptr;
    VxSdk::VxResult::Value result = _dataObject->GetOwner(user);

    // Return the user if GetOwner was successful
    if (result == VxSdk::VxResult::kOK)
        return gcnew CPPCli::User(user);

    // Return nullptr if GetOwner is unsuccessful
    return nullptr;
}

void CPPCli::DataObject::_SetData ( System::String^  data )

package

Definition at line 52 of file DataObject.cpp.

                                                  {
    // Copy the data string to a new char
    int dataSize = data->Length + 1;
    char* newData = new char[dataSize];
    VxSdk::Utilities::StrCopySafe(newData, Utils::ConvertSysString(data), dataSize);

    // Set the data value for the data object
    _dataObject->SetData(newData);
}

CPPCli::Results::Value CPPCli::DataObject::Refresh

(

)

Refreshes this instances properties.

Returns

The Result of updating the properties.

Definition at line 19 of file DataObject.cpp.

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

Member Data Documentation

VxSdk::IVxDataObject* CPPCli::DataObject::_dataObject

package

Definition at line 90 of file DataObject.h.

Property Documentation

System:: String^ CPPCli::DataObject::ClientType

get

Gets the client identifier.

The client identifier.

Definition at line 57 of file DataObject.h.

System:: String^ CPPCli::DataObject::Data

getset

Gets or sets the serialized data.

The serialized data.

Definition at line 47 of file DataObject.h.

System:: String^ CPPCli::DataObject::Id

get

Gets the unique identifier for this data object.

The unique identifier.

Definition at line 66 of file DataObject.h.

CPPCli:: User^ CPPCli::DataObject::Owner

get

Gets the User that owns this data object.

The owner of this data object.

Definition at line 75 of file DataObject.h.

System:: String^ CPPCli::DataObject::OwnerName

get

Gets the name of the user that owns this data object.

The name of the owner.

Definition at line 84 of file DataObject.h.

---

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

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