AJA NTV2 SDK  17.1.3.1410
NTV2 SDK 17.1.3.1410
Static Public Member Functions | List of all members
AJAAncillaryDataFactory Class Reference

Use my AJAAncillaryDataFactory::GuessAncillaryDataType method to determine what kind of ancillary data is being held by a (generic) AJAAncillaryData object. Use my AJAAncillaryDataFactory::Create method to instantiate a new AJAAncillaryData object specific to a given type. More...

#include <ancillarydatafactory.h>

Static Public Member Functions

static AJAAncillaryData * Create (const AJAAncDataType inAncType, const AJAAncillaryData &inAncData)
 Creates a new particular subtype of AJAAncillaryData object. More...
 
static AJAAncillaryData * Create (const AJAAncDataType inAncType, const AJAAncillaryData *pInAncData=NULL)
 Creates a new AJAAncillaryData object having a particular subtype. More...
 
static AJAAncDataType GuessAncillaryDataType (const AJAAncillaryData &inAncData)
 Given a generic AJAAncillaryData object, attempts to guess what kind of specific AJAAncillaryData object it might be from its raw packet data. More...
 
static AJAAncDataType GuessAncillaryDataType (const AJAAncillaryData *pInAncData)
 Given a generic AJAAncillaryData object, attempts to guess what kind of specific AJAAncillaryData object from its raw packet data. More...
 

Detailed Description

Use my AJAAncillaryDataFactory::GuessAncillaryDataType method to determine what kind of ancillary data is being held by a (generic) AJAAncillaryData object. Use my AJAAncillaryDataFactory::Create method to instantiate a new AJAAncillaryData object specific to a given type.

Definition at line 20 of file ancillarydatafactory.h.

Member Function Documentation

◆ Create() [1/2]

AJAAncillaryData * AJAAncillaryDataFactory::Create ( const AJAAncDataType  inAncType,
const AJAAncillaryData &  inAncData 
)
static

Creates a new particular subtype of AJAAncillaryData object.

Parameters
[in]inAncTypeSpecifies the subtype of AJAAncillaryData object (subclass) to instantiate.
[in]inAncDataSupplies an existing AJAAncillaryData object to clone from.
Returns
A pointer to the new instance; or NULL upon failure.

Definition at line 23 of file ancillarydatafactory.cpp.

◆ Create() [2/2]

AJAAncillaryData * AJAAncillaryDataFactory::Create ( const AJAAncDataType  inAncType,
const AJAAncillaryData *  pInAncData = NULL 
)
static

Creates a new AJAAncillaryData object having a particular subtype.

Parameters
[in]inAncTypeType of AJAAncillaryData object (subclass) to instantiate.
[in]pInAncDataOptionally supplies an existing AJAAncillaryData object to clone from.
Returns
A pointer to the new instance; or NULL upon failure.

Definition at line 29 of file ancillarydatafactory.cpp.

◆ GuessAncillaryDataType() [1/2]

AJAAncDataType AJAAncillaryDataFactory::GuessAncillaryDataType ( const AJAAncillaryData &  inAncData)
static

Given a generic AJAAncillaryData object, attempts to guess what kind of specific AJAAncillaryData object it might be from its raw packet data.

Parameters
[in]inAncDataAn AJAAncillaryData object that contains "raw" packet data.
Returns
The guessed AJAAncDataType (or AJAAncDataType_Unknown if no idea...).

Definition at line 65 of file ancillarydatafactory.cpp.

◆ GuessAncillaryDataType() [2/2]

AJAAncDataType AJAAncillaryDataFactory::GuessAncillaryDataType ( const AJAAncillaryData *  pInAncData)
static

Given a generic AJAAncillaryData object, attempts to guess what kind of specific AJAAncillaryData object from its raw packet data.

Parameters
[in]pInAncDataA valid, non-NULL pointer to an AJAAncillaryData object that contains "raw" packet data.
Returns
The guessed AJAAncDataType (or AJAAncDataType_Unknown if no idea...).

Definition at line 77 of file ancillarydatafactory.cpp.

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