Package rosetta :: Package basic :: Package datacache :: Module _basic_datacache_ :: Class DataCache_T_basic_datacache_CacheableData_T

[frames] | no frames]

Class DataCache_T_basic_datacache_CacheableData_T

 object --+    
          |    
??.instance --+
              |
             DataCache_T_basic_datacache_CacheableData_T

Known Subclasses:

Indexed storage for objects derived from a ReferenceCountable
 data type.
Intended for use as a generic data cache by storing objects
 derived from a ReferenceCountable data type in a unique slot designated
 by an integer id (enum, size index, etc.). The DataCache will only store
 one object per slot/id.  For example, see the PoseDataCache used in
 core::pose::Pose, which is indexed by the enum basic::pose::datacache:CacheableDataType.
 Currently when data is set(), it is not cloned -- classes deriving from
 DataCache should remember to overload set() if they need cloning behavior.
@tparam Data Class derived from utility::pointer::ReferenceCount that
 defines a virtual clone() method.

Instance Methods

[hide private]

__init__(...)
__init__( (object)arg1) -> None :

__reduce__(...)
helper for pickle

assign(...)
assign( (DataCache_T_basic_datacache_CacheableData_T)arg1, (DataCache_T_basic_datacache_CacheableData_T)src) -> DataCache_T_basic_datacache_CacheableData_T : copy assignment

clear(...)
clear( (DataCache_T_basic_datacache_CacheableData_T)arg1) -> None : clear all stored data

get(...)
get( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)slot) -> CacheableData : get base class reference to the object stored in the slot

get_const_ptr(...)
get_const_ptr( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)slot) -> CacheableData : get base class owning ptr to object stored in the slot

get_ptr(...)
get_ptr( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)slot) -> CacheableData : get base class owning ptr to object stored in the slot

get_raw_const_ptr(...)
get_raw_const_ptr( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)slot) -> CacheableData : get base class raw ptr to object stored in the slot

get_raw_ptr(...)
get_raw_ptr( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)slot) -> CacheableData : get base class raw ptr to object stored in the slot

has(...)
has( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)slot) -> bool : is there an object in the slot?

resize(...)
resize( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)n_slots) -> None : resize the cache for the given number of slots [in] n_slots The new number of slots.

set(...)
set( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)slot, (__CPP_CacheableData__)new_data) -> None : store data in the given slot [in] The slot to use.

size(...)
size( (DataCache_T_basic_datacache_CacheableData_T)arg1) -> int : the number of slots in this cache

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

__instance_size__ = 32

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(...)
(Constructor)


__init__( (object)arg1) -> None :

    C++ signature :
        void __init__(_object*)

__init__( (object)arg1, (int)n_slots) -> None :
    size constructor
    [in] n_types The number of slots for this DataCache.
    

    C++ signature :
        void __init__(_object*,unsigned long)

__init__( (object)arg1, (DataCache_T_basic_datacache_CacheableData_T)src) -> None :
    copy constructor
    

    C++ signature :
        void __init__(_object*,basic::datacache::DataCache<basic::datacache::CacheableData>)

Overrides: object.__init__

reduce(...)

helper for pickle

Overrides: object.__reduce__: (inherited documentation)

assign(...)


assign( (DataCache_T_basic_datacache_CacheableData_T)arg1, (DataCache_T_basic_datacache_CacheableData_T)src) -> DataCache_T_basic_datacache_CacheableData_T :
    copy assignment
    

    C++ signature :
        basic::datacache::DataCache<basic::datacache::CacheableData> {lvalue} assign(basic::datacache::DataCache<basic::datacache::CacheableData> {lvalue},basic::datacache::DataCache<basic::datacache::CacheableData>)

clear(...)


clear( (DataCache_T_basic_datacache_CacheableData_T)arg1) -> None :
    clear all stored data
    

    C++ signature :
        void clear(basic::datacache::DataCache<basic::datacache::CacheableData> {lvalue})

clear( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)slot) -> None :
    clear the object in a selected slot
    

    C++ signature :
        void clear(basic::datacache::DataCache<basic::datacache::CacheableData> {lvalue},unsigned long)

get(...)


get( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)slot) -> CacheableData :
    get base class reference to the object stored in the slot
    

    C++ signature :
        basic::datacache::CacheableData get(basic::datacache::DataCache<basic::datacache::CacheableData> {lvalue},unsigned long)

get( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)slot) -> CacheableData :
    get base class reference to object stored in the slot
    

    C++ signature :
        basic::datacache::CacheableData {lvalue} get(basic::datacache::DataCache<basic::datacache::CacheableData> {lvalue},unsigned long)

get_const_ptr(...)


get_const_ptr( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)slot) -> CacheableData :
    get base class owning ptr to object stored in the slot
    

    C++ signature :
        boost::shared_ptr<basic::datacache::CacheableData const> get_const_ptr(basic::datacache::DataCache<basic::datacache::CacheableData> {lvalue},unsigned long)

get_ptr(...)


get_ptr( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)slot) -> CacheableData :
    get base class owning ptr to object stored in the slot
    

    C++ signature :
        boost::shared_ptr<basic::datacache::CacheableData> get_ptr(basic::datacache::DataCache<basic::datacache::CacheableData> {lvalue},unsigned long)

get_raw_const_ptr(...)


get_raw_const_ptr( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)slot) -> CacheableData :
    get base class raw ptr to object stored in the slot
    

    C++ signature :
        basic::datacache::CacheableData const* get_raw_const_ptr(basic::datacache::DataCache<basic::datacache::CacheableData> {lvalue},unsigned long)

get_raw_ptr(...)


get_raw_ptr( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)slot) -> CacheableData :
    get base class raw ptr to object stored in the slot
    

    C++ signature :
        basic::datacache::CacheableData* get_raw_ptr(basic::datacache::DataCache<basic::datacache::CacheableData> {lvalue},unsigned long)

has(...)


has( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)slot) -> bool :
    is there an object in the slot?
    

    C++ signature :
        bool has(basic::datacache::DataCache<basic::datacache::CacheableData> {lvalue},unsigned long)

resize(...)


resize( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)n_slots) -> None :
    resize the cache for the given number of slots
    [in] n_slots The new number of slots.
    

    C++ signature :
        void resize(basic::datacache::DataCache<basic::datacache::CacheableData> {lvalue},unsigned long)

set(...)


set( (DataCache_T_basic_datacache_CacheableData_T)arg1, (int)slot, (__CPP_CacheableData__)new_data) -> None :
    store data in the given slot
    [in] The slot to use.
    [in] observer The data to store -- data is *not* cloned.
    

    C++ signature :
        void set(basic::datacache::DataCache<basic::datacache::CacheableData> {lvalue},unsigned long,boost::shared_ptr<basic::datacache::CacheableData>)

size(...)


size( (DataCache_T_basic_datacache_CacheableData_T)arg1) -> int :
    the number of slots in this cache
    

    C++ signature :
        unsigned long size(basic::datacache::DataCache<basic::datacache::CacheableData> {lvalue})

Class DataCache_T_basic_datacache_CacheableData_T

__init__(...) (Constructor)

__reduce__(...)

assign(...)

clear(...)

get(...)

get_const_ptr(...)

get_ptr(...)

get_raw_const_ptr(...)

get_raw_ptr(...)

has(...)

resize(...)

set(...)

size(...)

init(...)
(Constructor)

reduce(...)