Package saga :: Module _engine :: Class metric
[hide private]
[frames] | no frames]

Class metric

 object --+        
          |        
??.instance --+    
              |    
         object --+
                  |
                 metric

saga::metric type

Nested Classes [hide private]
  frequency

Inherited from object: object_type

Instance Methods [hide private]
 
__init__(...)
__init__( (object)arg1) -> None :
 
add_callback(...)
add_callback( (metric)arg1, (object)arg2) -> int :
 
attribute_exists(...)
attribute_exists( (metric)arg1, (str)arg2) -> bool : tests if the given attribute exists for this instance (plain)
 
attribute_is_readonly(...)
attribute_is_readonly( (metric)arg1, (str)arg2) -> bool : tests if the given attribute is read only (plain)
 
attribute_is_removable(...)
attribute_is_removable( (metric)arg1, (str)arg2) -> bool : tests if the given attribute is removable (plain)
 
attribute_is_vector(...)
attribute_is_vector( (metric)arg1, (str)arg2) -> bool : tests if the given attribute is a vector attribute (plain)
 
attribute_is_writable(...)
attribute_is_writable( (metric)arg1, (str)arg2) -> bool : tests if the given attribute is writable (plain)
 
find_attributes(...)
find_attributes( (metric)arg1, (str)arg2) -> object : find attributes matching the given pattern (plain)
 
fire(...)
fire( (metric)arg1, (context)arg2) -> None : push the current state to the implementation
 
get_attribute(...)
get_attribute( (metric)arg1, (str)arg2) -> str : returns a (scalar) attribute associated with this object (plain)
 
get_vector_attribute(...)
get_vector_attribute( (metric)arg1, (str)arg2) -> object : returns a (vector) attribute associated with this object (plain)
 
list_attributes(...)
list_attributes( (metric)arg1) -> object : lists the keys of all attributes associated with this object (plain)
 
remove_attribute(...)
remove_attribute( (metric)arg1, (str)arg2) -> None : removes an attribute associated with this object (plain)
 
remove_callback(...)
remove_callback( (metric)arg1, (int)arg2) -> None :
 
set_attribute(...)
set_attribute( (metric)arg1, (str)arg2, (str)arg3) -> None : sets a (scalar) attribute associated with this object (plain)
 
set_vector_attribute(...)
set_vector_attribute( (metric)arg1, (str)arg2, (object)arg3) -> None : sets a (vector) attribute associated with this object (plain)

Inherited from object: __reduce__, clone, get_id, get_object_type_name, get_session, get_type

Inherited from unreachable.instance: __new__

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

Class Variables [hide private]
  Cont = saga._engine.frequency.Cont
  Descreet = saga._engine.frequency.Descreet
  Event = saga._engine.frequency.Event
  Pull = saga._engine.frequency.Pull
  Push = saga._engine.frequency.Push
  Unknown = saga._engine.frequency.Unknown

Inherited from object: Advert, AdvertDirectory, Buffer, Context, Directory, Endpoint, Exception, File, IOVec, Job, JobDescription, JobSelf, JobService, LogicalDirectory, LogicalFile, Metric, Msg, NSDirectory, NSEntry, Parameter, RPC, Session, Stream, StreamService, Task, TaskContainer, URL, __instance_size__

Properties [hide private]

Inherited from object: id, session, type

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 

__init__( (object)arg1) -> None :

    C++ signature :
        void __init__(_object*)

__init__( (object)arg1, (object)arg2, (str)arg3, (str)arg4, (str)arg5, (str)arg6, (str)arg7, (str)arg8) -> None :

    C++ signature :
        void __init__(_object*,saga::object,std::string,std::string,std::string,std::string,std::string,std::string)

Overrides: object.__init__

add_callback(...)

 

add_callback( (metric)arg1, (object)arg2) -> int :

    C++ signature :
        unsigned int add_callback(saga::metric,boost::python::api::object)

add_callback( (metric)arg1, (object)arg2, (object)arg3) -> int :

    C++ signature :
        unsigned int add_callback(saga::metric,boost::python::api::object,boost::python::api::object)

attribute_exists(...)

 

attribute_exists( (metric)arg1, (str)arg2) -> bool :
    tests if the given attribute exists for this instance (plain)

    C++ signature :
        bool attribute_exists(saga::metric,std::string)

attribute_exists( (metric)arg1, (routine_type)arg2, (str)arg3) -> task :
    tests if the given attribute exists for this instance (task based)

    C++ signature :
        saga::task attribute_exists(saga::metric,saga::python::routine_type,std::string)

attribute_is_readonly(...)

 

attribute_is_readonly( (metric)arg1, (str)arg2) -> bool :
    tests if the given attribute is read only (plain)

    C++ signature :
        bool attribute_is_readonly(saga::metric,std::string)

attribute_is_readonly( (metric)arg1, (routine_type)arg2, (str)arg3) -> task :
    tests if the given attribute is read only (task based)

    C++ signature :
        saga::task attribute_is_readonly(saga::metric,saga::python::routine_type,std::string)

attribute_is_removable(...)

 

attribute_is_removable( (metric)arg1, (str)arg2) -> bool :
    tests if the given attribute is removable (plain)

    C++ signature :
        bool attribute_is_removable(saga::metric,std::string)

attribute_is_removable( (metric)arg1, (routine_type)arg2, (str)arg3) -> task :
    tests if the given attribute is removable (task based)

    C++ signature :
        saga::task attribute_is_removable(saga::metric,saga::python::routine_type,std::string)

attribute_is_vector(...)

 

attribute_is_vector( (metric)arg1, (str)arg2) -> bool :
    tests if the given attribute is a vector attribute (plain)

    C++ signature :
        bool attribute_is_vector(saga::metric,std::string)

attribute_is_vector( (metric)arg1, (routine_type)arg2, (str)arg3) -> task :
    tests if the given attribute is a vector attribute (task based)

    C++ signature :
        saga::task attribute_is_vector(saga::metric,saga::python::routine_type,std::string)

attribute_is_writable(...)

 

attribute_is_writable( (metric)arg1, (str)arg2) -> bool :
    tests if the given attribute is writable (plain)

    C++ signature :
        bool attribute_is_writable(saga::metric,std::string)

attribute_is_writable( (metric)arg1, (routine_type)arg2, (str)arg3) -> task :
    tests if the given attribute is writable (task based)

    C++ signature :
        saga::task attribute_is_writable(saga::metric,saga::python::routine_type,std::string)

find_attributes(...)

 

find_attributes( (metric)arg1, (str)arg2) -> object :
    find attributes matching the given pattern (plain)

    C++ signature :
        std::vector<std::string, std::allocator<std::string> > find_attributes(saga::metric,std::string)

find_attributes( (metric)arg1, (routine_type)arg2, (str)arg3) -> task :
    find attributes matching the given pattern (task based)

    C++ signature :
        saga::task find_attributes(saga::metric,saga::python::routine_type,std::string)

fire(...)

 

fire( (metric)arg1, (context)arg2) -> None :
    push the current state to the implementation

    C++ signature :
        void fire(saga::metric {lvalue},saga::context)

get_attribute(...)

 

get_attribute( (metric)arg1, (str)arg2) -> str :
    returns a (scalar) attribute associated with this object (plain)

    C++ signature :
        std::string get_attribute(saga::metric,std::string)

get_attribute( (metric)arg1, (routine_type)arg2, (str)arg3) -> task :
    returns a (scalar) attribute associated with this object (task based)

    C++ signature :
        saga::task get_attribute(saga::metric,saga::python::routine_type,std::string)

get_vector_attribute(...)

 

get_vector_attribute( (metric)arg1, (str)arg2) -> object :
    returns a (vector) attribute associated with this object (plain)

    C++ signature :
        std::vector<std::string, std::allocator<std::string> > get_vector_attribute(saga::metric,std::string)

get_vector_attribute( (metric)arg1, (routine_type)arg2, (str)arg3) -> task :
    returns a (vector) attribute associated with this object (task based)

    C++ signature :
        saga::task get_vector_attribute(saga::metric,saga::python::routine_type,std::string)

list_attributes(...)

 

list_attributes( (metric)arg1) -> object :
    lists the keys of all attributes associated with this object (plain)

    C++ signature :
        std::vector<std::string, std::allocator<std::string> > list_attributes(saga::metric)

list_attributes( (metric)arg1, (routine_type)arg2) -> task :
    lists the keys of all attributes associated with this object (task based)

    C++ signature :
        saga::task list_attributes(saga::metric,saga::python::routine_type)

remove_attribute(...)

 

remove_attribute( (metric)arg1, (str)arg2) -> None :
    removes an attribute associated with this object (plain)

    C++ signature :
        void remove_attribute(saga::metric,std::string)

remove_attribute( (metric)arg1, (routine_type)arg2, (str)arg3) -> task :
    removes an attribute associated with this object (task based)

    C++ signature :
        saga::task remove_attribute(saga::metric,saga::python::routine_type,std::string)

remove_callback(...)

 

remove_callback( (metric)arg1, (int)arg2) -> None :

    C++ signature :
        void remove_callback(saga::metric {lvalue},unsigned int)

set_attribute(...)

 

set_attribute( (metric)arg1, (str)arg2, (str)arg3) -> None :
    sets a (scalar) attribute associated with this object (plain)

    C++ signature :
        void set_attribute(saga::metric,std::string,std::string)

set_attribute( (metric)arg1, (routine_type)arg2, (str)arg3, (str)arg4) -> task :
    sets a (scalar) attribute associated with this object (task based)

    C++ signature :
        saga::task set_attribute(saga::metric,saga::python::routine_type,std::string,std::string)

set_vector_attribute(...)

 

set_vector_attribute( (metric)arg1, (str)arg2, (object)arg3) -> None :
    sets a (vector) attribute associated with this object (plain)

    C++ signature :
        void set_vector_attribute(saga::metric,std::string,std::vector<std::string, std::allocator<std::string> >)

set_vector_attribute( (metric)arg1, (routine_type)arg2, (str)arg3, (object)arg4) -> task :
    sets a (vector) attribute associated with this object (task based)

    C++ signature :
        saga::task set_vector_attribute(saga::metric,saga::python::routine_type,std::string,std::vector<std::string, std::allocator<std::string> >)