The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Meta-0.03
River stage zero No dependents
/ Meta::Utils::Opts::Sopt

NAME

Meta::Utils::Opts::Sopt - Object to store a definition for a command line option.

COPYRIGHT

Copyright (C) 2001, 2002 Mark Veltzer; All rights reserved.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

DETAILS

        MANIFEST: Sopt.pm
        PROJECT: meta
        VERSION: 0.25

SYNOPSIS

        package foo;
        use Meta::Utils::Opts::Sopt qw();
        my($sopt)=Meta::Utils::Opts::Sopt->new();
        $sopt->set_name("name");

DESCRIPTION

This object is used by the Opts object to store information about a single command line argument.

FUNCTIONS

        new($)
        get_name($)
        set_name($$)
        get_description($)
        set_description($$)
        get_type($)
        set_type($$)
        get_defs($)
        set_defs($$)
        get_poin($)
        set_poin($$)
        get_valu($)
        set_valu($$)
        get_enum($)
        set_enum($$)
        verify($$)
        print($$)

FUNCTION DOCUMENTATION

new($)

This gives you a new Sopt object.

get_name($)

This will retrieve the name of the current object.

set_name($$)

This will set the name for the current object.

get_description($)

This returns the description for the current object.

set_description($$)

This will set the description for the current object.

get_type($)

This method returns the type of the current object.

set_type($$)

This method will set the type of the current object.

get_defa($)

This method will returns the default value of the current object.

set_defa($$)

This method will set the default value of the current object.

get_poin($)

This method will return the pointer of the current object.

set_opti($$)

This method will set the pointer of the current object.

get_valu($)

This method will retrieve the current value of the current object.

set_valu($$)

This method will set the current value of the current object.

get_enum($)

This method will retrieve the current enum of the current object.

set_enum($$)

This method will set the current enum of the current object.

verify($$)

This will run sanity checks on the value inside.

print($$)

This prints out the current Sopt object.

BUGS

None.

AUTHOR

        Name: Mark Veltzer
        Email: mark2776@yahoo.com
        WWW: http://www.geocities.com/mark2776
        CPAN id: VELTZER

HISTORY

        0.00 MV make Meta::Utils::Opts object oriented
        0.01 MV fix todo items look in pod documentation
        0.02 MV add enumerated types to options
        0.03 MV more on tests/more checks to perl
        0.04 MV change new methods to have prototypes
        0.05 MV perl code quality
        0.06 MV more perl quality
        0.07 MV more perl quality
        0.08 MV get basic Simul up and running
        0.09 MV perl documentation
        0.10 MV more perl quality
        0.11 MV perl qulity code
        0.12 MV more perl code quality
        0.13 MV revision change
        0.14 MV better general cook schemes
        0.15 MV languages.pl test online
        0.16 MV Pdmt stuff
        0.17 MV perl packaging
        0.18 MV PDMT
        0.19 MV tree type organization in databases
        0.20 MV md5 project
        0.21 MV database
        0.22 MV perl module versions in files
        0.23 MV movies and small fixes
        0.24 MV thumbnail user interface
        0.25 MV more thumbnail issues

SEE ALSO

Nothing.

TODO

-add set type.

-add limited range intergers.

-add regular expression match limited strings.

-add a write_file type which is a file that could be written (as opposed to a file which doesnt exist in new_file).

-add clean character strings types (only nice characters...).