class SignallingCircuitRange

A circuit range (set of circuits). More...

Full nameTelEngine::SignallingCircuitRange
Definition#include <libs/ysig/yatesig.h>
InheritsTelEngine::String [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods

Protected Members


Detailed Description

Keeps a range (set) of circuits. The circuit codes contained within a range may not be contiguous. See SignallingUtils::parseUIntArray() for the format of the string ranges this object can be built from

 SignallingCircuitRange (const String& rangeStr, const char* name = 0, int strategy = -1)

SignallingCircuitRange

Constructor

Parameters:
rangeStrString used to build this range
nameRange name
strategyStrategy used to allocate circuits from this range

 ~SignallingCircuitRange ()

~SignallingCircuitRange

[virtual]

Destructor

inline unsigned int  count ()

count

[const]

Get the number of circuits contained by this range

Returns: The number of circuits contained by this range

inline const unsigned int*  range ()

range

[const]

Get the pointer to the circuit codes array

Returns: Pointer to the circuit codes array or 0

unsigned int*  copyRange (unsigned int& count)

copyRange

[const]

Allocate and return an array containing range circuits

Parameters:
countAddress of variable to be filled with circuit count

Returns: Pointer to allocated buffer, 0 if there is no circuit. The caller will own the returned buffer

inline void  clear ()

clear

Get the pointer to the circuit codes array

Returns: Pointer to the circuit codes array or 0

Reimplemented from String.

inline unsigned int  operator[] (unsigned int index)

operator[]

Indexing operator

Parameters:
indexThe index in the array to retreive

Returns: The code at the given index

Reimplemented from String.

inline bool  set (const String& rangeStr)

set

Set this range from a string

Parameters:
rangeStrString used to (re)build this range

Returns: False if the string has invalid format

bool  add (const String& rangeStr)

add

Add codes to this range from a string

Parameters:
rangeStrString containing the codes to be added to this range

Returns: False if the string has invalid format

void  add (unsigned int* codes, unsigned int len)

add

Add an array of circuit codes to this range

Parameters:
codesThe array to add
lenThe array's length

inline void  add (unsigned int code)

add

Add a circuit code to this range

Parameters:
codeThe circuit code to add

void  add (unsigned int first, unsigned int last)

add

Add a compact range of circuit codes to this range

Parameters:
firstThe first circuit code to add
lastNumber of last circuit code

void  remove (unsigned int code)

remove

Remove a circuit code from this range

Parameters:
codeThe circuit code to remove

bool  find (unsigned int code)

find

Check if a circuit code is within this range

Parameters:
codeThe circuit code to find

Returns: True if found

Reimplemented from String.

void  destruct ()

destruct

[virtual]

Release memory

Reimplemented from GenObject.

void  updateLast ()

updateLast

[protected]

DataBlock m_range

m_range

[protected]

unsigned int m_count

m_count

[protected]

unsigned int m_last

m_last

[protected]

int m_strategy

m_strategy

[protected]

unsigned int m_used

m_used

[protected]


Generated by: paulc on bussard on Sun Oct 20 21:06:06 2013, using kdoc 2.0a54.