Add API allowing xAPPs to send alarm messages
[ric-plt/xapp-frame-cpp.git] / doc / src / user / alloc_proto.im
1 .** vim: sw=4 ts=4 et :
2 .if false
3 ==================================================================================
4     Copyright (c) 2020 Nokia
5     Copyright (c) 2020 AT&T Intellectual Property.
6
7    Licensed under the Apache License, Version 2.0 (the "License");
8    you may not use this file except in compliance with the License.
9    You may obtain a copy of the License at
10
11        http://www.apache.org/licenses/LICENSE-2.0
12
13    Unless required by applicable law or agreed to in writing, software
14    distributed under the License is distributed on an "AS IS" BASIS,
15    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16    See the License for the specific language governing permissions and
17    limitations under the License.
18 ==================================================================================
19 .fi
20
21
22 .** for now we have to sort out based on pfm vs tfm since table
23 .** constuction for any of the "mark*" parsers sucks.
24
25 .ca start proto.ca
26 &ex_start
27   std::unique_ptr<xapp::Alarm> Alloc_alarm( );
28   std::unique_ptr<xapp::Alarm> Alloc_alarm( std::string meid );
29   std::unique_ptr<xapp::Alarm> Alloc_alarm( int prob_id, std::string meid );
30 &ex_end
31 .ca end
32
33 .if pfm
34 &beg_table( 5.25i .3i  b=0 : 80,15 )
35 .im proto.ca
36 &col
37 &ex_start
38 (1)
39 (2)
40 (3)
41 &ex_end
42 &end_table
43
44 .ei
45
46 .im proto.ca
47
48 .fi
49
50 &fig_cen(Alarm allocation prototypes.)
51 &space