AGX Dynamics 2.42.3.1
Loading...
Searching...
No Matches
agxPlot::Window Class Reference

#include <Window.h>

+ Inheritance diagram for agxPlot::Window:

Public Member Functions

 Window (const agx::String &id="")
 
bool add (Curve *curve)
 Add the specified curve to the plot.
 
void clearCurves ()
 
const CurveRefVector & getCurves () const
 Gets the curves belonging to the window.
 
void getDescription (agxJson::Value &root) const
 Retrieve the description, as follows.
 
bool getEnabled () const
 
const agx::String & getId () const
 
const agx::String & getName () const
 Get the name of the Window.
 
void getNewValues (DataPacket *target)
 Get all values that have been added since the last data push.
 
void getOldValues (DataPacket *target)
 Get all values that have been added since the last data push.
 
System * getPlotSystem ()
 
void setEnabled (bool enabled)
 
void setFromDescription (const agxJson::Value &root)
 set from an description of the format of getDescription.
 
void setName (const agx::String &name)
 Set the name of the Window.
 
- Public Member Functions inherited from agx::Referenced
 Referenced ()
 Default constructor.
 
 Referenced (const Referenced &)
 
template<typename T >
T * as ()
 Subclass casting.
 
template<typename T >
const T * as () const
 
template<typename T >
T * asSafe ()
 Safe subclass casting, return nullptr if template type does not match.
 
template<typename T >
const T * asSafe () const
 
int getReferenceCount () const
 
template<typename T >
bool is () const
 Subclass test.
 
Referenced & operator= (const Referenced &)
 Assignment operator. Will increment the number of references to the referenced object.
 
void reference (void *ptr=nullptr) const
 Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.
 
void unreference (void *ptr=nullptr) const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 
void unreference_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 

Public Attributes

agx::Event representationChanged
 

Additional Inherited Members

- Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool ValidateCast (const Referenced *object)
 
- Protected Member Functions inherited from agx::Referenced
virtual ~Referenced ()
 Destructor.
 
void allocateObserverVector () const
 
void deleteUsingDeleteHandler () const
 
- Static Protected Member Functions inherited from agx::Referenced
static DeleteHandler * getDeleteHandler ()
 
static void setDeleteHandler (DeleteHandler *handler)
 Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.
 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

Detailed Description

Definition at line 28 of file Window.h.

Constructor & Destructor Documentation

◆ Window()

agxPlot::Window::Window ( const agx::String &  id = "")
Parameters
idThe unique ID of the Window. Per default the name will also be this, but it can be changed. The ID is never changed though.

Member Function Documentation

◆ add()

bool agxPlot::Window::add ( Curve *  curve)

Add the specified curve to the plot.

Parameters
curveThe curve to add. Should not be nullptr. Also, getDataSeriesX and getDataSeriesY should be non-nullptr.
Return values
Wasthe curve added successfully?

◆ clearCurves()

void agxPlot::Window::clearCurves ( )

◆ getCurves()

const CurveRefVector & agxPlot::Window::getCurves ( ) const

Gets the curves belonging to the window.

◆ getDescription()

void agxPlot::Window::getDescription ( agxJson::Value &  root) const

Retrieve the description, as follows.

["name"] = the name of the window ["curves"] = an array of descriptions of all curves owned by the window

◆ getEnabled()

bool agxPlot::Window::getEnabled ( ) const

◆ getId()

const agx::String & agxPlot::Window::getId ( ) const

◆ getName()

const agx::String & agxPlot::Window::getName ( ) const

Get the name of the Window.

◆ getNewValues()

void agxPlot::Window::getNewValues ( DataPacket *  target)

Get all values that have been added since the last data push.

Adds it to the end of the of the DataPacket

Parameters
targetWhere the data should be added

◆ getOldValues()

void agxPlot::Window::getOldValues ( DataPacket *  target)

Get all values that have been added since the last data push.

Adds it to the end of the of the DataPacket

Parameters
targetWhere the data should be added

◆ getPlotSystem()

System * agxPlot::Window::getPlotSystem ( )

◆ setEnabled()

void agxPlot::Window::setEnabled ( bool  enabled)

◆ setFromDescription()

void agxPlot::Window::setFromDescription ( const agxJson::Value &  root)

set from an description of the format of getDescription.

◆ setName()

void agxPlot::Window::setName ( const agx::String &  name)

Set the name of the Window.

Member Data Documentation

◆ representationChanged

agx::Event agxPlot::Window::representationChanged

Definition at line 96 of file Window.h.


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