Arts

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

Quick Index

DESCRIPTION

Class Summary

class Arts

{

public:
Arts();
~Arts();
void AddHostAttribute(ipv4addr_t hostAddr);
void AddCreationAttribute(uint32_t creationTime);
void AddPeriodAttribute(uint32_t startTime, uint32_t endTime);
void AddIfIndexAttribute(uint16_t ifIndex);
ArtsHeader & Header() const ;
vector<ArtsAttribute> & Attributes() const ;
ArtsIpPathData* IpPathData() const ;
ArtsAsMatrixData* AsMatrixData() const ;
ArtsNetMatrixData* NetMatrixData() const ;
ArtsPortTableData* PortTableData() const ;
ArtsSelectedPortTableData* SelectedPortTableData() const ;
ArtsPortMatrixData* PortMatrixData() const ;
ArtsProtocolTableData* ProtocolTableData() const ;
istream & read(istream & is);
int read(int fd);
ostream& write(ostream& os);
int write(int fd);
Arts & operator = (const Arts & arts);
friend ostream& operator << (ostream& os, const Arts & arts);
protected:
struct _data;
mutable ArtsHeader _header;
mutable vector<ArtsAttribute> _attributes;
}; // Arts

Back to the top of Arts

DESCRIPTION


---------------------------------------------------------------------------
class Arts
---------------------------------------------------------------------------
Top-level Arts class. The most frequent instantiation of this class: an application needs to deal with an Arts object whose type is not known until runtime. For example, reading a file containing ARTS objects of arbitrary type or order.

In cases where an application knows what type of Arts object it needs, it should instantiate the derived class and not this class.
---------------------------------------------------------------------------

Back to the top of Arts

Arts();


-------------------------------------------------------------------------
Arts()
.........................................................................
constructor
-------------------------------------------------------------------------

  Arts();

Back to the top of Arts

~Arts();


-------------------------------------------------------------------------
~Arts()
.........................................................................
destructor
-------------------------------------------------------------------------

  ~Arts();

Back to the top of Arts

void AddHostAttribute(ipv4addr_t hostAddr);


-------------------------------------------------------------------------
void (ipv4addr_t hostAddr)
.........................................................................
Adds a host attribute with an IP address of hostAddr.
-------------------------------------------------------------------------

  void AddHostAttribute(ipv4addr_t hostAddr);

Back to the top of Arts

void AddCreationAttribute(uint32_t creationTime);


-------------------------------------------------------------------------
void AddCreationAttribute(uint32_t creationTime);
.........................................................................
Adds a creation time attribute.
-------------------------------------------------------------------------

  void AddCreationAttribute(uint32_t creationTime);

Back to the top of Arts

void AddPeriodAttribute(uint32_t startTime, uint32_t endTime);


-------------------------------------------------------------------------
void AddPeriodAttribute(uint32_t startTime, uint32_t endTime)
.........................................................................
Adds a period attribute (startTime to endTime).
-------------------------------------------------------------------------

  void AddPeriodAttribute(uint32_t startTime, uint32_t endTime);

Back to the top of Arts

void AddIfIndexAttribute(uint16_t ifIndex);


-------------------------------------------------------------------------
void AddIfIndexAttribute(uint16_t ifIndex)
.........................................................................
Adds an interface index attribute using ifIndex as value.
-------------------------------------------------------------------------

  void AddIfIndexAttribute(uint16_t ifIndex);

Back to the top of Arts

ArtsHeader & Header() const ;


-------------------------------------------------------------------------
inline ArtsHeader & Header() const
.........................................................................
Returns a reference to the header data.
-------------------------------------------------------------------------

  inline ArtsHeader & Header() const
                                  
;

Function is currently defined inline.


Back to the top of Arts

vector<ArtsAttribute> & Attributes() const ;


-------------------------------------------------------------------------
inline vector<ArtsAttribute> & Attributes() const
.........................................................................
Returns a reference to the vector of attributes.
-------------------------------------------------------------------------

  inline vector<ArtsAttribute> & Attributes() const
                                      
;

Function is currently defined inline.


Back to the top of Arts

ArtsIpPathData* IpPathData() const ;


-------------------------------------------------------------------------
inline ArtsIpPathData* IpPathData() const
.........................................................................
Returns a pointer to the IP path data in an object containing ArtsIpPathData. If the object is not holding ArtsIpPathData, returns NULL.
-------------------------------------------------------------------------

  inline ArtsIpPathData* IpPathData() const
                                        
;

Function is currently defined inline.


Back to the top of Arts

ArtsAsMatrixData* AsMatrixData() const ;


-------------------------------------------------------------------------
inline ArtsAsMatrixData* AsMatrixData() const
.........................................................................
Returns a pointer to the AS matrix data in an object. Returns NULL if there is no AS matrix data in the object.
-------------------------------------------------------------------------

  inline ArtsAsMatrixData* AsMatrixData() const
                                          
;

Function is currently defined inline.


Back to the top of Arts

ArtsNetMatrixData* NetMatrixData() const ;


-------------------------------------------------------------------------
inline ArtsNetMatrixData* NetMatrixData() const
.........................................................................
Returns a pointer to the AS matrix data in an object. Returns NULL if there is no AS matrix data in the object.
-------------------------------------------------------------------------

  inline ArtsNetMatrixData* NetMatrixData() const
                                           
;

Function is currently defined inline.


Back to the top of Arts

ArtsPortTableData* PortTableData() const ;


-------------------------------------------------------------------------
inline ArtsPortTableData* PortTableData() const
.........................................................................
Returns a pointer to the port table in the object. Returns NULL if there is no port table in the object.
-------------------------------------------------------------------------

  inline ArtsPortTableData* PortTableData() const
                                           
;

Function is currently defined inline.


Back to the top of Arts

ArtsSelectedPortTableData* SelectedPortTableData() const ;


-------------------------------------------------------------------------
inline ArtsSelectedPortTableData* SelectedPortTableData() const
.........................................................................
Returns a pointer to the selected port table in the object. Returns NULL if there is no selected port table in the object.
-------------------------------------------------------------------------

  inline ArtsSelectedPortTableData* SelectedPortTableData() const
                                                   
;

Function is currently defined inline.


Back to the top of Arts

ArtsPortMatrixData* PortMatrixData() const ;


-------------------------------------------------------------------------
inline ArtsPortMatrixData* PortMatrixData() const
.........................................................................
Returns a pointer to the port matrix in the object. Returns NULL if there is no port matrix in the object.
-------------------------------------------------------------------------

  inline ArtsPortMatrixData* PortMatrixData() const
                                            
;

Function is currently defined inline.


Back to the top of Arts

ArtsProtocolTableData* ProtocolTableData() const ;


-------------------------------------------------------------------------
inline ArtsProtocolTableData* ProtocolTableData() const
.........................................................................
Returns a pointer to the protocol table in the object. Returns NULL if there is no protocol table in the object.
-------------------------------------------------------------------------

  inline ArtsProtocolTableData* ProtocolTableData() const
                                               
;

Function is currently defined inline.


Back to the top of Arts

istream & read(istream & is);


-------------------------------------------------------------------------
istream& read(istream& is)
.........................................................................
Loads the data from an istream into the Arts object. Returns a reference to the istream.
-------------------------------------------------------------------------

  istream & read(istream & is);

Back to the top of Arts

int read(int fd);


-------------------------------------------------------------------------
int read(int fd)
.........................................................................
Loads the data from a file descriptor into the Arts object. Returns the number of bytes read on success, -1 on failure.
-------------------------------------------------------------------------

  int read(int fd);

Back to the top of Arts

ostream& write(ostream& os);


-------------------------------------------------------------------------
ostream& write(ostream& os)
.........................................................................
Writes an Arts object to an ostream. Returns a reference to the ostream.
-------------------------------------------------------------------------

  ostream& write(ostream& os);

Back to the top of Arts

int write(int fd);


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

  int write(int fd);

Back to the top of Arts

Arts & operator = (const Arts & arts);


-------------------------------------------------------------------------
Arts & operator = (const Arts & arts)
.........................................................................
Overloaded '=' operator to deep-copy an ARTS object.
-------------------------------------------------------------------------

  Arts & operator = (const Arts & arts);

Back to the top of Arts

friend ostream& operator << (ostream& os, const Arts & arts);


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

  friend ostream& operator << (ostream& os,
                               const Arts & arts);

Back to the top of Arts

struct _data;

No documentation available.

  struct {
    ArtsIpPathData*             _ipPath;
    ArtsAsMatrixData*           _asMatrix;
    ArtsPortTableData*          _portTable;
    ArtsProtocolTableData*      _protocolTable;
    ArtsNetMatrixData*          _netMatrix;
    ArtsPortMatrixData*         _portMatrix;
    ArtsSelectedPortTableData  *_selectedPortTable;
  } _data;

Back to the top of Arts

mutable ArtsHeader _header;

No documentation available.

  mutable ArtsHeader              _header;

Back to the top of Arts

mutable vector<ArtsAttribute> _attributes;

No documentation available.

  mutable vector<ArtsAttribute>   _attributes;

Back to the top of Arts

All Members

public:
void AddHostAttribute(ipv4addr_t hostAddr);
void AddCreationAttribute(uint32_t creationTime);
void AddPeriodAttribute(uint32_t startTime, uint32_t endTime);
void AddIfIndexAttribute(uint16_t ifIndex);
ArtsHeader & Header() const ;
vector<ArtsAttribute> & Attributes() const ;
ArtsIpPathData* IpPathData() const ;
ArtsAsMatrixData* AsMatrixData() const ;
ArtsNetMatrixData* NetMatrixData() const ;
ArtsPortTableData* PortTableData() const ;
ArtsSelectedPortTableData* SelectedPortTableData() const ;
ArtsPortMatrixData* PortMatrixData() const ;
ArtsProtocolTableData* ProtocolTableData() const ;
istream & read(istream & is);
int read(int fd);
ostream& write(ostream& os);
int write(int fd);
Arts & operator = (const Arts & arts);
friend ostream& operator << (ostream& os, const Arts & arts);
protected:
struct _data;
mutable ArtsHeader _header;
mutable vector<ArtsAttribute> _attributes;

Back to the top of Arts

Ancestors

Class does not inherit from any other class.

Back to the top of Arts

Descendants

Back to the top of Arts

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

Report problems to jkotula@unimax.com