Package rosetta :: Package core :: Package fragment :: Module _core_fragment_ :: Class FragmentIO
[hide private]
[frames] | no frames]

Class FragmentIO

 object --+    
          |    
??.instance --+
              |
             FragmentIO

core/fragment/FragmentIO.hh:55

Instance Methods [hide private]
 
__init__(...)
__init__( (object)arg1) -> None :
 
__reduce__(...)
helper for pickle
 
clean_frag_cache(...)
clean_frag_cache( (FragmentIO)arg1) -> None : remove all FragSets that are not referenced outside the cache.
 
get_frag_factory(...)
get_frag_factory( (FragmentIO)arg1) -> FragFactory : core/fragment/FragmentIO.hh:78
 
read_data(...)
read_data( (FragmentIO)arg1, (str)filename) -> FragSet : read a FragSet...
 
set_ncopies(...)
set_ncopies( (FragmentIO)arg1, (int)setting) -> None : Updates the number of copies of each fragment to keep (default 1)
 
set_read_annotation(...)
set_read_annotation( (FragmentIO)arg1 [, (bool)setting=True]) -> None : Toggles between reading annotated (true) and non-annotated (false)
 
set_top_frag_num(...)
set_top_frag_num( (FragmentIO)arg1, (int)setting) -> None : Updates the number of distinct fragments to keep
 
write_data(...)
write_data( (FragmentIO)arg1, (str)file, (FragSet)frags) -> None : core/fragment/FragmentIO.hh:76

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, (FragmentIO)) -> None :
    core/fragment/FragmentIO.hh:55

    C++ signature :
        void __init__(_object*,core::fragment::FragmentIO)

__init__( (object)arg1, (int)top [, (int)ncopies=1 [, (bool)bAnnotate=True]]) -> None :
    core/fragment/FragmentIO.hh:60

    C++ signature :
        void __init__(_object*,unsigned long [,unsigned long=1 [,bool=True]])

Overrides: object.__init__

__reduce__(...)

 

helper for pickle

Overrides: object.__reduce__
(inherited documentation)

clean_frag_cache(...)

 

clean_frag_cache( (FragmentIO)arg1) -> None :
    remove all FragSets that are not referenced outside the cache.
    

    C++ signature :
        void clean_frag_cache(core::fragment::FragmentIO {lvalue})

get_frag_factory(...)

 

get_frag_factory( (FragmentIO)arg1) -> FragFactory :
    core/fragment/FragmentIO.hh:78

    C++ signature :
        core::fragment::FragFactory {lvalue} get_frag_factory(core::fragment::FragmentIO {lvalue})

read_data(...)

 

read_data( (FragmentIO)arg1, (str)filename) -> FragSet :
    read a FragSet... note that this function caches the fragment set.
    i.e., if you read the same set from multiple positions in the code you get
    the same set. if you read a new file ... we'll check the cache for stale
    references and delete them...
    

    C++ signature :
        boost::shared_ptr<core::fragment::FragSet> read_data(core::fragment::FragmentIO {lvalue},std::string)

read_data( (FragmentIO)arg1, (str)filename, (FrameList)) -> None :
    core/fragment/FragmentIO.hh:72

    C++ signature :
        void read_data(core::fragment::FragmentIO {lvalue},std::string,core::fragment::FrameList {lvalue})

read_data( (FragmentIO)arg1, (std_istream)data, (FrameList)) -> None :
    core/fragment/FragmentIO.hh:74

    C++ signature :
        void read_data(core::fragment::FragmentIO {lvalue},std::istream {lvalue},core::fragment::FrameList {lvalue})

set_ncopies(...)

 

set_ncopies( (FragmentIO)arg1, (int)setting) -> None :
    Updates the number of copies of each fragment to keep (default 1)
    

    C++ signature :
        void set_ncopies(core::fragment::FragmentIO {lvalue},unsigned long)

set_read_annotation(...)

 

set_read_annotation( (FragmentIO)arg1 [, (bool)setting=True]) -> None :
    Toggles between reading annotated (true) and non-annotated (false)
    

    C++ signature :
        void set_read_annotation(core::fragment::FragmentIO {lvalue} [,bool=True])

set_top_frag_num(...)

 

set_top_frag_num( (FragmentIO)arg1, (int)setting) -> None :
    Updates the number of distinct fragments to keep
    

    C++ signature :
        void set_top_frag_num(core::fragment::FragmentIO {lvalue},unsigned long)

write_data(...)

 

write_data( (FragmentIO)arg1, (str)file, (FragSet)frags) -> None :
    core/fragment/FragmentIO.hh:76

    C++ signature :
        void write_data(core::fragment::FragmentIO {lvalue},std::string,core::fragment::FragSet)