AJA NTV2 SDK  18.0.0.2717
NTV2 SDK 18.0.0.2717
Public Member Functions | Public Attributes | List of all members
NTV2_RP188 Class Reference

This struct replaces the old RP188_STRUCT. More...

#include <ntv2publicinterface.h>

Public Member Functions

 NTV2_RP188 (const ULWord inDBB=0xFFFFFFFF, const ULWord inLow=0xFFFFFFFF, const ULWord inHigh=0xFFFFFFFF)
 Constructs an NTV2_RP188 from each of its DBB, low and high ULWord components. More...
 
 NTV2_RP188 (const RP188_STRUCT &inOldRP188)
 Constructs an NTV2_RP188 from the given RP188_STRUCT. More...
 
bool IsValid (void) const
 Answers true if I'm valid, or false if I'm not valid. More...
 
NTV2_RP188 & operator= (const RP188_STRUCT &inRHS)
 Assigns a given RP188_STRUCT to me. More...
 
bool operator!= (const RP188_STRUCT &inRHS) const
 
void Set (const ULWord inDBB=0xFFFFFFFF, const ULWord inLow=0xFFFFFFFF, const ULWord inHigh=0xFFFFFFFF)
 Sets my fields from the given DBB, low and high ULWord components. More...
 
 operator RP188_STRUCT () const
 Converts me into an RP188_STRUCT. More...
 
 operator bool () const
 
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

ULWord fDBB
 
ULWord fLo
 | BG 4 | Secs10 | BG 3 | Secs 1 | BG 2 | Frms10 | BG 1 | Frms 1 | More...
 
ULWord fHi
 | BG 8 | Hrs 10 | BG 7 | Hrs 1 | BG 6 | Mins10 | BG 5 | Mins 1 | More...
 

Detailed Description

This struct replaces the old RP188_STRUCT.

Definition at line 7002 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

◆ NTV2_RP188() [1/2]

NTV2_RP188::NTV2_RP188 ( const ULWord  inDBB = 0xFFFFFFFF,
const ULWord  inLow = 0xFFFFFFFF,
const ULWord  inHigh = 0xFFFFFFFF 
)
inlineexplicit

Constructs an NTV2_RP188 from each of its DBB, low and high ULWord components.

Parameters
[in]inDBBSpecifies the DBB field.
[in]inLowSpecifies the "low" field, which contains seconds and frames.
[in]inHighSpecifies the "high" field, which contains hours and minutes.
Note
If no parameters are specified, a default "invalid" structure is created.

Definition at line 7033 of file ntv2publicinterface.h.

◆ NTV2_RP188() [2/2]

NTV2_RP188::NTV2_RP188 ( const RP188_STRUCT &  inOldRP188)
inlineexplicit

Constructs an NTV2_RP188 from the given RP188_STRUCT.

Parameters
[in]inOldRP188Specifies the RP188_STRUCT to copy.

Definition at line 7039 of file ntv2publicinterface.h.

Member Function Documentation

◆ IsValid()

bool NTV2_RP188::IsValid ( void  ) const
inline

Answers true if I'm valid, or false if I'm not valid.

Definition at line 7044 of file ntv2publicinterface.h.

◆ operator bool()

NTV2_RP188::operator bool ( ) const
inline
Returns
True if I'm valid.

Definition at line 7076 of file ntv2publicinterface.h.

◆ operator RP188_STRUCT()

NTV2_RP188::operator RP188_STRUCT ( ) const
inline

Converts me into an RP188_STRUCT.

Returns
An equivalent RP188_STRUCT.

Definition at line 7071 of file ntv2publicinterface.h.

◆ operator!=()

bool NTV2_RP188::operator!= ( const RP188_STRUCT &  inRHS) const
inline
Parameters
[in]inRHSThe RP188_STRUCT to compare with me.
Returns
True if the right-hand-size argument is not equal to me.

Definition at line 7057 of file ntv2publicinterface.h.

◆ operator=()

NTV2_RP188& NTV2_RP188::operator= ( const RP188_STRUCT &  inRHS)
inline

Assigns a given RP188_STRUCT to me.

Parameters
[in]inRHSThe RP188_STRUCT to assign to me.
Returns
A non-constant reference to myself.

Definition at line 7051 of file ntv2publicinterface.h.

◆ RPCDecode()

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

Definition at line 4228 of file ntv2publicinterface.cpp.

◆ RPCDecodeClient()

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

◆ RPCDecodeServer()

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

◆ RPCEncode()

bool NTV2_RP188::RPCEncode ( NTV2_RPC_BLOB_TYPE &  outBlob)

Definition at line 4220 of file ntv2publicinterface.cpp.

◆ RPCEncodeClient()

bool NTV2_RP188::RPCEncodeClient ( NTV2_RPC_BLOB_TYPE &  inBlob)

◆ RPCEncodeServer()

bool NTV2_RP188::RPCEncodeServer ( NTV2_RPC_BLOB_TYPE &  inBlob)

◆ Set()

void NTV2_RP188::Set ( const ULWord  inDBB = 0xFFFFFFFF,
const ULWord  inLow = 0xFFFFFFFF,
const ULWord  inHigh = 0xFFFFFFFF 
)
inline

Sets my fields from the given DBB, low and high ULWord components.

Parameters
[in]inDBBSpecifies the DBB field.
[in]inLowSpecifies the "low" field, which contains seconds and frames.
[in]inHighSpecifies the "high" field, which contains hours and minutes.

Definition at line 7065 of file ntv2publicinterface.h.

Member Data Documentation

◆ fDBB

ULWord NTV2_RP188::fDBB

Definition at line 7003 of file ntv2publicinterface.h.

◆ fHi

ULWord NTV2_RP188::fHi

| BG 8 | Hrs 10 | BG 7 | Hrs 1 | BG 6 | Mins10 | BG 5 | Mins 1 |

Definition at line 7005 of file ntv2publicinterface.h.

◆ fLo

ULWord NTV2_RP188::fLo

| BG 4 | Secs10 | BG 3 | Secs 1 | BG 2 | Frms10 | BG 1 | Frms 1 |

Definition at line 7004 of file ntv2publicinterface.h.

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