NAME

        Biomoby::SecondaryArticle


SYNOPSIS

        my $prim = New Biomoby::SecondaryArticle('un entier', 'integer', 'nawak', 5);


DESCRIPTION

        This class aims to facilitate access to Biomoby parameters called secondary articles.


AUTHORS

 Sebastien.Carrere@toulouse.inra.fr 
 Sebastien.Letort@toulouse.inra.fr


METHODS

Function GetEnum

        Title      :    GetEnum
        Usage      :    Biomoby::SecondaryArticle::GetEnum();
        Prerequiste:    none
        Function   :    Accessor to $_o_enum_type
        Returns    :    the Enum object
        Args       :    none
        Error      :    none
        Globals    :    none

Function New

        Title      :    New
        Usage      :    my $prim = New Biomoby::SecondaryArticle
                                                        ( $name, $type, $descr, $position );
        Prerequiste:    none
        Function   :    Build a SecondaryArticle object
        Returns    :    a SecondaryArticle object
        Args       :    $name,  the name of the article
                        $type,  the type of the article, must belong to allowed value defined by Enum object
                        $descr, the description of the article
                        $position,      the position of this article into the commande line
        Error      :    none
        Globals    :    none

Procedure SetFilename

        Title      :    SetFilename
        Usage      :    $prim->SetFilename( $filename )
        Prerequiste:    none
        Procedure  :    set the filename attribute
        Args       :    $filename,      the filename related to this article
        Error      :    none
        Globals    :    none

Procedure SetInfile

        Title      :    SetInfile
        Usage      :    $prim->SetInfile( $infile )
        Prerequiste:    none
        Procedure  :    set the infile attribute
        Args       :    $infile,        the infile related to this article
        Error      :    none
        Globals    :    none
        Note       :    There should be only one SetFilename
Je dois vĂ©rifier que si Filename est defini, paramsfile n'a pas lieu d'ĂȘtre et inversement.

Procedure SetCtrlAndPrecond

        Title      :    SetCtrlAndPrecond
        Usage      :    $prim->SetCtrlAndPrecond( $ctrl, $precond )
        Prerequiste:    none
        Procedure  :    set the ctrl and precond attribute
        Args       :    $ctrl,  the command line that is used to set a value for this article
                        $ctrl_msg,      displayed message for $ctrl exception or help
                        $precond,       the command line that indicates if the article is needed or not
        Error      :    none
        Globals    :    none

Procedure SetScale

        Title      :    SetScale
        Usage      :    $prim->SetScale( $min, $max, $inc )
        Prerequiste:    none
        Procedure  :    set the range of valid values
        Args       :    $min,   the minimum allowed
                        $max,   the maximum allowed
                        $inc,   the incremental step _not really used for now
        Error      :    none
        Globals    :    none

Procedure SetDefault

        Title      :    SetDefault
        Usage      :    $prim->SetDefault( $default, $o_enum )
        Prerequiste:    none
        Procedure  :    set the default value and the enumeration of allowed value
        Args       :    $default,       the default value for the article
                        $o_enum, an object Enum, defining allowed values
        Error      :    none
        Globals    :    none
        Note       :    SetEnum should be part of setScale ?


NAME

        Biomoby::SecondaryArticlesCollection


SYNOPSIS

        my $collec = New Biomoby::SecondaryArticlesCollection();
        $collec->Add( New Biomoby::SecondaryArticle( @params1 ) );
        $collec->Add( New Biomoby::SecondaryArticle( @params2 ) );
        my @a_ids = $collec->GetIds();
        my $o_article = $collec->GetById(2);
        my $o_article = $collec->GetByName( 'lolo' );
        print $collect->ToString();
        # what is in this class and not into its mother
        my @a_infiles = $collec->GetInfileNames();


DESCRIPTION

        This class managed a group of articles.
        It provides method to add article, to retrieve one by its name or its id.

Function New

        Title      :    New
        Usage      :    New Biomoby::SecondaryArticlesCollection();
        Prerequiste:    none
        Function   :    constructor of a collection of secondary articles
        Returns    :    an object Biomoby::SecondaryArticlesCollection
        Args       :    none
        Error      :    none
        Globals    :    none

Function GetInfileNames

        Title      :    GetInfileNames
        Usage      :    my @a_list = GetInfileNames();
        Prerequiste:    none
        Function   :    give a list of files into which params will be written
        Returns    :    an array of string
        Args       :    none
        Error      :    none
        Globals    :    none
        Note       :    infile et filename devraient etre reuni dans un seul parametre