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

#include <uclientfuncpath.h>

Inheritance diagram for UClientFuncPath:
Inheritance graph

Public Member Functions

virtual const char * commandList ()
 
virtual const char * commandList ()
 
UVisData * getVisData ()
 
UVisData * getVisData (int idx)
 
int getVisDataCnt ()
 
virtual void handleNewData (USmlTag *tag, const char *ifname)
 
virtual void handleNewData (USmlTag *tag, const char *ifname)
 
virtual const char * name ()
 
virtual const char * name ()
 
 UClientFuncPath ()
 
 UClientFuncPath ()
 
 ~UClientFuncPath ()
 
 ~UClientFuncPath ()
 
- 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)
 
UVarPool * addStruct (const char *name, const char *comment, bool copy=false)
 
UVariable * addVar (const char *name, const double initialValue, const char *type, const char *comment)
 
UVariable * addVar (const char *name, const char *initialValue, const char *type, const char *comment)
 
UVariable * addVarA (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)
 
UVarCalc * getVarPool ()
 
virtual bool gotAllResources (char *missingThese, int missingTheseCnt)
 
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)
 
virtual const char * print (const char *preString, char *buff, int buffCnt)
 
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)
 
virtual bool setResource (UResBase *resource, bool remove)
 
void setVarPool (UVarCalc *sharedVarPool)
 
int updateQTvars (int structIdx)
 
 UResVarPool ()
 
virtual ~UResVarPool ()
 
- Public Member Functions inherited from UResBase
void createReplayVar (UVarPool *pool)
 
virtual void createResources ()
 
UCmdExe * getCorePointer ()
 
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 ()
 

Protected Member Functions

void handlePathGetMsg (USmlTag *tag)
 
void handlePathGetMsg (USmlTag *tag)
 
void handlePathPolygonData (USmlTag *iTag)
 
void handlePathPolygonData (USmlTag *tag, UVisData *destination)
 
virtual void newDataAvailable (UProbPoly *poly)
 
virtual void newDataAvailable (UProbPoly *poly)
 
- 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
UResBase * getStaticResource (const char *resName, bool mayCreate, bool staticOnly=true)
 get a pointer to a static resource. More...
 

Protected Attributes

UProbPoly * poly
 
char polyName [MAX_SML_NAME_LENGTH]
 
UVisData * visData [MAX_VIS_DATA]
 
int visDataCnt
 
int visDataMax
 
- 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
 
UReplay * replayParent
 
UTime replayTimeNext
 

Static Protected Attributes

static const int MAX_VIS_DATA = 100
 
- 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...
 

Private Attributes

UProbPoly polyData
 

Additional Inherited Members

- Static Public Member Functions inherited from UResVarPool
static const char * getResClassID ()
 
- Public Attributes inherited from UClientFuncBase
ULock decodeLock
 
- Public Attributes inherited from UReplay
bool replayTimeAdvancePending
 
UTime replayTimeNow
 

Detailed Description

Class to handle path data

Author
Christian Andersen

Constructor & Destructor Documentation

UClientFuncPath::UClientFuncPath ( )

Constructor

References poly, and polyData.

UClientFuncPath::~UClientFuncPath ( )

Destructor

UClientFuncPath::UClientFuncPath ( )

Constructor

UClientFuncPath::~UClientFuncPath ( )

Destructor

Member Function Documentation

const char * UClientFuncPath::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.

virtual const char* UClientFuncPath::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.

UVisData* UClientFuncPath::getVisData ( )
inline

Get pointer to - newest - vision data

References visData.

Referenced by UNavPaint::paint().

UVisData* UClientFuncPath::getVisData ( int  idx)
inline

Get pointer to vision data with this age

References maxi(), mini(), visData, and visDataCnt.

int UClientFuncPath::getVisDataCnt ( )
inline

Get number of available vision based polygons

References handlePathGetMsg(), handlePathPolygonData(), newDataAvailable(), poly, and visDataCnt.

Referenced by UNavPaint::paint().

void UClientFuncPath::handleNewData ( USmlTag *  tag,
const char *  ifname 
)
virtual

Got fresh data destined to this function.

Reimplemented from UClientFuncBase.

References handlePathGetMsg(), USmlTagIn::isTagA(), and UClientFuncBase::printReply().

virtual void UClientFuncPath::handleNewData ( USmlTag *  tag,
const char *  ifname 
)
virtual

Got fresh data destined to this function.

Reimplemented from UClientFuncBase.

void UClientFuncPath::handlePathGetMsg ( USmlTag *  tag)
protected

Unpack pathGet message

References USmlTagIn::getNextAttribute(), USmlTag::getNextTag(), handlePathPolygonData(), MAX_SML_NAME_LENGTH, and polyName.

Referenced by getVisDataCnt(), and handleNewData().

void UClientFuncPath::handlePathGetMsg ( USmlTag *  tag)
protected

Unpack pathGet message

void UClientFuncPath::handlePathPolygonData ( USmlTag *  iTag)
protected

Unpack path polygon

References UProbPoly::getIsObst(), USmlTagIn::getNextAttribute(), USmlTag::getNextTag(), UPolygon::getPoints(), USmlTagIn::getTime(), USmlTagIn::isAnEndTag(), USmlTagIn::isAStartTag(), USmlTagIn::isTagA(), MAX_SML_NAME_LENGTH, newDataAvailable(), poly, USmlTagIn::print(), UClientFuncBase::printReply(), UPolygon::setPointsCnt(), UProbPoly::setTime(), USmlTag::skipToEndTag(), str2bool(), UPosition::x, UPosition::y, and UPosition::z.

Referenced by getVisDataCnt(), and handlePathGetMsg().

void UClientFuncPath::handlePathPolygonData ( USmlTag *  tag,
UVisData *  destination 
)
protected

Unpack path polygon

References UProbPoly::clear(), USmlTag::cnnVerbose(), UProbPoly::getIsObst(), USmlTagIn::getNextAttribute(), USmlTag::getNextTag(), UPolygon::getPoints(), UVisData::getPoly(), USmlTagIn::getTime(), USmlTagIn::isAnEndTag(), USmlTagIn::isAStartTag(), USmlTagIn::isTagA(), USmlTagIn::isValid(), ULock::lock(), MAX_SML_NAME_LENGTH, newDataAvailable(), UVisData::polyLock, USmlTagIn::print(), UClientFuncBase::printReply(), UPolygon::setPointsCnt(), UVisData::setPolyNew(), UProbPoly::setTime(), UProbPoly::setValid(), USmlTag::skipToEndTag(), str2bool(), ULock::unlock(), UPosition::x, UPosition::y, and UPosition::z.

const char * UClientFuncPath::name ( )
virtual

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

Reimplemented from UClientFuncBase.

virtual const char* UClientFuncPath::name ( )
virtual

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

Reimplemented from UClientFuncBase.

void UClientFuncPath::newDataAvailable ( UProbPoly *  poly)
protectedvirtual

This function is called, when a new polygon is unpacked. It can be used to trigger other functions.

Reimplemented in UResCamIfPath.

References UPolygon::getPointsCnt().

Referenced by getVisDataCnt(), and handlePathPolygonData().

virtual void UClientFuncPath::newDataAvailable ( UProbPoly *  poly)
protectedvirtual

This function is called, when a new polygon is unpacked. It can be used to trigger other functions.

Reimplemented in UResCamIfPath.

Member Data Documentation

const int UClientFuncPath::MAX_VIS_DATA = 100
staticprotected
UProbPoly* UClientFuncPath::poly
protected

Pointer to polygon data buffer

Referenced by getVisDataCnt(), handlePathPolygonData(), UResCamIfPath::print(), UResCamIfPath::snprint(), and UClientFuncPath().

UProbPoly UClientFuncPath::polyData
private

Polygon buffer

Referenced by UClientFuncPath().

char UClientFuncPath::polyName[MAX_SML_NAME_LENGTH]
protected

Name of received polygon

Referenced by handlePathGetMsg().

UVisData* UClientFuncPath::visData[MAX_VIS_DATA]
protected

Pointer to vision data

Referenced by getVisData(), and UResCamIfPath::snprint().

int UClientFuncPath::visDataCnt
protected

Actual number of used vision data

Referenced by getVisData(), getVisDataCnt(), and UResCamIfPath::snprint().

int UClientFuncPath::visDataMax
protected

Maximum allowed vision data structures

Referenced by UResCamIfPath::snprint().

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.11