AGX Dynamics 2.42.3.1
Loading...
Searching...
No Matches
agxNet::CoSimulationServer Class Reference

Class for sending serialized agxSDK::Simulation over to a client. More...

#include <CoSimulationServer.h>

+ Inheritance diagram for agxNet::CoSimulationServer:

Public Types

enum  ScriptMode { NO_SCRIPT =0 , PYTHON_SCRIPT =1 }
 
- Public Types inherited from agx::BasicThread
enum  ThreadState {
  THREAD_NEW = 0 , THREAD_RUNNING = 1 , THREAD_DETACHED = 2 , THREAD_DONE = 3 ,
  THREAD_JOINED = 4 , THREAD_CANCELLED = 5
}
 States for the thread. More...
 

Public Member Functions

 CoSimulationServer (uint16_t port)
 Constructor.
 
bool applyInitInputs (agxSDK::Simulation *simulation)
 
bool getEnableCompression () const
 
const agx::String & getFilename ()
 
ScriptMode getScriptMode () const
 
bool isShutdown ()
 
bool obtainInitOutputs (agxSDK::Simulation *simulation)
 
Header::Mode receiveInstructions (agxSDK::Simulation *simulation)
 
void run ()
 This method is invoked by start.
 
void setEnableCompression (bool flag)
 Enable/disable compression of transmitted data.
 
void setInstructionStatus (Header::Mode mode, const agx::String &message)
 
void setScriptMode (ScriptMode)
 
void shutdown ()
 Shutdown the communication threads, will cause this client to be non-usable any more.
 
- Public Member Functions inherited from agxNet::CoSimulationBase
 CoSimulationBase ()
 Default constructor.
 
virtual void dropConnection (bool shouldShutdown=false)
 Drop the connection to the remote host and wait for a new one.
 
virtual bool isConnected ()
 
virtual bool waitForConnection ()=0
 
- Public Member Functions inherited from agx::BasicThread
 BasicThread ()
 Default constructor.
 
 BasicThread (const BasicThread &other)=delete
 
virtual ~BasicThread ()=default
 Destructor.
 
void cancel ()
 Threads should normally not need to be killed.
 
void detach ()
 Detaches the thread to the background.
 
unsigned int getThreadState ()
 Returns the current thread state.
 
bool join ()
 Joins the thread.
 
bool joinable ()
 True if thread is joinable.
 
BasicThread & operator= (const BasicThread &rhs)=delete
 
virtual void run ()
 This method is invoked by start.
 
bool setThreadAffinity (agx::UInt64 cpumask)
 Thread Affinity can be used to influence on which logical cores threads are scheduled and allowed to run.
 
bool start ()
 Launches the thread.
 
- 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.
 

Protected Member Functions

virtual ~CoSimulationServer ()
 
void dropConnection (bool shouldShutdown) override
 Drop the connection to the remote host and wait for a new one.
 
virtual bool waitForConnection ()
 
virtual void waitForDataAndTransfer ()
 
- Protected Member Functions inherited from agxNet::CoSimulationBase
virtual ~CoSimulationBase ()
 
virtual void handleConnectionDrop ()
 
size_t receiveData (uint8_t *data, size_t numBytes)
 Receive data from remote party.
 
void receivePacket (Header &header)
 
size_t sendData (const uint8_t *data, size_t numBytes)
 Transmit data to remote party.
 
void sendPacket (Header &header)
 
- Protected Member Functions inherited from agx::Referenced
virtual ~Referenced ()
 Destructor.
 
void allocateObserverVector () const
 
void deleteUsingDeleteHandler () const
 

Additional Inherited Members

- Static Public Member Functions inherited from agx::BasicThread
static std::thread::native_handle_type getCurrentThreadHandle ()
 Return a native_handle for the current executing thread.
 
- Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool ValidateCast (const Referenced *object)
 
- 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 agxNet::CoSimulationBase
agx::Vector< char > m_buffer
 
agx::Mutex m_connectionMutex
 
bool m_isShutdown
 
TCPSocketRef m_socket
 
- Protected Attributes inherited from agx::BasicThread
std::thread m_handle
 
std::atomic< unsigned int > m_state
 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

Detailed Description

Class for sending serialized agxSDK::Simulation over to a client.

Definition at line 33 of file CoSimulationServer.h.

Member Enumeration Documentation

◆ ScriptMode

Enumerator
NO_SCRIPT 
PYTHON_SCRIPT 

Definition at line 43 of file CoSimulationServer.h.

Constructor & Destructor Documentation

◆ CoSimulationServer()

agxNet::CoSimulationServer::CoSimulationServer ( uint16_t  port)

Constructor.

Parameters
port- The port where the server will listen for connections.

◆ ~CoSimulationServer()

virtual agxNet::CoSimulationServer::~CoSimulationServer ( )
protectedvirtual

Member Function Documentation

◆ applyInitInputs()

bool agxNet::CoSimulationServer::applyInitInputs ( agxSDK::Simulation *  simulation)

◆ dropConnection()

void agxNet::CoSimulationServer::dropConnection ( bool  shouldShutdown)
overrideprotectedvirtual

Drop the connection to the remote host and wait for a new one.

Parameters
shouldShutdown- Can be used by derived classes to shutdown the communication.

Reimplemented from agxNet::CoSimulationBase.

◆ getEnableCompression()

bool agxNet::CoSimulationServer::getEnableCompression ( ) const
inline
Returns
true if compression is enabled

Definition at line 67 of file CoSimulationServer.h.

◆ getFilename()

const agx::String & agxNet::CoSimulationServer::getFilename ( )

◆ getScriptMode()

ScriptMode agxNet::CoSimulationServer::getScriptMode ( ) const

◆ isShutdown()

bool agxNet::CoSimulationServer::isShutdown ( )

◆ obtainInitOutputs()

bool agxNet::CoSimulationServer::obtainInitOutputs ( agxSDK::Simulation *  simulation)

◆ receiveInstructions()

Header::Mode agxNet::CoSimulationServer::receiveInstructions ( agxSDK::Simulation *  simulation)

◆ run()

void agxNet::CoSimulationServer::run ( )
virtual

This method is invoked by start.

Override in child classes to perform the work.

Reimplemented from agx::BasicThread.

◆ setEnableCompression()

void agxNet::CoSimulationServer::setEnableCompression ( bool  flag)
inline

Enable/disable compression of transmitted data.

Parameters
flag- if true, data will be compressed

Definition at line 62 of file CoSimulationServer.h.

◆ setInstructionStatus()

void agxNet::CoSimulationServer::setInstructionStatus ( Header::Mode  mode,
const agx::String &  message 
)

◆ setScriptMode()

void agxNet::CoSimulationServer::setScriptMode ( ScriptMode  )

◆ shutdown()

void agxNet::CoSimulationServer::shutdown ( )

Shutdown the communication threads, will cause this client to be non-usable any more.

◆ waitForConnection()

virtual bool agxNet::CoSimulationServer::waitForConnection ( )
protectedvirtual

◆ waitForDataAndTransfer()

virtual void agxNet::CoSimulationServer::waitForDataAndTransfer ( )
protectedvirtual

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