/ 
Data-FSM-0.01
/ Data::FSM::State

NAME

Data::FSM::State - Data object for Finite State Machine state.

SYNOPSIS

use Data::FSM::State;

my $obj = Data::FSM::State->new(%params);
my $id = $obj->id;
my $initial = $obj->initial;
my $name = $obj->name;

METHODS

new

my $obj = Data::FSM::State->new(%params);

Constructor.

  • id

    FSM state id. The id is positive natural number.

    It's optional.

    Default value is undef.

  • initial

    FSM state initial flag.

    Default value is 0.

  • name

    FSM state name. The length of name is 100 characters.

    Default value is undef.

Returns instance of object.

id

my $id = $obj->id;

Get FSM state id.

Returns positive natural number.

initial

my $initial = $obj->initial;

Get inital flag..

Returns boolean (0/1).

name

my $name = $obj->name;

Get FSM state name.

Returns string.

ERRORS

new():
        From Mo::Utils::check_bool():
                Parameter 'initial' must be a bool (0/1).
                        Value: %s

        From Mo::Utils::check_length():
                Parameter 'name' has length greater than '100'.
                        Value: %s

        From Mo::utils::Number::check_positive_natural():
                Parameter 'id' must be a positive natural number.
                        Value: %s

EXAMPLE

use strict;
use warnings;

use Data::FSM::State;

my $obj = Data::FSM::State->new(
        'id' => 7,
        'initial' => 0,
        'name' => 'From',
);

# Print out.
print 'Id: '.$obj->id."\n";
print 'Initial: '.$obj->initial."\n";
print 'Name: '.$obj->name."\n";

# Output:
# Id: 7
# Initial: 0
# Name: From

DEPENDENCIES

Mo, Mo::utils, Mo::utils::Number.

REPOSITORY

https://github.com/michal-josef-spacek/Data-FSM

AUTHOR

Michal Josef Špaček mailto:skim@cpan.org

http://skim.cz

LICENSE AND COPYRIGHT

© 2025-2026 Michal Josef Špaček

BSD 2-Clause License

VERSION

0.01