libCEC 8.1.0
C / C++ API — control CEC-capable HDMI devices
Loading...
Searching...
No Matches
cec_logical_addresses Struct Reference

#include <cectypes.h>

Public Member Functions

void Clear (void)
 Clear this list.
 
bool IsEmpty (void) const
 
uint16_t AckMask (void) const
 Calculate the ack-mask for this list, the mask to use when determining whether to send an ack message or not.
 
void Set (cec_logical_address address)
 Mark a logical address as 'set'.
 
void Unset (const cec_logical_address address)
 Mark a logical address as 'unset'.
 
bool IsSet (cec_logical_address address) const
 Check whether an address is set in this list.
 
bool operator[] (uint8_t pos) const
 Check whether an address is set in this list.
 
bool operator== (const cec_logical_addresses &other) const
 
bool operator!= (const cec_logical_addresses &other) const
 

Public Attributes

cec_logical_address primary
 the primary logical address to use
 
int addresses [16]
 the list of addresses
 

Detailed Description

Definition at line 1346 of file cectypes.h.

Member Function Documentation

◆ Clear()

void cec_logical_addresses::Clear ( void  )
inline

Clear this list.

Definition at line 1355 of file cectypes.h.

◆ IsEmpty()

bool cec_logical_addresses::IsEmpty ( void  ) const
inline
Returns
True when empty, false otherwise.

Definition at line 1365 of file cectypes.h.

◆ AckMask()

uint16_t cec_logical_addresses::AckMask ( void  ) const
inline

Calculate the ack-mask for this list, the mask to use when determining whether to send an ack message or not.

Returns
The ack-mask.

Definition at line 1374 of file cectypes.h.

◆ Set()

void cec_logical_addresses::Set ( cec_logical_address  address)
inline

Mark a logical address as 'set'.

Parameters
addressThe logical address to add to this list.

Definition at line 1387 of file cectypes.h.

◆ Unset()

void cec_logical_addresses::Unset ( const cec_logical_address  address)
inline

Mark a logical address as 'unset'.

Parameters
addressThe logical address to remove from this list.

Definition at line 1399 of file cectypes.h.

◆ IsSet()

bool cec_logical_addresses::IsSet ( cec_logical_address  address) const
inline

Check whether an address is set in this list.

Parameters
addressThe address to check.
Returns
True when set, false otherwise.

Definition at line 1412 of file cectypes.h.

◆ operator[]()

bool cec_logical_addresses::operator[] ( uint8_t  pos) const
inline

Check whether an address is set in this list.

Parameters
posThe address to check.
Returns
True when set, false otherwise.

Definition at line 1419 of file cectypes.h.

◆ operator==()

bool cec_logical_addresses::operator== ( const cec_logical_addresses other) const
inline

Definition at line 1421 of file cectypes.h.

◆ operator!=()

bool cec_logical_addresses::operator!= ( const cec_logical_addresses other) const
inline

Definition at line 1429 of file cectypes.h.

Member Data Documentation

◆ primary

cec_logical_address cec_logical_addresses::primary

the primary logical address to use

Definition at line 1348 of file cectypes.h.

◆ addresses

int cec_logical_addresses::addresses[16]

the list of addresses

Definition at line 1349 of file cectypes.h.


The documentation for this struct was generated from the following file: