CPPCli::ResourceRel Class Reference

The ResourceRel class represents a related resource; that is, a resource that is related in some way to a parent resource. This related resource may be linked to its parent resource for some effect. More...

#include <ResourceRel.h>

Public Member Functions
	ResourceRel (VxSdk::IVxResourceRel *vxResourceRel)
	Constructor. More...
virtual	~ResourceRel ()
	Destructor. More...
	!ResourceRel ()
	Finaliser. More...
Results::Value	Refresh ()
	Update this instances properties. More...

Package Functions
DataSource^	_GetResource ()

Package Attributes
VxSdk::IVxResourceRel *	_resourceRel

Properties
bool	IsLinked [get, set]
	Gets or sets whether the resource is linked to its parent. More...
DataSource^	Resource [get]
	Gets the related resource. More...

Detailed Description

The ResourceRel class represents a related resource; that is, a resource that is related in some way to a parent resource. This related resource may be linked to its parent resource for some effect.

Definition at line 15 of file ResourceRel.h.

Constructor & Destructor Documentation

CPPCli::ResourceRel::ResourceRel

(

VxSdk::IVxResourceRel *

vxResourceRel

)

Constructor.

Parameters

vxResourceRel

The vx relative resource.

Definition at line 9 of file ResourceRel.cpp.

                                                                 {
    _resourceRel = vxResourceRel;
}

virtual CPPCli::ResourceRel::~ResourceRel ( )

inlinevirtual

Destructor.

Definition at line 27 of file ResourceRel.h.

                               {
            this->!ResourceRel();
        }

CPPCli::ResourceRel::!ResourceRel

(

)

Finaliser.

Definition at line 13 of file ResourceRel.cpp.

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

Member Function Documentation

CPPCli::DataSource CPPCli::ResourceRel::_GetResource ( )

package

Definition at line 23 of file ResourceRel.cpp.

                                                  {
    // Get the data source object
    VxSdk::IVxDataSource* dataSource = nullptr;
    VxSdk::VxResult::Value result = _resourceRel->GetResource(dataSource);

    // Return the data source if GetResource was successful
    if (result == VxSdk::VxResult::kOK)
        return gcnew CPPCli::DataSource(dataSource);

    return nullptr;
}

CPPCli::Results::Value CPPCli::ResourceRel::Refresh

(

)

Update this instances properties.

Returns

The Result of updating the properties.

Definition at line 19 of file ResourceRel.cpp.

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

Member Data Documentation

VxSdk::IVxResourceRel* CPPCli::ResourceRel::_resourceRel

package

Definition at line 61 of file ResourceRel.h.

Property Documentation

bool CPPCli::ResourceRel::IsLinked

getset

Gets or sets whether the resource is linked to its parent.

true if this resource is linked to its parent, false if not linked.

Definition at line 46 of file ResourceRel.h.

DataSource^ CPPCli::ResourceRel::Resource

get

Gets the related resource.

The related resource.

Definition at line 56 of file ResourceRel.h.

---

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

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