AnalogLineGroup Class Reference
A group of analog lines.
More...
#include <yatesig.h>
List of all members.
Detailed Description
A group of analog lines.
This class is an analog line container. It may contain another group when used to monitor analog lines
Constructor & Destructor Documentation
Constructor. Construct an analog line group owning single lines
- Parameters:
-
| type | Line type as enumeration |
| name | Name of this component |
| slave | True if this is an FXO group owned by an FXS one. Ignored if type is not FXO |
Constructor. Construct an FXS analog line group owning another group of FXO analog lines. The fxo group is owned by this component and will be destructed if invalid (not FXO type)
- Parameters:
-
| name | Name of this component |
| fxo | The FXO group |
Member Function Documentation
Get this group's type
- Returns:
- The group's type
Get the analog lines belonging to this group
- Returns:
- The group's lines list
Get the group holding the FXO lines if present
- Returns:
- The group holding the FXO lines or 0
Check if this is an FXO group owned by an FXS one
- Returns:
- True if this is an FXO group owned by an FXS one
bool appendLine |
( |
AnalogLine * |
line, |
|
|
bool |
destructOnFail = true | |
|
) |
| | |
Append a line to this group. Line must have the same type as this group and must be owned by this group
- Parameters:
-
| line | The line to append |
| destructOnFail | Destroy line if failed to append. Defaults to true |
- Returns:
- True on success
void removeLine |
( |
unsigned int |
cic |
) |
|
Remove a line from the list and destruct it
- Parameters:
-
| cic | The signalling circuit's code used by the line |
Remove a line from the list without destroying it
- Parameters:
-
| line | The line to be removed |
Find a line by its circuit
- Parameters:
-
| cic | The signalling circuit's code used by the line |
- Returns:
- AnalogLine pointer or 0 if not found
Find a line by its address
- Parameters:
-
| address | The address of the line |
- Returns:
- AnalogLine pointer or 0 if not found
Iterate through the line list to get an event
- Parameters:
-
- Returns:
- AnalogLineEvent pointer or 0 if no events
virtual void destruct |
( |
|
) |
[virtual] |
Member Data Documentation
The analog lines belonging to this group
The documentation for this class was generated from the following file: