kstars

scriptfunction.h

00001 /***************************************************************************
00002                           scriptfunction.h  -  description
00003                              -------------------
00004     begin                : Thu Apr 17 2003
00005     copyright            : (C) 2003 by Jason Harris
00006     email                : kstars@30doradus.org
00007  ***************************************************************************/
00008 
00009 /***************************************************************************
00010  *                                                                         *
00011  *   This program is free software; you can redistribute it and/or modify  *
00012  *   it under the terms of the GNU General Public License as published by  *
00013  *   the Free Software Foundation; either version 2 of the License, or     *
00014  *   (at your option) any later version.                                   *
00015  *                                                                         *
00016  ***************************************************************************/
00017 
00018 #ifndef SCRIPTFUNCTION_H
00019 #define SCRIPTFUNCTION_H
00020 
00021 #include <qstring.h>
00022 
00027 class ScriptFunction
00028 {
00029 public:
00030     ScriptFunction( QString name, QString desc, bool clockfcn=false,
00031             QString at1="", QString an1="",
00032             QString at2="", QString an2="",
00033             QString at3="", QString an3="",
00034             QString at4="", QString an4="",
00035             QString at5="", QString an5="",
00036             QString at6="", QString an6=""
00037     );
00038     ScriptFunction( ScriptFunction *sf );
00039     ~ScriptFunction();
00040 
00041     QString name() const { return Name; }
00042     QString prototype() const;
00043     QString description() const { return Description; }
00044     QString argType( unsigned int n ) const { return ArgType[n]; }
00045     QString argName( unsigned int n ) const { return ArgName[n]; }
00046     QString argVal( unsigned int n ) const { return ArgVal[n]; }
00047 
00048     void setValid( bool b ) { Valid = b; }
00049     bool valid() const { return Valid; }
00050 
00051     void setClockFunction( bool b=true ) { ClockFunction = b; }
00052     bool isClockFunction() const { return ClockFunction; }
00053 
00054     void setArg( unsigned int n, QString newVal ) { ArgVal[n] = newVal; }
00055     bool checkArgs();
00056     unsigned int numArgs() const { return NumArgs; }
00057 
00058     QString scriptLine() const;
00059     
00060     void    setINDIProperty(QString prop) { INDIProp = prop; }
00061     QString INDIProperty() const { return INDIProp; }
00062 
00063 private:
00064     QString Name, Description;
00065     QString ArgType[6];
00066     QString ArgName[6];
00067     QString ArgVal[6];
00068     QString INDIProp;
00069     bool Valid, ClockFunction;
00070     unsigned int NumArgs;
00071 };
00072 
00073 #endif
kstars

scriptfunction.h

kstars

API Reference
