Index

DKFixedViewDataOD

Purpose:

This class is used to represent an OnDemand fixed view object.

Class summary:

class DKEXPORT DKFixedViewDataOD: public dkExtension
{  
   public:
      DKFixedViewDataOD ();
  DKFixedViewDataOD (char rotation,
                     char prmode,
                     const char* printoptions,
                     float paperwidth,
                     float paperlength,
                     char recordformat,
                     long recordlen,
                     const char* recorddelimiter,
                     char carriagecontrol,
                     DKBoolean trcpresent,
                     long codepage,
                     long pagebreaklinecount,
                     long afptolinecharsperinch,
                     long afptolinelinesperinch,
                     long defpagestoprint,
                     long numpageheaderrows,
                     long numfieldheaderrows,
                     long headervalidationrow,
                     long headervalidationcol,
                     const char* headervalidationvalue,
                     long numldfields);
  DKFixedViewDataOD (DKFixedViewDataOD& aDKFixedViewDataOD);
  ~DKFixedViewDataOD();
 
  DKString getName();
  void setName(const char* extName);
  void setRotation(char rotation);
  char getRotation();
  void setPrMode(char prmode);
  char getPrMode();
  void setPrintOptions(const char* options);
  DKString getPrintOptions();
  void setPaperWidth(float width);
  float getPaperWidth();
  void setPaperLength(float length);
  float getPaperLength();
  void setRecordFormat(char recfmt);
  char getRecordFormat();
  void setRecordLen(long reclen);
  long getRecordLen();
  void setRecordDelimiter(const char* delim);
  DKString getRecordDelimiter();
  void setCarriageControl(char cc);
  char getCarriageControl();
  void setTrcPresent(DKBoolean trc);
  DKBoolean isTrcPresent();
  void setCodepage(long cp);
  long getCodepage();
  void setPageBreakLinecount(long i);
  long getPageBreakLinecount();
  void setAfpToLineCharsPerInch(long i);
  long getAfpToLineCharsPerInch();
  void setAfpToLineLinesPerInch(long i);
  long getAfpToLineLinesPerInch();
  void setDefPagesToPrint(long numpages);
  long getDefPagesToPrint();
  void setNumPageHeaderRows(long i);
  long getNumPageHeaderRows();
  void setNumFieldHeaderRows(long i);
  long getNumFieldHeaderRows();
  void setHeaderValidationRow(long i);
  long getHeaderValidationRow();
  void setHeaderValidationCol(long i);
  long getHeaderValidationCol();
  void setHeaderValidationValue(const char* value);
  DKString getHeaderValidationValue();
  void setNumLDFields(long i);
  long getNumLDFields();
  void addLDField(void * field);
  DKSequentialCollection* getLDFields ();
};

Members:

Constructors and destructor
The first constructor is the default constructor for DKFixedViewDataOD. The second constructor constructs a DKFixedViewDataOD object with various values passed in. The third one is a copy constructor which takes a DKFixedViewDataOD object reference as the input parameter.
   DKFixedViewDataOD ();
DKFixedViewDataOD (char rotation,
                   char prmode,
                   const char* printoptions,
                   float paperwidth,
                   float paperlength,
                   char recordformat,
                   long recordlen,
                   const char* recorddelimiter,
                   char carriagecontrol,
                   DKBoolean trcpresent,
                   long codepage,
                   long pagebreaklinecount,
                   long afptolinecharsperinch,
                   long afptolinelinesperinch,
                   long defpagestoprint,
                   long numpageheaderrows,
                   long numfieldheaderrows,
                   long headervalidationrow,
                   long headervalidationcol,
                   const char* headervalidationvalue,long numldfields);
 
DKFixedViewDataOD (DKFixedViewDataOD& aDKFixedViewDataOD);
 
~DKFixedViewDataOD();
 
 

Member functions
The following functions are highly OnDemand specific. The knowledge of OnDemand and AFP (Advanced Function Printing/Presentation) is assumed. It is not the scope this document to explain the meanings of various parameters used in this class.

getName
Gets the name of this extension object..
   DKString getName();
 

setName
Sets the name of this extension object.
  void setName(const char* extName); 

setRotation
This function is not supported.
  Sets the rotation value.   
 

Valid values are:
0 -- 0 degree rotation 9 -- 90 degree rotation 1 -- 180 degree rotation 2 -- 270 degree rotation void setRotation(char rotation);

getRotation
Gets the rotation value.
  char getRotation();
 

setPrMode
Sets the PrMode to instruct OnDemand how to handle shift-in and shift-out codes contained in the line data.
  

Valid values are:
N -- NONE 1 -- SOSI1 2 -- SOSI2 3 -- SOSI3 void setPrMode(char prmode);

getPrMode
Gets the PrMode value.
  char getPrMode(); 

setPrintOptions
Sets the print options.
  void setPrintOptions(const char* options);
 

getPrintOptions
Gets the print options.
  DKString getPrintOptions(); 

setPaperWidth
Sets the paper width value.
  void setPaperWidth(float width); 

getPaperWidth
Gets the paper width value.
  float getPaperWidth(); 

setPaperLength
Sets the paper length value.
  void setPaperLength(float length); 

getPaperLength
Gets the paper length value.
  float getPaperLength(); 

setRecordFormat
Sets the record format.
  

Valid values are:
F -- fixed V -- variable S -- stream void setRecordFormat(char recfmt);

getRecordFormat
Gets the record format.
  char getRecordFormat(); 

setRecordLen
Sets the record length.
  void setRecordLen(long reclen); 

getRecordLen
Gets the record length.
  long getRecordLen(); 

setRecordDelimiter
Sets the record delimiter.
  void setRecordDelimiter(const char* delim); 

getRecordDelimiter
Gets the record delimiter.
  DKString getRecordDelimiter(); 

setCarriageControl
Sets the carrier control character.
  

Valid values are:
N -- no carriage control A -- ANSI carriage control M -- machine carriage control void setCarriageControl(char cc);

getCarriageControl
Gets the carrier control character.
  char getCarriageControl(); 

setTrcPresent
Sets the flag to indicate whether the table reference character (TRC) is present.
  void setTrcPresent(DKBoolean trc); 

getHeaderValidationCol
Gets the header validation column value.
 long getHeaderValidationCol();

setHeaderValidationValue
Sets the header validation value.
  void setHeaderValidationValue(const char* value); 

getHeaderValidationValue
Gets the header validation value.
  DKString getHeaderValidationValue(); 

setNumLDFields
Sets the number of line data fields (header columns).
  void setNumLDFields(long i); 

getNumLDFields
Gets the number of line data fields (header columns).
  long getNumLDFields(); 

addLDField
Adds a line data field (header column).
  void addLDField(void * field); 

getLDFields
Gets all the line data fields (header columns).
  DKSequentialCollection* getLDFields (); 

(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.