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::file_object Class Reference

#include <irods_file_object.hpp>

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

Public Member Functions

 file_object ()
 
 file_object (const file_object &)
 
 file_object (rsComm_t *_comm, const std::string &_logical_name, const std::string &_filename, rodsLong_t _resc_id, int _fd, int _mode, int _flags)
 
 file_object (rsComm_t *_comm, const std::string &_logical_name, const std::string &_filename, const std::string &_resc_hier, int _fd, int _mode, int _flags)
 
 file_object (rsComm_t *_comm, const dataObjInfo_t *_dataObjInfo)
 
virtual ~file_object ()
 
virtual file_objectoperator= (const file_object &)
 
virtual bool operator== (const file_object &_rhs) const
 
virtual error resolve (const std::string &, plugin_ptr &)
 
virtual error get_re_vars (rule_engine_vars_t &)
 
virtual rsComm_tcomm () const
 
virtual std::string logical_path () const
 
virtual std::string data_type () const
 
virtual int file_descriptor () const
 
virtual int l1_desc_idx () const
 
virtual size_t size () const
 
virtual int repl_requested () const
 
virtual std::vector< physical_objectreplicas () const
 
virtual const std::string & in_pdmo () const
 
virtual void logical_path (const std::string &_s)
 
virtual void file_descriptor (int _fd)
 
virtual void comm (rsComm_t *_c)
 
virtual void size (size_t _v)
 
virtual void repl_requested (int _v)
 
virtual void in_pdmo (const std::string &_v)
 
virtual void replicas (const std::vector< physical_object > &_v)
 
- Public Member Functions inherited from irods::data_object
 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 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

rsComm_tcomm_
 
std::string logical_path_
 
std::string data_type_
 
int file_descriptor_
 
int l1_desc_idx_
 
size_t size_
 
int repl_requested_
 
std::string in_pdmo_
 
std::vector< physical_objectreplicas_
 
- Protected Attributes inherited from irods::data_object
std::string physical_path_
 
std::string resc_hier_
 
long id_
 
int mode_
 
int flags_
 
keyValPair_t cond_input_
 
rodsLong_t resc_id_
 

Detailed Description

Definition at line 19 of file irods_file_object.hpp.

Constructor & Destructor Documentation

◆ file_object() [1/5]

irods::file_object::file_object ( )

Definition at line 23 of file irods_file_object.cpp.

◆ file_object() [2/5]

irods::file_object::file_object ( const file_object _rhs)

◆ file_object() [3/5]

irods::file_object::file_object ( rsComm_t _c,
const std::string &  _logical_path,
const std::string &  _fn,
rodsLong_t  _resc_id,
int  _fd,
int  _m,
int  _f 
)

Definition at line 52 of file irods_file_object.cpp.

References replicas_.

◆ file_object() [4/5]

irods::file_object::file_object ( rsComm_t _c,
const std::string &  _logical_path,
const std::string &  _fn,
const std::string &  _resc_hier,
int  _fd,
int  _m,
int  _f 
)

Definition at line 79 of file irods_file_object.cpp.

References replicas_.

◆ file_object() [5/5]

◆ ~file_object()

irods::file_object::~file_object ( )
virtual

Definition at line 133 of file irods_file_object.cpp.

References clearKeyVal(), and irods::data_object::cond_input_.

Here is the call graph for this function:

Member Function Documentation

◆ comm() [1/2]

virtual rsComm_t* irods::file_object::comm ( ) const
inlinevirtual

Definition at line 69 of file irods_file_object.hpp.

References comm_.

◆ comm() [2/2]

virtual void irods::file_object::comm ( rsComm_t _c)
inlinevirtual

Definition at line 105 of file irods_file_object.hpp.

References comm_.

◆ data_type()

virtual std::string irods::file_object::data_type ( ) const
inlinevirtual

Reimplemented in irods::structured_object.

Definition at line 75 of file irods_file_object.hpp.

References data_type_.

◆ file_descriptor() [1/2]

virtual int irods::file_object::file_descriptor ( ) const
inlinevirtual

Definition at line 78 of file irods_file_object.hpp.

References file_descriptor_.

◆ file_descriptor() [2/2]

virtual void irods::file_object::file_descriptor ( int  _fd)
inlinevirtual

Definition at line 102 of file irods_file_object.hpp.

References file_descriptor_.

◆ get_re_vars()

error irods::file_object::get_re_vars ( rule_engine_vars_t _kvp)
virtual

Reimplemented from irods::data_object.

Reimplemented in irods::structured_object.

Definition at line 237 of file irods_file_object.cpp.

References data_type_, DATA_TYPE_KW, file_descriptor_, FILE_DESCRIPTOR_KW, irods::data_object::get_re_vars(), in_pdmo_, IN_PDMO_KW, l1_desc_idx_, L1_DESC_IDX_KW, logical_path_, LOGICAL_PATH_KW, repl_requested_, REPL_REQUESTED_KW, size_, SIZE_KW, and SUCCESS.

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

Here is the call graph for this function:

◆ in_pdmo() [1/2]

virtual const std::string& irods::file_object::in_pdmo ( ) const
inlinevirtual

Definition at line 93 of file irods_file_object.hpp.

References in_pdmo_.

◆ in_pdmo() [2/2]

virtual void irods::file_object::in_pdmo ( const std::string &  _v)
inlinevirtual

Definition at line 114 of file irods_file_object.hpp.

References in_pdmo_.

◆ l1_desc_idx()

virtual int irods::file_object::l1_desc_idx ( ) const
inlinevirtual

Definition at line 81 of file irods_file_object.hpp.

References l1_desc_idx_.

◆ logical_path() [1/2]

virtual std::string irods::file_object::logical_path ( ) const
inlinevirtual

◆ logical_path() [2/2]

virtual void irods::file_object::logical_path ( const std::string &  _s)
inlinevirtual

Definition at line 99 of file irods_file_object.hpp.

References logical_path_.

◆ operator=()

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

Definition at line 139 of file irods_file_object.cpp.

References comm_, irods::data_object::cond_input_, data_type_, file_descriptor_, in_pdmo_, l1_desc_idx_, logical_path_, irods::data_object::operator=(), repl_requested_, replicas_, replKeyVal(), and size_.

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

Here is the call graph for this function:

◆ operator==()

bool irods::file_object::operator== ( const file_object _rhs) const
virtual
Description:\n Comparison operator

Definition at line 161 of file irods_file_object.cpp.

References logical_path(), and repl_requested().

Here is the call graph for this function:

◆ repl_requested() [1/2]

virtual int irods::file_object::repl_requested ( ) const
inlinevirtual

Definition at line 87 of file irods_file_object.hpp.

References repl_requested_.

Referenced by operator==().

◆ repl_requested() [2/2]

virtual void irods::file_object::repl_requested ( int  _v)
inlinevirtual

Definition at line 111 of file irods_file_object.hpp.

References repl_requested_.

◆ replicas() [1/2]

virtual std::vector< physical_object > irods::file_object::replicas ( ) const
inlinevirtual

Definition at line 90 of file irods_file_object.hpp.

References replicas_.

◆ replicas() [2/2]

virtual void irods::file_object::replicas ( const std::vector< physical_object > &  _v)
inlinevirtual

Definition at line 117 of file irods_file_object.hpp.

References replicas_.

◆ resolve()

error irods::file_object::resolve ( const std::string &  _interface,
plugin_ptr _ptr 
)
virtual

Implements irods::data_object.

Reimplemented in irods::structured_object.

Definition at line 173 of file irods_file_object.cpp.

References irods.pyparsing::empty, ERROR, irods::hierarchy_parser::first_resc(), HIERARCHY_ERROR, irods::error::ok(), PASSMSG, irods::data_object::resc_hier(), resc_mgr, irods::resource_manager::resolve(), irods::RESOURCE_INTERFACE(), irods::hierarchy_parser::set_string(), SUCCESS, and SYS_INVALID_INPUT_PARAM.

Here is the call graph for this function:

◆ size() [1/2]

virtual size_t irods::file_object::size ( ) const
inlinevirtual

Definition at line 84 of file irods_file_object.hpp.

References size_.

◆ size() [2/2]

virtual void irods::file_object::size ( size_t  _v)
inlinevirtual

Definition at line 108 of file irods_file_object.hpp.

References size_.

Member Data Documentation

◆ comm_

rsComm_t* irods::file_object::comm_
protected

Definition at line 127 of file irods_file_object.hpp.

Referenced by comm(), file_object(), and operator=().

◆ data_type_

std::string irods::file_object::data_type_
protected

Definition at line 129 of file irods_file_object.hpp.

Referenced by data_type(), file_object(), get_re_vars(), and operator=().

◆ file_descriptor_

int irods::file_object::file_descriptor_
protected

◆ in_pdmo_

std::string irods::file_object::in_pdmo_
protected

Definition at line 134 of file irods_file_object.hpp.

Referenced by file_object(), get_re_vars(), in_pdmo(), and operator=().

◆ l1_desc_idx_

int irods::file_object::l1_desc_idx_
protected

Definition at line 131 of file irods_file_object.hpp.

Referenced by file_object(), get_re_vars(), l1_desc_idx(), and operator=().

◆ logical_path_

std::string irods::file_object::logical_path_
protected

◆ repl_requested_

int irods::file_object::repl_requested_
protected

Definition at line 133 of file irods_file_object.hpp.

Referenced by file_object(), get_re_vars(), operator=(), and repl_requested().

◆ replicas_

std::vector< physical_object > irods::file_object::replicas_
protected

Definition at line 137 of file irods_file_object.hpp.

Referenced by file_object(), operator=(), and replicas().

◆ size_

size_t irods::file_object::size_
protected

Definition at line 132 of file irods_file_object.hpp.

Referenced by file_object(), get_re_vars(), operator=(), and size().


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