DISPLACE  1.0
A spatial model of fisheries to help sustainable fishing and maritime spatial planning
Public Member Functions | List of all members
MoveShipOutputMessage Class Reference

#include <moveshipoutputmessage.h>

Inheritance diagram for MoveShipOutputMessage:
OutputMessage OutputMessage

Public Member Functions

 MoveShipOutputMessage (int _tstep, Ship *ship)
 
 ~MoveShipOutputMessage ()
 
virtual IpcMessageTypes getType () const
 
bool process ()
 perform an operation non related to the gui feedback channel More...
 
bool send (std::ostream &strm)
 the operation to perform. More...
 
size_t sendBinary (void *buffer, size_t maxlen)
 formats a binary block of data to be sent across the IPC stream More...
 
 MoveShipOutputMessage (int, void *)
 
- Public Member Functions inherited from OutputMessage
virtual ~OutputMessage ()
 
 OutputMessage ()
 
virtual ~OutputMessage ()
 
template<typename T >
size_t put (void *buffer, size_t index, T v)
 

Constructor & Destructor Documentation

◆ MoveShipOutputMessage() [1/2]

MoveShipOutputMessage::MoveShipOutputMessage ( int  _tstep,
Ship *  ship 
)

◆ ~MoveShipOutputMessage()

MoveShipOutputMessage::~MoveShipOutputMessage ( )
inline

◆ MoveShipOutputMessage() [2/2]

MoveShipOutputMessage::MoveShipOutputMessage ( int  ,
void *   
)
inline

Member Function Documentation

◆ getType()

virtual IpcMessageTypes MoveShipOutputMessage::getType ( ) const
inlinevirtual

Implements OutputMessage.

◆ process()

bool MoveShipOutputMessage::process ( )
virtual

perform an operation non related to the gui feedback channel

Returns
false if the calling function should exit. True otherwise.

Implements OutputMessage.

◆ send()

bool MoveShipOutputMessage::send ( std::ostream &  )
virtual

the operation to perform.

Returns
false if error.

Implements OutputMessage.

◆ sendBinary()

size_t MoveShipOutputMessage::sendBinary ( void *  buffer,
size_t  maxlen 
)
virtual

formats a binary block of data to be sent across the IPC stream

  • buffer address of the data buffer
  • maxlen the maximum size of the block
    Returns
    lenght of the block, or -1 if the process should exit (due to error, or other)

Implements OutputMessage.

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