Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
ola::PortManager Class Reference

Detailed Description

Responsible for performing Port operations.

Public Member Functions

 PortManager (UniverseStore *universe_store, PortBroker *broker)
 Create a new PortManager. More...
 
 ~PortManager ()
 Destructor.
 
bool PatchPort (InputPort *port, unsigned int universe)
 Patch an InputPort to a universe. More...
 
bool PatchPort (OutputPort *port, unsigned int universe)
 Patch an OutputPort to a universe. More...
 
bool UnPatchPort (InputPort *port)
 UnPatch an InputPort. More...
 
bool UnPatchPort (OutputPort *port)
 UnPatch an OutputPort. More...
 
bool SetPriorityInherit (Port *port)
 Set a port to 'inherit' priority mode. More...
 
bool SetPriorityStatic (Port *port, uint8_t value)
 Set a port to 'override' priority mode. More...
 

Constructor & Destructor Documentation

ola::PortManager::PortManager ( UniverseStore universe_store,
PortBroker broker 
)
inline

Create a new PortManager.

Parameters
universe_storethe UniverseStore used to lookup / create Universes.
brokerthe PortBroker to update when Ports are added / removed.

Member Function Documentation

bool ola::PortManager::PatchPort ( InputPort port,
unsigned int  universe 
)

Patch an InputPort to a universe.

Parameters
portthe port to patch
universethe universe-id to patch to.
Returns
true is successful, false otherwise
bool ola::PortManager::PatchPort ( OutputPort port,
unsigned int  universe 
)

Patch an OutputPort to a universe.

Parameters
portthe port to patch
universethe universe-id to patch to.
Returns
true is successful, false otherwise
bool ola::PortManager::SetPriorityInherit ( Port port)

Set a port to 'inherit' priority mode.

Parameters
portthe port to configure
bool ola::PortManager::SetPriorityStatic ( Port port,
uint8_t  value 
)

Set a port to 'override' priority mode.

Parameters
portthe port to configure
valuethe new priority
bool ola::PortManager::UnPatchPort ( InputPort port)

UnPatch an InputPort.

Parameters
portthe port to unpatch
Returns
true is successful, false otherwise
bool ola::PortManager::UnPatchPort ( OutputPort port)

UnPatch an OutputPort.

Parameters
portthe port to unpatch
Returns
true is successful, false otherwise

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