irods  4.2.8
About: iRODS (the integrated Rule Oriented Data System) is a distributed data-management system for creating data grids, digital libraries, persistent archives, and real-time data systems.
  Fossies Dox: irods-4.2.8.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

irods::data_object Class Referenceabstract

#include <irods_data_object.hpp>

Inheritance diagram for irods::data_object:
[legend]
Collaboration diagram for irods::data_object:
[legend]

Public Member Functions

 data_object ()
 
 data_object (const std::string &, rodsLong_t, int, int)
 
 data_object (const std::string &, rodsLong_t, int, int, const keyValPair_t &)
 
 data_object (const std::string &, const std::string &, int, int)
 
 data_object (const std::string &, const std::string &, int, int, const keyValPair_t &)
 
 data_object (const data_object &)
 
virtual ~data_object ()
 
virtual data_objectoperator= (const data_object &)
 
virtual error resolve (const std::string &, plugin_ptr &)=0
 
virtual error get_re_vars (rule_engine_vars_t &)
 
virtual std::string physical_path () const
 
virtual std::string resc_hier () const
 
virtual long id () const
 
virtual int mode () const
 
virtual int flags () const
 
virtual const keyValPair_tcond_input () const
 
virtual rodsLong_t resc_id () const
 
virtual void physical_path (const std::string &_path)
 
virtual void resc_hier (const std::string &_hier)
 
virtual void id (long _id)
 
virtual void mode (int _m)
 
virtual void flags (int _f)
 
virtual void cond_input (const keyValPair_t &_cond_input)
 
virtual void resc_id (rodsLong_t _id)
 
- Public Member Functions inherited from irods::first_class_object
 first_class_object ()
 
virtual ~first_class_object ()
 

Protected Attributes

std::string physical_path_
 
std::string resc_hier_
 
long id_
 
int mode_
 
int flags_
 
keyValPair_t cond_input_
 
rodsLong_t resc_id_
 

Friends

void add_key_val (data_object_ptr &_do, const std::string &_k, const std::string &_v)
 
void remove_key_val (data_object_ptr &_do, const std::string &_k)
 

Detailed Description

Definition at line 22 of file irods_data_object.hpp.

Constructor & Destructor Documentation

◆ data_object() [1/6]

irods::data_object::data_object ( )

Definition at line 11 of file irods_data_object.cpp.

References cond_input_.

◆ data_object() [2/6]

irods::data_object::data_object ( const std::string &  _phy_path,
rodsLong_t  _resc_id,
int  _mode,
int  _flags 
)

Definition at line 23 of file irods_data_object.cpp.

References cond_input_, irods::resource_manager::leaf_id_to_hier(), resc_hier(), resc_hier_, resc_id_, and resc_mgr.

Here is the call graph for this function:

◆ data_object() [3/6]

irods::data_object::data_object ( const std::string &  _phy_path,
rodsLong_t  _resc_id,
int  _mode,
int  _flags,
const keyValPair_t _cond_input 
)

Definition at line 42 of file irods_data_object.cpp.

References cond_input_, irods::resource_manager::leaf_id_to_hier(), replKeyVal(), resc_hier(), resc_hier_, resc_id_, and resc_mgr.

Here is the call graph for this function:

◆ data_object() [4/6]

irods::data_object::data_object ( const std::string &  _phy_path,
const std::string &  _resc_hier,
int  _mode,
int  _flags 
)

Definition at line 62 of file irods_data_object.cpp.

References cond_input_, irods::resource_manager::hier_to_leaf_id(), resc_hier_, resc_id(), resc_id_, and resc_mgr.

Here is the call graph for this function:

◆ data_object() [5/6]

irods::data_object::data_object ( const std::string &  _phy_path,
const std::string &  _resc_hier,
int  _mode,
int  _flags,
const keyValPair_t _cond_input 
)

Definition at line 81 of file irods_data_object.cpp.

References cond_input_, irods::resource_manager::hier_to_leaf_id(), replKeyVal(), resc_hier_, resc_id(), resc_id_, and resc_mgr.

Here is the call graph for this function:

◆ data_object() [6/6]

irods::data_object::data_object ( const data_object _rhs)

Definition at line 102 of file irods_data_object.cpp.

References cond_input_, and replKeyVal().

Here is the call graph for this function:

◆ ~data_object()

irods::data_object::~data_object ( )
virtual

Definition at line 116 of file irods_data_object.cpp.

References clearKeyVal(), and cond_input_.

Here is the call graph for this function:

Member Function Documentation

◆ cond_input() [1/2]

virtual const keyValPair_t& irods::data_object::cond_input ( ) const
inlinevirtual

Definition at line 89 of file irods_data_object.hpp.

References cond_input_.

◆ cond_input() [2/2]

virtual void irods::data_object::cond_input ( const keyValPair_t _cond_input)
inlinevirtual

Definition at line 113 of file irods_data_object.hpp.

References cond_input_, and replKeyVal().

Here is the call graph for this function:

◆ flags() [1/2]

virtual int irods::data_object::flags ( ) const
inlinevirtual

Definition at line 86 of file irods_data_object.hpp.

References flags_.

Referenced by irods::structured_object::structured_object().

◆ flags() [2/2]

virtual void irods::data_object::flags ( int  _f)
inlinevirtual

Definition at line 110 of file irods_data_object.hpp.

References flags_.

◆ get_re_vars()

◆ id() [1/2]

virtual long irods::data_object::id ( ) const
inlinevirtual

Definition at line 80 of file irods_data_object.hpp.

References id_.

◆ id() [2/2]

virtual void irods::data_object::id ( long  _id)
inlinevirtual

Definition at line 104 of file irods_data_object.hpp.

References id_.

◆ mode() [1/2]

virtual int irods::data_object::mode ( ) const
inlinevirtual

Definition at line 83 of file irods_data_object.hpp.

References mode_.

Referenced by irods::structured_object::structured_object().

◆ mode() [2/2]

virtual void irods::data_object::mode ( int  _m)
inlinevirtual

Definition at line 107 of file irods_data_object.hpp.

References mode_.

◆ operator=()

data_object & irods::data_object::operator= ( const data_object _rhs)
virtual

Definition at line 122 of file irods_data_object.cpp.

References cond_input_, flags_, id_, mode_, physical_path_, replKeyVal(), resc_hier_, and resc_id_.

Referenced by irods::collection_object::operator=(), and irods::file_object::operator=().

Here is the call graph for this function:

◆ physical_path() [1/2]

virtual std::string irods::data_object::physical_path ( ) const
inlinevirtual

Definition at line 74 of file irods_data_object.hpp.

References physical_path_.

◆ physical_path() [2/2]

virtual void irods::data_object::physical_path ( const std::string &  _path)
inlinevirtual

Definition at line 98 of file irods_data_object.hpp.

References physical_path_.

◆ resc_hier() [1/2]

virtual std::string irods::data_object::resc_hier ( ) const
inlinevirtual

◆ resc_hier() [2/2]

virtual void irods::data_object::resc_hier ( const std::string &  _hier)
inlinevirtual

Definition at line 101 of file irods_data_object.hpp.

References resc_hier_.

◆ resc_id() [1/2]

virtual rodsLong_t irods::data_object::resc_id ( ) const
inlinevirtual

Definition at line 92 of file irods_data_object.hpp.

References resc_id_.

Referenced by data_object().

◆ resc_id() [2/2]

virtual void irods::data_object::resc_id ( rodsLong_t  _id)
inlinevirtual

Definition at line 116 of file irods_data_object.hpp.

References resc_id_.

◆ resolve()

virtual error irods::data_object::resolve ( const std::string &  ,
plugin_ptr  
)
pure virtual

Friends And Related Function Documentation

◆ add_key_val

void add_key_val ( data_object_ptr _do,
const std::string &  _k,
const std::string &  _v 
)
friend

Definition at line 172 of file irods_data_object.cpp.

◆ remove_key_val

void remove_key_val ( data_object_ptr _do,
const std::string &  _k 
)
friend

Definition at line 182 of file irods_data_object.cpp.

Member Data Documentation

◆ cond_input_

◆ flags_

int irods::data_object::flags_
protected

◆ id_

long irods::data_object::id_
protected

Definition at line 137 of file irods_data_object.hpp.

Referenced by get_re_vars(), id(), and operator=().

◆ mode_

int irods::data_object::mode_
protected

Definition at line 138 of file irods_data_object.hpp.

Referenced by get_re_vars(), mode(), and operator=().

◆ physical_path_

std::string irods::data_object::physical_path_
protected

◆ resc_hier_

std::string irods::data_object::resc_hier_
protected

◆ resc_id_

rodsLong_t irods::data_object::resc_id_
protected

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