AURobotServers  4
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
UResNavIfMan Class Reference

#include <uresnavifman.h>

Inheritance diagram for UResNavIfMan:
Inheritance graph

Public Member Functions

virtual const char * commandList ()
 
UClientManSeq ** getMans ()
 
int getMansCnt ()
 
virtual bool gotAllResources (char *missingThese, int missingTheseCnt)
 
virtual void handleNewData (USmlTag *tag, const char *ifname)
 
virtual const char * name ()
 
virtual const char * print (const char *preString, char *buff, int buffCnt)
 
virtual bool setResource (UResBase *resource, bool remove)
 
virtual const char * snprint (const char *preString, char *buff, int buffCnt)
 
 UResNavIfMan ()
 
void UResNavIfManInit ()
 
virtual ~UResNavIfMan ()
 
- Public Member Functions inherited from UResIfBase
 UResIfBase ()
 
 ~UResIfBase ()
 
- Public Member Functions inherited from UClientFuncBase
virtual void changedNamespace (const char *newNamespace)
 
virtual void doTimeTick ()
 
int getMsgCnt ()
 
bool getVerbose ()
 
bool sendMsg (UClientPortSml *cnn, const char *buff, int buffCnt)
 
bool sendMsg (UClientPortSml *cnn, const char *buff)
 
void setVerbose (bool value)
 
 UClientFuncBase ()
 
virtual ~UClientFuncBase ()
 
- Public Member Functions inherited from UResVarPool
int addMethod (const char *formalName, const char *paramTypes, const char *comment)
 
int addMethodV (const char *formalName, const char *paramTypes, const char *comment)
 
UVarPooladdStruct (const char *name, const char *comment, bool copy=false)
 
UVariableaddVar (const char *name, const double initialValue, const char *type, const char *comment)
 
UVariableaddVar (const char *name, const char *initialValue, const char *type, const char *comment)
 
UVariableaddVarA (const char *name, const char *initialValue, const char *type, const char *comment)
 
bool callGlobal (const char *name, const char *paramOrder, char **strings, const double *doubles, double *value, UDataBase **returnStruct, int *returnStructCnt)
 
bool callGlobalV (const char *name, const char *paramOrder, UVariable **params, UDataBase **returnStruct, int *returnStructCnt)
 Call a method from the root var pool scope It may be in the structure direct (no '.') or in any sub-structure that the 'name.subname' indicate. More...
 
bool callLocal (const char *name, const char *paramOrder, char **strings, const double *doubles, double *value, UDataBase **returnStruct, int *returnStructCnt)
 
bool callVS (const char *function, const char *stringParam)
 
int callVSCD (const char *function, const char *strPar, UDataBase *data, int cooSys)
 
void createBaseVar ()
 
virtual bool createVarSpace (const int varCnt, const int structCnt, const int methCnt, const char *note, bool copy=false)
 
bool getGlobalString (const char *name, const char **value)
 
bool getGlobalValue (const char *name, double *value)
 
bool getGlobalValue (const char *name, const char **value)
 
bool getGlobalValue (const char *name, bool *value)
 
bool getGlobalValue (const char *name, UTime *value)
 
bool getLocalValue (const char *name, double *value)
 get a value in this variable tree More...
 
bool getLocalValue (const char *name, bool *value)
 
bool getLocalValue (const char *name, UTime *value)
 
double getLocalValue (int idx)
 
UPosition getLocalValue3D (int idx)
 
UPosRot getLocalValue6D (int idx)
 
bool getLocalValueBool (int idx)
 
int getLocalValueInt (int idx)
 
UTime getLocalValueTime (int idx)
 
const char * getLogFileName ()
 
const char * getVarDescription (int idx)
 
UVarCalcgetVarPool ()
 
bool isLogFileOpen ()
 
bool isLogFileOpen (const char *structName)
 
bool isVarPoolUpdated (int lastCnt, int *newCnt)
 
void logFileClose ()
 
bool logFileOpen ()
 
void logFileStart (const char *structName, bool open)
 
virtual bool methodCall (const char *name, const char *paramOrder, char **strings, const double *doubles, double *value, UDataBase **returnStruct=NULL, int *returnStructCnt=NULL)
 
bool setGlobalVar (const char *name, const double value, bool mayAdd)
 Assigns a value to a variable. The variable may be a part of a structure. More...
 
bool setLocalVar (int idx, double value, const int element)
 
bool setLocalVar (const char *name, const double value, bool mayAdd)
 Assigns a value to a variable. The variable may be a part of a structure. More...
 
bool setLocalVar3D (int idx, UPosition *value)
 
bool setLocalVar6D (int idx, UPosRot *value)
 
bool setLocalVarAdd (int idx, double value, const int element)
 
bool setLocalVarPose (int idx, UPose *value)
 
void setVarPool (UVarCalc *sharedVarPool)
 
int updateQTvars (int structIdx)
 
 UResVarPool ()
 
virtual ~UResVarPool ()
 
- Public Member Functions inherited from UResBase
void createReplayVar (UVarPool *pool)
 
virtual void createResources ()
 
UCmdExegetCorePointer ()
 
char * getLogFileName (char *fn, const int fnCnt)
 
int getResFuncIdx ()
 
const char * getResID ()
 
int getResVersion ()
 
bool isA (const char *idStr)
 
bool isAlsoA (const char *id)
 
virtual void print (const char *preString)
 
virtual void saveSettings ()
 
void setCorePointer (UCmdExe *serverCore)
 
void setResFuncIdx (int idx)
 
virtual void setResID (const char *id, const int version)
 
virtual void stop (bool)
 
virtual void updateReplayStatus ()
 
 UResBase ()
 
virtual ~UResBase ()
 
- Public Member Functions inherited from UReplay
void addChild (UReplay *child)
 
virtual bool decodeReplayLine (char *)
 
char * getLogFileName (char *fn, const int fnCnt)
 
char * getReplayFileName (char *fn, const int fnCnt)
 
int getReplayLogLine ()
 
bool isReplay ()
 
bool isReplayFileOpen ()
 
void removeChild (UReplay *child)
 
virtual void replayAdvanceTime (UTime untilTime)
 
void replaySetBaseFileName (const char *name, const char *preName="")
 
void replaySetFileName (const char *name)
 
virtual bool replayStep ()
 
int replayStep (int steps)
 
virtual bool replayToTime (UTime untilTime)
 
void setParent (UReplay *parent)
 
bool setReplay (bool value)
 
 UReplay ()
 
virtual ~UReplay ()
 
- Public Member Functions inherited from ULock
bool lock ()
 
void lockInit ()
 
void post ()
 
bool tryLock ()
 
bool tryWait ()
 
 ULock ()
 
void unlock ()
 
bool wait ()
 
 ~ULock ()
 
- Public Member Functions inherited from UVarMethodImplement
virtual bool methodCallV (const char *name, const char *paramOrder, UVariable *params[], UDataBase **returnStruct, int *returnStructCnt)
 
virtual ~UVarMethodImplement ()
 

Static Public Member Functions

static const char * getResClassID ()
 
- Static Public Member Functions inherited from UResVarPool
static const char * getResClassID ()
 

Protected Member Functions

void createBaseVar ()
 
virtual void gotNewData ()
 
bool handleManData (USmlTag *tag)
 
- Protected Member Functions inherited from UClientFuncBase
void handleHelp (USmlTag *tag)
 
void printReply (USmlTagIn *tag, const char *preString)
 
- Protected Member Functions inherited from UResVarPool
void setDescription (const char *note, bool copy=false)
 
- Protected Member Functions inherited from UResBase
UResBasegetStaticResource (const char *resName, bool mayCreate, bool staticOnly=true)
 get a pointer to a static resource. More...
 

Protected Attributes

bool callDispOnNewData
 
int manBest
 
UClientManSeqmans [MAX_STORED_MANS]
 
int mansCnt
 
UVariablevarMansCnt
 
UVariablevarManTime
 
- Protected Attributes inherited from UClientFuncBase
int msgHandled
 
char serverNamespace [MAX_SML_NAME_LENGTH]
 
int serverNamespaceValue
 
bool verboseMessages
 
- Protected Attributes inherited from UResBase
int resFuncIdx
 
char resID [MAX_RESOURCE_ID_LENGTH]
 
char resIsAlso [MAX_RESOURCE_ISALSO_LENGTH]
 
int resVersion
 
- Protected Attributes inherited from UReplay
bool replay
 
FILE * replayFile
 
char replayFileName [REPLAY_FILE_NAME_LENGTH]
 replay filename More...
 
char replayLine [MAX_LOG_LINE_LENGTH]
 
int replayLogLine
 
UReplayreplayParent
 
UTime replayTimeNext
 

Static Protected Attributes

static const int MAX_STORED_MANS = 50
 
- Static Protected Attributes inherited from UReplay
static const int MAX_LOG_LINE_LENGTH = 10000
 
static const int REPLAY_FILE_NAME_LENGTH = 264
 max length of replay filename More...
 

Additional Inherited Members

- Public Attributes inherited from UClientFuncBase
ULock decodeLock
 
- Public Attributes inherited from UReplay
bool replayTimeAdvancePending
 
UTime replayTimeNow
 

Detailed Description

Client interface for basic scan data

    @author Christian Andersen <jca@oersted.dtu.dk>

Constructor & Destructor Documentation

UResNavIfMan::UResNavIfMan ( )
inline

Constructor

UResNavIfMan::~UResNavIfMan ( )
virtual

Destructor

Member Function Documentation

const char * UResNavIfMan::commandList ( )
virtual

Function, that shall return a string with all handled commands, i.e. should return "gmk gmk2d guidemark", if commands starting with any of these three keywords are handled by this function

Reimplemented from UClientFuncBase.

void UResNavIfMan::createBaseVar ( )
protected

Create variables for this resource

References UVarPool::addVar().

UClientManSeq** UResNavIfMan::getMans ( )
inline

Get first pointer to the array of manoeuvre sequences (first element of a pointer array)

Referenced by UNavPaint::paint().

int UResNavIfMan::getMansCnt ( )
inline

Get number of available manoeuvre sequences available (valid)

Referenced by UNavPaint::paint().

static const char* UResNavIfMan::getResClassID ( )
inlinestatic

Fixed name of this resource type

References UDataBase::snprint().

Referenced by UNavPaint::setResource(), UFunctionLaserIfData::setResource(), and UNavView::setResource().

bool UResNavIfMan::gotAllResources ( char *  missingThese,
int  missingTheseCnt 
)
virtual

Is this resource missing any base ressources

Reimplemented from UResVarPool.

References UResVarPool::gotAllResources().

void UResNavIfMan::gotNewData ( )
protectedvirtual

The varPool has methods, and a call to one of these are needed. Do the call now and return (a double sized) result in 'value' and return true if the method call is allowed. If the returnStruct and returnStructCnt is not NULL, then a number (no more than initial value of returnStructCnt) of structures based on UDataBase may be returned into returnStruct array of pointers. The returnStructCnt should be modified to the actual number of used pointers (if needed). Called when a new set of manoeuvres are received. The selected manoeuvre is used as parameter.

References UTime::getDecSec(), and UTime::now().

bool UResNavIfMan::handleManData ( USmlTag tag)
protected
void UResNavIfMan::handleNewData ( USmlTag tag,
const char *  ifname 
)
virtual

Got fresh data destined to this function.

Reimplemented from UClientFuncBase.

References USmlTagIn::getNextAttribute(), USmlTagIn::isTagA(), MAX_SML_NAME_LENGTH, USmlTagIn::print(), and USmlTagIn::reset().

const char * UResNavIfMan::name ( )
virtual

Name of function The returned name is intended as informative to clients and should include a version number

Reimplemented from UClientFuncBase.

virtual const char* UResNavIfMan::print ( const char *  preString,
char *  buff,
int  buffCnt 
)
inlinevirtual

Print status for this resource

Reimplemented from UResVarPool.

References UDataBase::snprint().

bool UResNavIfMan::setResource ( UResBase resource,
bool  remove 
)
virtual

Set ressource as needed (probably not used by this resource)

Reimplemented from UResVarPool.

References UResVarPool::setResource().

const char * UResNavIfMan::snprint ( const char *  preString,
char *  buff,
int  buffCnt 
)
virtual

The server has set (or changed) the namespace Fixed name of this resource type Fixed varsion number for this resource type. Should follow release version, i.e. version 1.28 gives number 128. Should be incremented only when there is change to this class definition, i.e new or changed functions or variables. Print status for this resource

References UTime::getTimeAsString().

void UResNavIfMan::UResNavIfManInit ( )

Initialize class

Member Data Documentation

bool UResNavIfMan::callDispOnNewData
protected

Call display dunction when new data is available

int UResNavIfMan::manBest
protected

Index to the best of the alternative manoeuvre sequences

UClientManSeq* UResNavIfMan::mans[MAX_STORED_MANS]
protected

Man sequences

int UResNavIfMan::mansCnt
protected

Number of valid manoeuvre alternatives

const int UResNavIfMan::MAX_STORED_MANS = 50
staticprotected

Max number of stored manoeuver alternatives

UVariable* UResNavIfMan::varMansCnt
protected

Index to manoeuvre count variable

UVariable* UResNavIfMan::varManTime
protected

Index to latest update time


The documentation for this class was generated from the following files: