ArtsHeader

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

Quick Index

Class Summary

class ArtsHeader

{

public:

uint16_t Magic() const ;

uint16_t Magic(uint16_t magic) ;

uint32_t Identifier() const ;

uint32_t Identifier(uint32_t identifier) ;

uint8_t Version() const ;

uint8_t Version(uint8_t version) ;

uint32_t Flags() const ;

uint32_t Flags(uint32_t flags) ;

uint16_t NumAttributes() const ;

uint16_t NumAttributes(uint16_t numAttributes) ;

uint32_t AttrLength() const ;

uint32_t AttrLength(uint32_t attrLength) ;

uint32_t DataLength() const ;

uint32_t DataLength(uint32_t dataLength) ;

ostream& write(ostream& os) const;

int write(int fd) const;

ArtsHeader & operator = (const ArtsHeader & artsHeader);

friend ostream& operator << (ostream& os, const ArtsHeader & artsHeader);

protected:

}; // ArtsHeader

Back to the top of ArtsHeader

DESCRIPTION

---------------------------------------------------------------------------
class ArtsHeader
---------------------------------------------------------------------------
Class to represent header portion of an ARTS data object. All ARTS objects contain an ArtsHeader. This class is used to hold information generic to ARTS objects: a magic number, an identifier, a version number, flags and some length indicators (for both attributes and data).
---------------------------------------------------------------------------

Back to the top of ArtsHeader

ArtsHeader();

-------------------------------------------------------------------------
ArtsHeader()
.........................................................................
constructor
-------------------------------------------------------------------------

  ArtsHeader();

Back to the top of ArtsHeader

~ArtsHeader();

-------------------------------------------------------------------------
~ArtsHeader()
.........................................................................
destructor
-------------------------------------------------------------------------

  ~ArtsHeader();

Back to the top of ArtsHeader

uint16_t Magic() const ;

-------------------------------------------------------------------------
inline uint16_t Magic() const
.........................................................................
Returns the magic number in the header. This will return artsC_MAGIC if all is well with the object.
-------------------------------------------------------------------------

  inline uint16_t Magic() const
                                 
;

Function is currently defined inline.

Back to the top of ArtsHeader

uint16_t Magic(uint16_t magic) ;

-------------------------------------------------------------------------
inline uint16_t Magic(uint16_t magic)
.........................................................................
Sets and returns the magic number in the header. It should always be set to artsC_MAGIC.
-------------------------------------------------------------------------

  inline uint16_t Magic(uint16_t magic)
                                                           
;

Function is currently defined inline.

Back to the top of ArtsHeader

uint32_t Identifier() const ;

-------------------------------------------------------------------------
inline uint32_t Identifier() const
.........................................................................
Returns the identifier in the header. The identifier indicates what type of ARTS object we have.
-------------------------------------------------------------------------

  inline uint32_t Identifier() const
                                
;

Function is currently defined inline.

Back to the top of ArtsHeader

uint32_t Identifier(uint32_t identifier) ;

-------------------------------------------------------------------------
inline uint32_t Identifier(uint32_t identifier)
.........................................................................
Sets and returns the identifier in the header. The identifier indicates what type of ARTS object we have.
-------------------------------------------------------------------------

  inline uint32_t Identifier(uint32_t identifier)
                                                                          
;

Function is currently defined inline.

Back to the top of ArtsHeader

uint8_t Version() const ;

-------------------------------------------------------------------------
inline uint8_t Version() const
.........................................................................
Returns the object version from the header. ARTS objects of a particular type (see Identifier()) may support more than one version, typically for different on-disk formats.
-------------------------------------------------------------------------

  inline uint8_t Version() const
                                   
;

Function is currently defined inline.

Back to the top of ArtsHeader

uint8_t Version(uint8_t version) ;

-------------------------------------------------------------------------
inline uint8_t Version(uint8_t version)
.........................................................................
Sets and returns the object version from the header. ARTS objects of a particular type (see Identifier()) may support more than one version, typically for different on-disk formats.
-------------------------------------------------------------------------

  inline uint8_t Version(uint8_t version)
                                                                 
;

Function is currently defined inline.

Back to the top of ArtsHeader

uint32_t Flags() const ;

-------------------------------------------------------------------------
inline uint32_t Flags() const
.........................................................................
Returns the object flags from the header. Flags are used in a manner specific to the type of ARTS object.
-------------------------------------------------------------------------

  inline uint32_t Flags() const
                                 
;

Function is currently defined inline.

Back to the top of ArtsHeader

uint32_t Flags(uint32_t flags) ;

-------------------------------------------------------------------------
inline uint32_t Flags(uint32_t flags)
.........................................................................
Sets and returns the object flags from the header. Flags are used in a manner specific to the type of ARTS object.
-------------------------------------------------------------------------

  inline uint32_t Flags(uint32_t flags)
                                                           
;

Function is currently defined inline.

Back to the top of ArtsHeader

uint16_t NumAttributes() const ;

-------------------------------------------------------------------------
inline uint16_t NumAttributes() const
.........................................................................
Returns the number of attributes in the ARTS object.
-------------------------------------------------------------------------

  inline uint16_t NumAttributes() const
                                         
;

Function is currently defined inline.

Back to the top of ArtsHeader

uint16_t NumAttributes(uint16_t numAttributes) ;

-------------------------------------------------------------------------
inline uint16_t NumAttributes(uint16_t numAttributes)
.........................................................................
Sets and returns the number of attributes in the ARTS object.
-------------------------------------------------------------------------

  inline uint16_t NumAttributes(uint16_t numAttributes)
                                                                                   
;

Function is currently defined inline.

Back to the top of ArtsHeader

uint32_t AttrLength() const ;

-------------------------------------------------------------------------
inline uint32_t AttrLength() const
.........................................................................
Returns the length of the attributes in the ARTS object (bytes used to store attributes on disk).
-------------------------------------------------------------------------

  inline uint32_t AttrLength() const
                                      
;

Function is currently defined inline.

Back to the top of ArtsHeader

uint32_t AttrLength(uint32_t attrLength) ;

-------------------------------------------------------------------------
inline uint32_t AttrLength(uint32_t attrLength)
.........................................................................
Sets and returns the length of the attributes in the ARTS object (bytes used to store attributes on disk).
-------------------------------------------------------------------------

  inline uint32_t AttrLength(uint32_t attrLength)
                                                                          
;

Function is currently defined inline.

Back to the top of ArtsHeader

uint32_t DataLength() const ;

-------------------------------------------------------------------------
inline uint32_t DataLength() const
.........................................................................
Returns the length of the data in the ARTS object (bytes required to store the object data on disk minus the space required for the header and attributes).
-------------------------------------------------------------------------

  inline uint32_t DataLength() const
                                      
;

Function is currently defined inline.

Back to the top of ArtsHeader

uint32_t DataLength(uint32_t dataLength) ;

-------------------------------------------------------------------------
inline uint32_t DataLength(uint32_t dataLength)
.........................................................................
Sets and returns the length of the data in the ARTS object (bytes required to store the object data on disk minus the space required for the header and attributes).
-------------------------------------------------------------------------

  inline uint32_t DataLength(uint32_t dataLength)
                                                                          
;

Function is currently defined inline.

Back to the top of ArtsHeader

ostream& write(ostream& os) const;

-------------------------------------------------------------------------
ostream& write(ostream& os) const
.........................................................................
Writes the ARTS header to an ostream in ARTS format.
-------------------------------------------------------------------------

  ostream& write(ostream& os) const;

Back to the top of ArtsHeader

int write(int fd) const;

-------------------------------------------------------------------------
int write(int fd) const
.........................................................................
Writes the ARTS header to a file descriptor. Returns the number of bytes written on success, -1 on failure.
-------------------------------------------------------------------------

  int write(int fd) const;

Back to the top of ArtsHeader

ArtsHeader & operator = (const ArtsHeader & artsHeader);

-------------------------------------------------------------------------
ArtsHeader & operator = (const ArtsHeader & artsHeader)
.........................................................................
Overloaded '=' operator to copy an ArtsHeader.
-------------------------------------------------------------------------

  ArtsHeader & operator = (const ArtsHeader & artsHeader);

Back to the top of ArtsHeader

friend ostream& operator << (ostream& os, const ArtsHeader & artsHeader);

-------------------------------------------------------------------------
friend ostream& operator << (ostream& os, const ArtsHeader & artsHeader)
.........................................................................
Overloaded '<<' operator for dumping human-readable form of header data to an ostream.
-------------------------------------------------------------------------

  friend ostream& operator << (ostream& os, const ArtsHeader & artsHeader);

Back to the top of ArtsHeader

All Members

public:: uint16_t Magic() const ;; uint16_t Magic(uint16_t magic) ;; uint32_t Identifier() const ;; uint32_t Identifier(uint32_t identifier) ;; uint8_t Version() const ;; uint8_t Version(uint8_t version) ;; uint32_t Flags() const ;; uint32_t Flags(uint32_t flags) ;; uint16_t NumAttributes() const ;; uint16_t NumAttributes(uint16_t numAttributes) ;; uint32_t AttrLength() const ;; uint32_t AttrLength(uint32_t attrLength) ;; uint32_t DataLength() const ;; uint32_t DataLength(uint32_t dataLength) ;; ostream& write(ostream& os) const;; int write(int fd) const;; ArtsHeader & operator = (const ArtsHeader & artsHeader);; friend ostream& operator << (ostream& os, const ArtsHeader & artsHeader);
protected:

Back to the top of ArtsHeader

Ancestors

Class does not inherit from any other class.

Back to the top of ArtsHeader

Descendants

Class is not inherited by any others.

Back to the top of ArtsHeader

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

Report problems to jkotula@unimax.com