ArtsNetMatrixEntry


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

Quick Index

DESCRIPTION

Class Summary

class ArtsNetMatrixEntry

{

public:
ArtsNetMatrixEntry();
uint16_t Descriptor() const ;
uint16_t Descriptor(uint16_t descriptor) ;
ipv4addr_t Src() const ;
uint8_t SrcMaskLen() const;
uint8_t SrcMaskLen(uint8_t maskLen);
ipv4addr_t Src(ipv4addr_t src) ;
ipv4addr_t Dst() const ;
uint8_t DstMaskLen() const;
uint8_t DstMaskLen(uint8_t maskLen);
ipv4addr_t Dst(ipv4addr_t dst) ;
uint64_t Pkts() const ;
uint64_t Pkts(uint64_t pkts);
uint64_t Bytes() const ;
uint64_t Bytes(uint64_t bytes);
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 ) const;
int write(int fd, uint8_t version ) const;
friend ostream & operator << (ostream& os, const ArtsNetMatrixEntry & artsNetMatrixEntry);
protected:
}; // ArtsNetMatrixEntry

Back to the top of ArtsNetMatrixEntry


DESCRIPTION


---------------------------------------------------------------------------
class ArtsNetMatrixEntry
---------------------------------------------------------------------------
Class representing a single net matrix entry. This class holds a source net number, a destination net number, and the packets and bytes sent from the source net to the destination net.
---------------------------------------------------------------------------

Back to the top of ArtsNetMatrixEntry


ArtsNetMatrixEntry();


-------------------------------------------------------------------------
ArtsNetMatrixEntry()
.........................................................................
constructor
-------------------------------------------------------------------------

  ArtsNetMatrixEntry();

Back to the top of ArtsNetMatrixEntry


uint16_t Descriptor() const ;


-------------------------------------------------------------------------
inline uint16_t Descriptor() const
.........................................................................
Returns the descriptor field of the object. The descriptor field is a bitfield containing indicators of the length of the Src(), Dst(), Pkts() and Bytes() fields when stored on disk or sent via a socket.
-------------------------------------------------------------------------

  inline uint16_t Descriptor() const
                                      
;

Function is currently defined inline.


Back to the top of ArtsNetMatrixEntry


uint16_t Descriptor(uint16_t descriptor) ;


-------------------------------------------------------------------------
inline uint16_t Descriptor(uint16_t descriptor)
.........................................................................
Sets and returns the descriptor field of the object.
-------------------------------------------------------------------------

  inline uint16_t Descriptor(uint16_t descriptor)
                                                                          
;

Function is currently defined inline.


Back to the top of ArtsNetMatrixEntry


ipv4addr_t Src() const ;


-------------------------------------------------------------------------
inline ipv4addr_t Src() const
.........................................................................
Returns the source net number.
-------------------------------------------------------------------------

  inline ipv4addr_t Src() const
                               
;

Function is currently defined inline.


Back to the top of ArtsNetMatrixEntry


uint8_t SrcMaskLen() const;


-------------------------------------------------------------------------
uint8_t SrcMaskLen() const
.........................................................................
Returns the source network mask length.
-------------------------------------------------------------------------

  uint8_t SrcMaskLen() const;

Back to the top of ArtsNetMatrixEntry


uint8_t SrcMaskLen(uint8_t maskLen);


-------------------------------------------------------------------------
uint8_t SrcMaskLen(uint8_t maskLen)
.........................................................................
Sets and returns the source network mask length.
-------------------------------------------------------------------------

  uint8_t SrcMaskLen(uint8_t maskLen);

Back to the top of ArtsNetMatrixEntry


ipv4addr_t Src(ipv4addr_t src) ;


-------------------------------------------------------------------------
inline ipv4addr_t Src(ipv4addr_t src)
.........................................................................
Sets and returns the source net number.
-------------------------------------------------------------------------

  inline ipv4addr_t Src(ipv4addr_t src)
                                                     
;

Function is currently defined inline.


Back to the top of ArtsNetMatrixEntry


ipv4addr_t Dst() const ;


-------------------------------------------------------------------------
inline ipv4addr_t Dst() const
.........................................................................
Returns the destination net number.
-------------------------------------------------------------------------

  inline ipv4addr_t Dst() const
                               
;

Function is currently defined inline.


Back to the top of ArtsNetMatrixEntry


uint8_t DstMaskLen() const;


-------------------------------------------------------------------------
uint8_t DstMaskLen() const
.........................................................................
Returns the destination network mask length.
-------------------------------------------------------------------------

  uint8_t DstMaskLen() const;

Back to the top of ArtsNetMatrixEntry


uint8_t DstMaskLen(uint8_t maskLen);


-------------------------------------------------------------------------
uint8_t DstMaskLen(uint8_t maskLen)
.........................................................................
Sets and returns the destination network mask length.
-------------------------------------------------------------------------

  uint8_t DstMaskLen(uint8_t maskLen);

Back to the top of ArtsNetMatrixEntry


ipv4addr_t Dst(ipv4addr_t dst) ;


-------------------------------------------------------------------------
inline ipv4addr_t Dst(ipv4addr_t dst)
.........................................................................
Sets and returns the source net number.
-------------------------------------------------------------------------

  inline ipv4addr_t Dst(ipv4addr_t dst)
                                                     
;

Function is currently defined inline.


Back to the top of ArtsNetMatrixEntry


uint64_t Pkts() const ;


-------------------------------------------------------------------------
inline uint64_t Pkts() const
.........................................................................
Returns the number of packets sent from the source net to the destination net.
-------------------------------------------------------------------------

  inline uint64_t Pkts() const
                                
;

Function is currently defined inline.


Back to the top of ArtsNetMatrixEntry


uint64_t Pkts(uint64_t pkts);


-------------------------------------------------------------------------
uint64_t Pkts(uint64_t pkts)
.........................................................................
Sets and returns the number of packets sent from the source net to the destination net.
-------------------------------------------------------------------------

  uint64_t Pkts(uint64_t pkts);

Back to the top of ArtsNetMatrixEntry


uint64_t Bytes() const ;


-------------------------------------------------------------------------
inline uint64_t Bytes() const
.........................................................................
Returns the number of bytes sent from the source net to the destination net.
-------------------------------------------------------------------------

  inline uint64_t Bytes() const
                                 
;

Function is currently defined inline.


Back to the top of ArtsNetMatrixEntry


uint64_t Bytes(uint64_t bytes);


-------------------------------------------------------------------------
uint64_t Bytes(uint64_t bytes)
.........................................................................
Sets and returns the number of bytes sent from the source net to the destination net.
-------------------------------------------------------------------------

  uint64_t Bytes(uint64_t bytes);

Back to the top of ArtsNetMatrixEntry


uint32_t Length(uint8_t version ) const;


-------------------------------------------------------------------------
uint32_t Length(uint8_t version = 2) const
.........................................................................
Returns the bytes of space required to store the ArtsNetMatrixEntry on disk.
-------------------------------------------------------------------------

  uint32_t Length(uint8_t version = 2) const;

Back to the top of ArtsNetMatrixEntry


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


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

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

Back to the top of ArtsNetMatrixEntry


int read(int fd, uint8_t version );


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

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

Back to the top of ArtsNetMatrixEntry


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


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

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

Back to the top of ArtsNetMatrixEntry


int write(int fd, uint8_t version ) const;


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

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

Back to the top of ArtsNetMatrixEntry


friend ostream & operator << (ostream& os, const ArtsNetMatrixEntry & artsNetMatrixEntry);


-------------------------------------------------------------------------
ostream & operator << (ostream& os, const ArtsNetMatrixEntry & artsNetMatrixEntry)
.........................................................................
Overloaded '<<' operator to dump the contents of an ArtsNetMatrixEntry to an ostream in a human-readable form. Returns the ostream.
-------------------------------------------------------------------------

  friend ostream & operator << (ostream& os,
                                const ArtsNetMatrixEntry & artsNetMatrixEntry);

Back to the top of ArtsNetMatrixEntry


All Members

public:
uint16_t Descriptor() const ;
uint16_t Descriptor(uint16_t descriptor) ;
ipv4addr_t Src() const ;
uint8_t SrcMaskLen() const;
uint8_t SrcMaskLen(uint8_t maskLen);
ipv4addr_t Src(ipv4addr_t src) ;
ipv4addr_t Dst() const ;
uint8_t DstMaskLen() const;
uint8_t DstMaskLen(uint8_t maskLen);
ipv4addr_t Dst(ipv4addr_t dst) ;
uint64_t Pkts() const ;
uint64_t Pkts(uint64_t pkts);
uint64_t Bytes() const ;
uint64_t Bytes(uint64_t bytes);
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 ) const;
int write(int fd, uint8_t version ) const;
friend ostream & operator << (ostream& os, const ArtsNetMatrixEntry & artsNetMatrixEntry);
protected:

Back to the top of ArtsNetMatrixEntry


Ancestors

Class does not inherit from any other class.

Back to the top of ArtsNetMatrixEntry


Descendants

Class is not inherited by any others.

Back to the top of ArtsNetMatrixEntry


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

Report problems to jkotula@unimax.com