NTV2MessageData Class Reference

#include <ntv2publicinterface.h>

Collaboration diagram for NTV2MessageData:

Public Member Functions
	NTV2MessageData (const void *inMessage, const size_t inMessageSize, const ULWord inFlags)
	Constructs an NTV2VirtualData struct for reading or writing virtual data. More...
ULWord	GetStatus (void)
std::ostream &	Print (std::ostream &inOutStream) const
	Prints a human-readable representation of me to the given output stream. More...
	operator NTV2_HEADER * ()
bool	RPCEncode (NTV2_RPC_BLOB_TYPE &outBlob)
bool	RPCDecode (const NTV2_RPC_BLOB_TYPE &inBlob, size_t &inOutIndex)
bool	RPCDecodeClient (const NTV2_RPC_BLOB_TYPE &inBlob, size_t &inOutIndex)
bool	RPCEncodeClient (NTV2_RPC_BLOB_TYPE &inBlob)
bool	RPCDecodeServer (const NTV2_RPC_BLOB_TYPE &inBlob, size_t &inOutIndex)
bool	RPCEncodeServer (NTV2_RPC_BLOB_TYPE &inBlob)

Public Attributes
NTV2_HEADER	mHeader
	The common structure header – ALWAYS FIRST! More...
NTV2Buffer	mMessage
	Pointer object data to target. More...
ULWord	mFlags
	Message flags. More...
ULWord	mStatus
	Message return status. More...
NTV2_TRAILER	mTrailer
	The common structure trailer – ALWAYS LAST! More...

Detailed Description

Definition at line 8011 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

NTV2MessageData()

NTV2MessageData::NTV2MessageData ( const void *  inMessage, const size_t  inMessageSize, const ULWord  inFlags  )

explicit

Constructs an NTV2VirtualData struct for reading or writing virtual data.

Parameters

[in]	inMessage	Message data
[in]	inMessageSize	Message data size
[in]	inFlags	Message flags

Definition at line 3841 of file ntv2publicinterface.cpp.

Member Function Documentation

GetStatus()

ULWord NTV2MessageData::GetStatus ( void  )

inline

Returns

The message status

Definition at line 8030 of file ntv2publicinterface.h.

operator NTV2_HEADER *()

NTV2MessageData::operator NTV2_HEADER * ( )

inline

Returns

My address casted to an NTV2_HEADER pointer.

Definition at line 8042 of file ntv2publicinterface.h.

Print()

ostream & NTV2MessageData::Print

(

std::ostream &

inOutStream

)

const

Prints a human-readable representation of me to the given output stream.

Parameters

inOutStream

Specifies the output stream to use.

Returns

A reference to the output stream.

Definition at line 3851 of file ntv2publicinterface.cpp.

RPCDecode()

bool NTV2MessageData::RPCDecode	(	const NTV2_RPC_BLOB_TYPE &	inBlob,
		size_t &	inOutIndex
	)

RPCDecodeClient()

bool NTV2MessageData::RPCDecodeClient	(	const NTV2_RPC_BLOB_TYPE &	inBlob,
		size_t &	inOutIndex
	)

RPCDecodeServer()

bool NTV2MessageData::RPCDecodeServer	(	const NTV2_RPC_BLOB_TYPE &	inBlob,
		size_t &	inOutIndex
	)

RPCEncode()

bool NTV2MessageData::RPCEncode

(

NTV2_RPC_BLOB_TYPE &

outBlob

)

RPCEncodeClient()

bool NTV2MessageData::RPCEncodeClient

(

NTV2_RPC_BLOB_TYPE &

inBlob

)

RPCEncodeServer()

bool NTV2MessageData::RPCEncodeServer

(

NTV2_RPC_BLOB_TYPE &

inBlob

)

Member Data Documentation

mFlags

ULWord NTV2MessageData::mFlags

Message flags.

Definition at line 8014 of file ntv2publicinterface.h.

mHeader

NTV2_HEADER NTV2MessageData::mHeader

The common structure header – ALWAYS FIRST!

Definition at line 8012 of file ntv2publicinterface.h.

mMessage

NTV2Buffer NTV2MessageData::mMessage

Pointer object data to target.

Definition at line 8013 of file ntv2publicinterface.h.

mStatus

ULWord NTV2MessageData::mStatus

Message return status.

Definition at line 8015 of file ntv2publicinterface.h.

mTrailer

NTV2_TRAILER NTV2MessageData::mTrailer

The common structure trailer – ALWAYS LAST!

Definition at line 8016 of file ntv2publicinterface.h.

---

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

• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/includes/ntv2publicinterface.h
• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2publicinterface.cpp