stilheader.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2006 International Business Machines Corporation
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.opensource.org/licenses/cpl1.0.php
 *
 * Contributors:
 *    Douglas Sprague, Joel Wheeler - initial API and implementation
 *
 *****************************************************************************/

#ifndef STILHeader_H
#define STILHeader_H

#include "stilcomstr.h"


#include "stilcom.h"               
#include "stilblock.h"         
#include "stilhistory.h"       

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
class STILHeader : public STILBlock {

  // - Public members
  public:

    // - Default Constructor
    STILHeader();

    // - Copy Constructor
    STILHeader(const STILHeader &);

    // - Destructor
    virtual ~STILHeader();

    // - Assignment operator
    STILHeader & operator=(const STILHeader &);

    // - Initialize this STILHeader object.
    void        init();

    // - Write out Header to a given FILE
    virtual void write(FILE * pOutFile, LONG indentation=0) const;


    // - Get/Set the current Title
    const sstring & getTitle() const;
    void        setTitle(const sstring &);

    // - Get/Set the current Date
    const sstring & getDate() const;
    void           setDate(const sstring &);

    // - Get/Set the current Source
    const sstring & getSource() const;
    void           setSource(const sstring &);

    // - Get/New the History block (new used for writing)
    const STILHistory * getHistory() const;
    void                setHistory(const STILHistory &);


  // Private members
  private:

    sstring                 m_title;           // STIL Header::Title
    sstring                 m_date  ;          // STIL Header::Date
    sstring                 m_source;          // STIL Header::Source
    STILHistory             m_history;         // STIL Header::History

}; // end STILHeader class

// Inline functions
//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline const sstring & STILHeader::getTitle() const { return m_title; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void           STILHeader::setTitle(const sstring & t) {
  m_title = t;
  addEntity(Title,"Title",t);
}

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline const sstring & STILHeader::getDate() const { return m_date; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void           STILHeader::setDate(const sstring & d) {
  m_date = d;
  addEntity(Date,"Date",d);
}

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline const sstring & STILHeader::getSource() const { return m_source; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void           STILHeader::setSource(const sstring & s) {
  m_source = s;
  addEntity(Source,"Source",s);
}

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline const STILHistory *  STILHeader::getHistory() const{ return &m_history; }



#endif

---

This page last updated on 6 Jul 2007