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 <IVxResourceRel.h>

Public Member Functions
virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...

virtual VxResult::Value	GetResource (IVxDataSource *&dataSource) const =0
	Gets the related resource. More...

virtual VxResult::Value	Refresh ()=0
	Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...

virtual VxResult::Value	SetLinkState (bool isLinked) const =0
	Sets the link state of this resource to its parent. More...

Public Attributes
bool	isLinked
	Indicates whether the resource is linked to its parent. More...

Protected Member Functions
void	Clear ()
	Clears this instance. More...

Detailed Description

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 14 of file IVxResourceRel.h.

Member Function Documentation

void VxSdk::IVxResourceRel::Clear ( )

inlineprotected

Clears this instance.

Definition at line 49 of file IVxResourceRel.h.

                      {
             this->isLinked = false;
         }

virtual VxResult::Value VxSdk::IVxResourceRel::Delete ( ) const

pure virtual

Deletes this instance.

Returns: The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxResourceRel::GetResource ( IVxDataSource *& dataSource ) const

pure virtual

Gets the related resource.

Parameters

dataSource The related resource.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxResourceRel::Refresh ( )

pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns: The Result of refreshing the member values for this object.

virtual VxResult::Value VxSdk::IVxResourceRel::SetLinkState ( bool isLinked ) const

pure virtual

Sets the link state of this resource to its parent.

Parameters

isLinked True to link this resource to its parent, false to unlink.

Returns: The Result of the request.

Member Data Documentation

bool VxSdk::IVxResourceRel::isLinked

Indicates whether the resource is linked to its parent.

Definition at line 43 of file IVxResourceRel.h.

The documentation for this struct was generated from the following file:

C:/Git/VXSDK_M3/VxSdk/Include/IVxResourceRel.h

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation