Network Class Reference

Manage networks of streams. More...

#include <Network.h>

Collaboration diagram for Network:

[legend]

List of all members.

Public Member Functions
int	GetDetIndex (const int aStreamIndex)
	Returns the detector index of a given stream.
string	GetName (void)
	Returns the network name.
int	GetNetIndex (void)
	Returns the network index.
int	GetNStreams (void)
	Returns the number of streams.
int	GetNstreams (void)
	Returns the number of streams.
int	GetType (void)
	Returns the network type.
bool	IsDetIndexInNet (const int aDetIndex)
	Tests whether a given detector index is inside the network.
bool	MakeLVNetwork (const int aNetIndex)
	Transforms the network into a LIGO-Virgo detector network.
Constructors and destructors
	Network (const int aNstreams, const int aVerbose=0)
	Constructor of the Network class.
virtual	~Network (void)
	Destructor of the Network class.

---

Detailed Description

Manage networks of streams.

This class was designed to combine N Streams into a network following the GWOLLUM convention for networks. In particular, the N Streams can be used as N detectors of the LIGO-virgo global network. In that case many specific functions are provided to access the network properties.

Author:

Florent Robinet

---

Constructor & Destructor Documentation

Network::Network	(	const int	aNstreams,
		const int	aVerbose = 0
	)

Constructor of the Network class.

A network of N Streams is instanciated.

Parameters:

	aNstreams	number of streams
	aVerbose	verbosity level

Network::~Network

(

void

)

[virtual]

Destructor of the Network class.

---

Member Function Documentation

int Network::GetDetIndex

(

const int

aStreamIndex

)

Returns the detector index of a given stream.

-1 is returned if there is no match.

Parameters:

aStreamIndex

stream index in the network

string Network::GetName

(

void

)

[inline]

Returns the network name.

int Network::GetNetIndex

(

void

)

[inline]

Returns the network index.

int Network::GetNStreams

(

void

)

[inline]

Returns the number of streams.

int Network::GetNstreams

(

void

)

[inline]

Returns the number of streams.

int Network::GetType

(

void

)

[inline]

Returns the network type.

bool Network::IsDetIndexInNet

(

const int

aDetIndex

)

Tests whether a given detector index is inside the network.

true is returned if success.

Parameters:

aDetIndex

detector index to test

bool Network::MakeLVNetwork

(

const int

aNetIndex

)

Transforms the network into a LIGO-Virgo detector network.

A specific subnetwork is defined by the network index. See the GWOLLUM convention for LIGO-Virgo networks. The network index must be compatible with the number of streams specified in the constructor. For example, Nstreams = 2 and network index = 11 is impossible.

Please note that the convention for the network index changes with the call of this function. Before, the network index was determined by the number of streams in the network (2^N-1). Now it is given by the LV sub-network index (<2^N-1).

Parameters:

aNetIndex

LV sub-network index to build

---

The documentation for this class was generated from the following files:

• /afs/in2p3.fr/throng/virgo/virgoDev/SoftFlorent/GWOLLUM/v2r2/src/Network/Network.h
• /afs/in2p3.fr/throng/virgo/virgoDev/SoftFlorent/GWOLLUM/v2r2/src/Network/Network.cc