File: StructuralUnit.pm

package info (click to toggle)
libdemeter-perl 0.9.27%2Bds6-9
  • links: PTS, VCS
  • area: contrib
  • in suites: forky, sid, trixie
  • size: 74,028 kB
  • sloc: perl: 73,233; python: 2,196; makefile: 1,999; ansic: 1,368; lisp: 454; sh: 74
file content (148 lines) | stat: -rw-r--r-- 3,614 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
package Demeter::StructuralUnit;

=for Copyright
 .
 Copyright (c) 2006-2019 Bruce Ravel (http://bruceravel.github.io/home).
 All rights reserved.
 .
 This file is free software; you can redistribute it and/or
 modify it under the same terms as Perl itself. See The Perl
 Artistic License.
 .
 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.

=cut

use Moose;
extends 'Demeter::VPath';
use Demeter::StrTypes qw( Empty );

has '+name'      => (default => 'structural unit',);
		     #trigger => sub{my($self, $new) = @_; $self->vpath->name($new)} );
has '+id'        => (default => 'virtual path');
has 'tag'        => (is => 'rw', isa => 'Str', default => sub{Demeter->randomstring(3)});

has 'feffs' => (
		traits    => ['Array'],
		is        => 'rw',
		isa       => 'ArrayRef[Demeter::Feff]',
		default   => sub { [] },
		handles   => {
			      'push_feffs'    => 'push',
			      'pop_feffs'     => 'pop',
			      'shift_feffs'   => 'shift',
			      'unshift_feffs' => 'unshift',
			      'clear_feffs'   => 'clear',
			     }
	       );
has 'gds' => (
	      traits    => ['Array'],
	      is        => 'rw',
	      isa       => 'ArrayRef[Demeter::GDS]',
	      default   => sub { [] },
	      handles   => {
			    'push_gds'    => 'push',
			    'pop_gds'     => 'pop',
			    'shift_gds'   => 'shift',
			    'unshift_gds' => 'unshift',
			    'clear_gds'   => 'clear',
			   }
	     );


sub BUILD {
  my ($self, @params) = @_;
  $self->mo->push_StructuralUnit($self);
};


after clear => sub {
  my ($self) = @_;
  $self->clear_feffs;
  $self->clear_gds;
  return $self;
};



override serialize => sub {
  my ($self, $fname) = @_;
  ## 1. gather up all the Path object in the SU
  ## 2. dig through and find all Feff objects
  ## 3. Dig through and find all GDS objects
  ## 4. Make yamls of everything and zip them up with phase.bin files in a zip file with .dsu extension
  return $self;
};

override deserialize => sub {
  my ($self, $fname) = @_;
  ## unpack everything, instantiate objects, fill up SU attributes.
  return $self;
};


__PACKAGE__->meta->make_immutable;
1;

=head1 NAME

Demeter::StructuralUnit - Structural units for use in fitting projects

=head1 VERSION

This documentation refers to Demeter version 0.9.26.

=head1 SYNOPSIS

Gather together the information required to define a structural units
for use in a fit.

=head1 DESCRIPTION

This is a bit challenging to use in a script -- much easier to use in a GUI.

=head1 ATTRIBUTES

=head1 METHODS

=head1 SERIALIZATION AND DESERIALIZATION

Zip file with yamls and phase.bin files with .dsu extension.

=head1 CONFIGURATION AND ENVIRONMENT

See L<Demeter::Config> for a description of the configuration system.

=head1 DEPENDENCIES

Demeter's dependencies are in the F<Build.PL> file.

=head1 BUGS AND LIMITATIONS

Please report problems to the Ifeffit Mailing List
(L<http://cars9.uchicago.edu/mailman/listinfo/ifeffit/>)

Patches are welcome.

=head1 AUTHOR

Bruce Ravel (L<http://bruceravel.github.io/home>)

L<http://bruceravel.github.io/demeter/>


=head1 LICENCE AND COPYRIGHT

Copyright (c) 2006-2019 Bruce Ravel (L<http://bruceravel.github.io/home>). All rights reserved.

This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlgpl>.

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.

=cut