NTV2StreamChannel Class Reference

#include <ntv2publicinterface.h>

Collaboration diagram for NTV2StreamChannel:

Public Member Functions
	operator NTV2_HEADER * ()
ULWord	GetQueueDepth (void)
	Gets the queue depth. More...
bool	IsIdle (void)
	Is the stream idle. More...
bool	IsActive (void)
	Is the stream active. More...
bool	HasError (void)
	Has the stream encountered an error. More...
std::ostream &	Print (std::ostream &inOutStream) const
Construction & Destruction
	NTV2StreamChannel ()
	Constructs a default NTV2StreamChannel struct. More...

Public Attributes
NTV2_HEADER	mHeader
	The common structure header – ALWAYS FIRST! More...
NTV2Channel	mChannel
	Stream channel. More...
ULWord	mFlags
	Action flags. More...
ULWord	mStatus
	Action status. More...
ULWord	mStreamState
	Stream state. More...
ULWord64	mBufferCookie
	Active buffer user cookie. More...
LWord64	mStartTime
	Stream start time. More...
LWord64	mStopTime
	Stream stop time. More...
ULWord64	mQueueCount
	Number of buffers queued. More...
ULWord64	mReleaseCount
	Number of buffers released. More...
ULWord64	mActiveCount
	Number of active transfers. More...
ULWord64	mRepeatCount
	Number of repeated transfers. More...
ULWord64	mIdleCount
	Number of idle transfers. More...
ULWord	mReserved [32]
	Reserved for future expansion. More...
NTV2_TRAILER	mTrailer
	The common structure trailer – ALWAYS LAST! More...

Detailed Description

Definition at line 8908 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

NTV2StreamChannel()

NTV2StreamChannel::NTV2StreamChannel ( )

explicit

Constructs a default NTV2StreamChannel struct.

Definition at line 3098 of file ntv2publicinterface.cpp.

Member Function Documentation

GetQueueDepth()

ULWord NTV2StreamChannel::GetQueueDepth ( void  )

inline

Gets the queue depth.

Returns

The depth of the queue.

Definition at line 8940 of file ntv2publicinterface.h.

HasError()

bool NTV2StreamChannel::HasError ( void  )

inline

Has the stream encountered an error.

Returns

True if error.

Definition at line 8958 of file ntv2publicinterface.h.

IsActive()

bool NTV2StreamChannel::IsActive ( void  )

inline

Is the stream active.

Returns

True if active.

Definition at line 8952 of file ntv2publicinterface.h.

IsIdle()

bool NTV2StreamChannel::IsIdle ( void  )

inline

Is the stream idle.

Returns

True if idle.

Definition at line 8946 of file ntv2publicinterface.h.

operator NTV2_HEADER *()

NTV2StreamChannel::operator NTV2_HEADER * ( )

inline

Definition at line 8934 of file ntv2publicinterface.h.

Print()

ostream & NTV2StreamChannel::Print

(

std::ostream &

inOutStream

)

const

Definition at line 3104 of file ntv2publicinterface.cpp.

Member Data Documentation

mActiveCount

ULWord64 NTV2StreamChannel::mActiveCount

Number of active transfers.

Definition at line 8919 of file ntv2publicinterface.h.

mBufferCookie

ULWord64 NTV2StreamChannel::mBufferCookie

Active buffer user cookie.

Definition at line 8914 of file ntv2publicinterface.h.

mChannel

NTV2Channel NTV2StreamChannel::mChannel

Stream channel.

Definition at line 8910 of file ntv2publicinterface.h.

mFlags

ULWord NTV2StreamChannel::mFlags

Action flags.

Definition at line 8911 of file ntv2publicinterface.h.

mHeader

NTV2_HEADER NTV2StreamChannel::mHeader

The common structure header – ALWAYS FIRST!

Definition at line 8909 of file ntv2publicinterface.h.

mIdleCount

ULWord64 NTV2StreamChannel::mIdleCount

Number of idle transfers.

Definition at line 8921 of file ntv2publicinterface.h.

mQueueCount

ULWord64 NTV2StreamChannel::mQueueCount

Number of buffers queued.

Definition at line 8917 of file ntv2publicinterface.h.

mReleaseCount

ULWord64 NTV2StreamChannel::mReleaseCount

Number of buffers released.

Definition at line 8918 of file ntv2publicinterface.h.

mRepeatCount

ULWord64 NTV2StreamChannel::mRepeatCount

Number of repeated transfers.

Definition at line 8920 of file ntv2publicinterface.h.

mReserved

ULWord NTV2StreamChannel::mReserved[32]

Reserved for future expansion.

Definition at line 8922 of file ntv2publicinterface.h.

mStartTime

LWord64 NTV2StreamChannel::mStartTime

Stream start time.

Definition at line 8915 of file ntv2publicinterface.h.

mStatus

ULWord NTV2StreamChannel::mStatus

Action status.

Definition at line 8912 of file ntv2publicinterface.h.

mStopTime

LWord64 NTV2StreamChannel::mStopTime

Stream stop time.

Definition at line 8916 of file ntv2publicinterface.h.

mStreamState

ULWord NTV2StreamChannel::mStreamState

Stream state.

Definition at line 8913 of file ntv2publicinterface.h.

mTrailer

NTV2_TRAILER NTV2StreamChannel::mTrailer

The common structure trailer – ALWAYS LAST!

Definition at line 8923 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