ARC SDK
Public Member Functions | Static Public Member Functions
Arc::DataHandle Class Reference

This class is a wrapper around the DataPoint class. More...

#include <arc/data/DataHandle.h>

Public Member Functions

 DataHandle (const URL &url, const UserConfig &usercfg)
 Construct a new DataHandle.
 
 ~DataHandle ()
 Destructor.
 
DataPointoperator-> ()
 Returns a pointer to a DataPoint object.
 
const DataPointoperator-> () const
 Returns a const pointer to a DataPoint object.
 
DataPointoperator* ()
 Returns a reference to a DataPoint object.
 
const DataPointoperator* () const
 Returns a const reference to a DataPoint object.
 
bool operator! () const
 Returns true if the DataHandle is not valid.
 
 operator bool () const
 Returns true if the DataHandle is valid.
 

Static Public Member Functions

static DataPointGetPoint (const URL &url, const UserConfig &usercfg)
 Returns a pointer to new DataPoint object corresponding to URL. More...
 

Detailed Description

This class is a wrapper around the DataPoint class.

It simplifies the construction, use and destruction of DataPoint objects and should be used instead of DataPoint classes directly. The appropriate DataPoint subclass is created automatically and stored internally in DataHandle. A DataHandle instance can be thought of as a pointer to the DataPoint instance and the DataPoint can be accessed through the usual dereference operators. A DataHandle cannot be copied.

This class is the main way to access remote data items and obtain information about them. To simply copy a whole file DataMover::Transfer() can be used. For partial file copy see the examples in ARC data library (libarcdata).

Member Function Documentation

static DataPoint* Arc::DataHandle::GetPoint ( const URL url,
const UserConfig usercfg 
)
inlinestatic

Returns a pointer to new DataPoint object corresponding to URL.

This static method is mostly for bindings to other languages and if available scope of obtained DataPoint is undefined.


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