ArtsNetMatrixData

[ libArts | Source | Keywords | Summary | Ancestors | All Members | Descendants ]

Quick Index

Class Summary

class ArtsNetMatrixData

{

public:

ArtsNetMatrixData() ;

uint16_t SampleInterval() const ;

uint16_t SampleInterval(uint16_t sampleInterval) ;

uint32_t Count() const ;

uint32_t Count(uint32_t count) ;

uint64_t TotalPkts() const ;

uint64_t TotalPkts(uint64_t totalPkts) ;

uint64_t TotalBytes() const ;

uint64_t TotalBytes(uint64_t totalBytes) ;

uint64_t Orphans() const ;

uint64_t Orphans(uint64_t orphans) ;

vector<ArtsNetMatrixEntry> & NetEntries() const ;

void SortEntriesByBytes();

void SortEntriesByPkts();

uint32_t Length(uint8_t version ) const;

istream& read(istream& is, uint8_t version );

int read(int fd, uint8_t version );

ostream& write(ostream& os, uint8_t version );

int write(int fd, uint8_t version );

friend ostream& operator << (ostream& os, const ArtsNetMatrixData & artsNetMatrixData);

protected:

}; // ArtsNetMatrixData

Back to the top of ArtsNetMatrixData

DESCRIPTION

---------------------------------------------------------------------------
class ArtsNetMatrixData
---------------------------------------------------------------------------
This class encapsulates the data portion of an ARTS net matrix object. This class is not normally instantiated directly, but instead instantiated from the containing object (an Arts or ArtsNetMatrix object).
---------------------------------------------------------------------------

Back to the top of ArtsNetMatrixData

ArtsNetMatrixData() ;

-------------------------------------------------------------------------
inline ArtsNetMatrixData()
.........................................................................
constructor
-------------------------------------------------------------------------

  inline ArtsNetMatrixData()
                                                                                                                                     
;

Function is currently defined inline.

Back to the top of ArtsNetMatrixData

uint16_t SampleInterval() const ;

-------------------------------------------------------------------------
inline uint16_t SampleInterval() const
.........................................................................
Returns the sampling ratio if the net matrix was built using packet sampling techniques. Normally this value is 1, meaning we're working with complete data sets (for example, from Cisco flow-export).
-------------------------------------------------------------------------

  inline uint16_t SampleInterval() const
                                          
;

Function is currently defined inline.

Back to the top of ArtsNetMatrixData

uint16_t SampleInterval(uint16_t sampleInterval) ;

-------------------------------------------------------------------------
inline uint16_t SampleInterval(uint16_t sampleInterval)
.........................................................................
Sets and returns the sampling ratio if the net matrix was built using packet sampling techniques. Normally this value is 1, meaning we're working with complete data sets (for example, from Cisco flow-export).
-------------------------------------------------------------------------

  inline uint16_t SampleInterval(uint16_t sampleInterval)
                                                                                      
;

Function is currently defined inline.

Back to the top of ArtsNetMatrixData

uint32_t Count() const ;

-------------------------------------------------------------------------
inline uint32_t Count() const
.........................................................................
Returns the number of net matrix entries (cells) in an ArtsNetMatrixData object.
-------------------------------------------------------------------------

  inline uint32_t Count() const
                                 
;

Function is currently defined inline.

Back to the top of ArtsNetMatrixData

uint32_t Count(uint32_t count) ;

-------------------------------------------------------------------------
inline uint32_t Count(uint32_t count)
.........................................................................
Sets and Returns the number of net matrix entries (cells) in an ArtsNetMatrixData object.
-------------------------------------------------------------------------

  inline uint32_t Count(uint32_t count)
                                                           
;

Function is currently defined inline.

Back to the top of ArtsNetMatrixData

uint64_t TotalPkts() const ;

-------------------------------------------------------------------------
inline uint64_t TotalPkts() const
.........................................................................
Returns the total packets of traffic in the ArtsNetMatrixData object. The total is the sum of all traffic from each source to each destination.
-------------------------------------------------------------------------

  inline uint64_t TotalPkts() const
                                   
;

Function is currently defined inline.

Back to the top of ArtsNetMatrixData

uint64_t TotalPkts(uint64_t totalPkts) ;

-------------------------------------------------------------------------
inline uint64_t TotalPkts(uint64_t totalPkts)
.........................................................................
Sets and returns the total packets of traffic in the ArtsNetMatrixData object. The total is the sum of all traffic from each source to each destination.
-------------------------------------------------------------------------

  inline uint64_t TotalPkts(uint64_t totalPkts)
                                                                   
;

Function is currently defined inline.

Back to the top of ArtsNetMatrixData

uint64_t TotalBytes() const ;

-------------------------------------------------------------------------
inline uint64_t TotalBytes() const
.........................................................................
Returns the total bytes of traffic in the ArtsNetMatrixData object. The total is the sum of all traffic from each source to each destination.
-------------------------------------------------------------------------

  inline uint64_t TotalBytes() const
                                    
;

Function is currently defined inline.

Back to the top of ArtsNetMatrixData

uint64_t TotalBytes(uint64_t totalBytes) ;

-------------------------------------------------------------------------
inline uint64_t TotalBytes(uint64_t totalBytes)
.........................................................................
Sets and returns the total bytes of traffic in the ArtsNetMatrixData object. The total is the sum of all traffic from each source to each destination.
-------------------------------------------------------------------------

  inline uint64_t TotalBytes(uint64_t totalBytes)
                                                                      
;

Function is currently defined inline.

Back to the top of ArtsNetMatrixData

uint64_t Orphans() const ;

-------------------------------------------------------------------------
inline uint64_t Orphans() const
.........................................................................

-------------------------------------------------------------------------

  inline uint64_t Orphans() const
                                   
;

Function is currently defined inline.

Back to the top of ArtsNetMatrixData

uint64_t Orphans(uint64_t orphans) ;

-------------------------------------------------------------------------
inline uint64_t Orphans(uint64_t orphans)
.........................................................................

-------------------------------------------------------------------------

  inline uint64_t Orphans(uint64_t orphans)
                                                                 
;

Function is currently defined inline.

Back to the top of ArtsNetMatrixData

vector<ArtsNetMatrixEntry> & NetEntries() const ;

-------------------------------------------------------------------------
inline vector<ArtsNetMatrixEntry> & NetEntries() const
.........................................................................
Return a reference to the vector of ArtsNetMatrixEntry objects. Note that even though this member may be called from a const object, the returned reference is not const; the vector is mutable.
-------------------------------------------------------------------------

  inline vector<ArtsNetMatrixEntry> & NetEntries() const
                                      
;

Function is currently defined inline.

Back to the top of ArtsNetMatrixData

void SortEntriesByBytes();

-------------------------------------------------------------------------
void SortEntriesByBytes()
.........................................................................
Sorts the net matrix entries by the number of bytes in the net entries (the bytes of traffic sent from a source network to a destinatino network).
-------------------------------------------------------------------------

  void SortEntriesByBytes();

Back to the top of ArtsNetMatrixData

void SortEntriesByPkts();

-------------------------------------------------------------------------
void SortEntriesByPkts()
.........................................................................
Sorts the net matrix entries by the number of packets in the net entries (the packets of traffic sent from a source network to a destinatino network).
-------------------------------------------------------------------------

  void SortEntriesByPkts();

Back to the top of ArtsNetMatrixData

uint32_t Length(uint8_t version ) const;

-------------------------------------------------------------------------
uint32_t Length(uint8_t version = 2) const
.........................................................................
Returns the length required to store the ArtsNetMatrixData object on disk.
-------------------------------------------------------------------------

  uint32_t Length(uint8_t version = 2) const;

Back to the top of ArtsNetMatrixData

istream& read(istream& is, uint8_t version );

-------------------------------------------------------------------------
istream& read(istream& is, uint8_t version = 2)
.........................................................................
Reads an ArtsNetMatrixData object from an istream. Returns the istream.
-------------------------------------------------------------------------

  istream& read(istream& is, uint8_t version = 2);

Back to the top of ArtsNetMatrixData

int read(int fd, uint8_t version );

-------------------------------------------------------------------------
int read(int fd, uint8_t version = 2)
.........................................................................
Reads an ArtsNetMatrixData object from a file descriptor. Returns the number of bytes read if successful, -1 on failure.
-------------------------------------------------------------------------

  int read(int fd, uint8_t version = 2);

Back to the top of ArtsNetMatrixData

ostream& write(ostream& os, uint8_t version );

-------------------------------------------------------------------------
ostream& write(ostream& os, uint8_t version = 2)
.........................................................................
Writes an ArtsNetMatrixData object to an ostream. Returns the ostream.
-------------------------------------------------------------------------

  ostream& write(ostream& os, uint8_t version = 2);

Back to the top of ArtsNetMatrixData

int write(int fd, uint8_t version );

-------------------------------------------------------------------------
int write(int fd, uint8_t version = 2)
.........................................................................
Writes an ArtsNetMatrixData object to a file descriptor. Returns the number of bytes written on success, -1 on failure.
-------------------------------------------------------------------------

  int write(int fd, uint8_t version = 2);

Back to the top of ArtsNetMatrixData

friend ostream& operator << (ostream& os, const ArtsNetMatrixData & artsNetMatrixData);

-------------------------------------------------------------------------
ostream& operator << (ostream& os, const ArtsNetMatrixData & artsNetMatrixData)
.........................................................................
Overloaded '<<' operator. Dumps the contents of an ArtsNetMatrixData object to an ostream in a human-readable form. Returns the ostream.
-------------------------------------------------------------------------

  friend ostream& operator << (ostream& os,
                               const ArtsNetMatrixData & artsNetMatrixData);

Back to the top of ArtsNetMatrixData

All Members

public:: uint16_t SampleInterval() const ;; uint16_t SampleInterval(uint16_t sampleInterval) ;; uint32_t Count() const ;; uint32_t Count(uint32_t count) ;; uint64_t TotalPkts() const ;; uint64_t TotalPkts(uint64_t totalPkts) ;; uint64_t TotalBytes() const ;; uint64_t TotalBytes(uint64_t totalBytes) ;; uint64_t Orphans() const ;; uint64_t Orphans(uint64_t orphans) ;; vector<ArtsNetMatrixEntry> & NetEntries() const ;; void SortEntriesByBytes();; void SortEntriesByPkts();; uint32_t Length(uint8_t version ) const;; istream& read(istream& is, uint8_t version );; int read(int fd, uint8_t version );; ostream& write(ostream& os, uint8_t version );; int write(int fd, uint8_t version );; friend ostream& operator << (ostream& os, const ArtsNetMatrixData & artsNetMatrixData);
protected:

Back to the top of ArtsNetMatrixData

Ancestors

Class does not inherit from any other class.

Back to the top of ArtsNetMatrixData

Descendants

Class is not inherited by any others.

Back to the top of ArtsNetMatrixData

Generated from source by the Cocoon utilities on Sat Oct 17 14:39:58 1998 .

Report problems to jkotula@unimax.com