public class Protocol extends Object
Constructor and Description |
---|
Protocol()
Just for testing and debugging
|
Protocol(GeneralSpec generalSpec) |
Protocol(String name,
String irpString,
String documentation) |
Modifier and Type | Method and Description |
---|---|
void |
addRawSignalRepresentation(IrSignal irSignal) |
void |
addSignal(HashMap<String,Long> actualParameters) |
void |
addXmlNode(String gid,
String content) |
void |
assign(String str) |
void |
assign(String[] args,
int skip) |
void |
assign(String name,
long value) |
long |
evaluateName(String name) |
long |
evaluateName(String name,
long dflt) |
BitDirection |
getBitDirection() |
double |
getDutyCycle() |
double |
getFrequency() |
String |
getIrp() |
long |
getParameterDefault(String name,
HashMap<String,Long> actualParameters) |
long |
getParameterMax(String name) |
long |
getParameterMin(String name) |
Set<String> |
getParameterNames()
Returns a set of the names of all parameters present in the protocol.
|
double |
getUnit() |
boolean |
hasAdvancedParameters()
Does this protocol have parameters other than the standard ones (F, D, S, T)?
|
boolean |
hasParameter(String name) |
boolean |
hasParameterDefault(String name)
Checks if the named parameter exists and have a default.
|
boolean |
hasParameterMemory(String name)
Checks if the named parameter has memory.
|
void |
interactiveRender(UserComm userComm,
LinkedHashMap actualVars) |
String |
nameEngineString()
Debugging and testing purposes only
|
String |
notationString(String equals,
String separator)
Creates consisting of parameter values that can be used as part of filenames etc.
|
static HashMap<String,Long> |
parseParams(int D,
int S,
int F,
int T,
String additionalParams)
Returns a parameter tests- irpmaster?HashMap<String, Long> suitable for using as argument to renderIrSignal by evaluating the arguments.
|
static HashMap<String,Long> |
parseParams(String additionalParams)
Returns a parameter HashMap<String, Long> suitable for using as argument to renderIRSignal by evaluating the arguments.
|
static HashMap<String,Long> |
parseParams(String[] args,
int skip)
"Smart" method for decoding parameters.
|
void |
printDOM(OutputStream ostream) |
void |
printDOM(OutputStream ostream,
Document stylesheet) |
PrimaryIrStream |
process(HashMap<String,Long> actualVars,
int passNo,
boolean considerRepeatMin) |
PrimaryIrStream |
process(HashMap<String,Long> actualVars,
int passNo,
boolean considerRepeatMin,
boolean initial) |
PrimaryIrStream |
process(HashMap<String,Long> actualVars,
Pass pass,
boolean considerRepeatMin) |
IrSequence |
render(HashMap<String,Long> actualVars,
int pass,
boolean considerRepeatMins,
boolean initialize) |
IrSequence |
render(HashMap<String,Long> actualVars,
Pass pass,
boolean considerRepeatMins,
boolean initialize) |
IrSignal |
renderIrSignal(HashMap<String,Long> actualVars) |
IrSignal |
renderIrSignal(HashMap<String,Long> actualVars,
boolean considerRepeatMins) |
IrSignal |
renderIrSignal(HashMap<String,Long> actualVars,
int pass) |
IrSignal |
renderIrSignal(HashMap<String,Long> actualVars,
int pass,
boolean considerRepeatMins) |
IrSignal |
renderIrSignal(int device,
int subdevice,
int function) |
IrSignal |
renderIrSignal(long device,
long subdevice,
long function) |
IrSignal |
renderIrSignal(long device,
long subdevice,
long function,
long toggle) |
void |
setupDOM() |
Document |
toDOM() |
String |
toDOT() |
String |
toString() |
long |
tryEvaluateName(String name) |
IrSequence |
tryRender(HashMap<String,Long> ivs,
int pass,
boolean considerRepeatMins) |
IrSequence |
tryRender(HashMap<String,Long> ivs,
int pass,
boolean considerRepeatMins,
boolean initialize) |
public Protocol(GeneralSpec generalSpec)
generalSpec
- public Protocol()
public Protocol(String name, String irpString, String documentation) throws UnassignedException, ParseException
UnassignedException
ParseException
public long evaluateName(String name) throws UnassignedException, DomainViolationException
public long evaluateName(String name, long dflt)
public long tryEvaluateName(String name)
public void assign(String name, long value)
public void assign(String str) throws IncompatibleArgumentException
IncompatibleArgumentException
public void assign(String[] args, int skip) throws IncompatibleArgumentException
IncompatibleArgumentException
public BitDirection getBitDirection()
public double getFrequency()
public double getUnit()
public double getDutyCycle()
public long getParameterMin(String name) throws UnassignedException
UnassignedException
public long getParameterMax(String name) throws UnassignedException
UnassignedException
public boolean hasParameter(String name)
public Set<String> getParameterNames()
public boolean hasParameterMemory(String name) throws UnassignedException
name
- Name of the parameters.UnassignedException
- If there is no parameters with the name given as parameter.public boolean hasAdvancedParameters()
public String getIrp()
public long getParameterDefault(String name, HashMap<String,Long> actualParameters) throws UnassignedException, DomainViolationException
name
- actualParameters
- UnassignedException
DomainViolationException
public boolean hasParameterDefault(String name)
name
- public String nameEngineString()
public String notationString(String equals, String separator)
equals
- String between name and value, often "=",separator
- String between name-value pairs, often ",".public String toDOT()
public void setupDOM()
public void addRawSignalRepresentation(IrSignal irSignal)
public void printDOM(OutputStream ostream)
public void printDOM(OutputStream ostream, Document stylesheet)
public Document toDOM()
public void interactiveRender(UserComm userComm, LinkedHashMap actualVars)
public PrimaryIrStream process(HashMap<String,Long> actualVars, int passNo, boolean considerRepeatMin) throws DomainViolationException, UnassignedException, IncompatibleArgumentException, InvalidRepeatException
public PrimaryIrStream process(HashMap<String,Long> actualVars, Pass pass, boolean considerRepeatMin) throws DomainViolationException, UnassignedException, IncompatibleArgumentException, InvalidRepeatException
public PrimaryIrStream process(HashMap<String,Long> actualVars, int passNo, boolean considerRepeatMin, boolean initial) throws DomainViolationException, UnassignedException, IncompatibleArgumentException, InvalidRepeatException
public IrSequence render(HashMap<String,Long> actualVars, int pass, boolean considerRepeatMins, boolean initialize) throws IncompatibleArgumentException, UnassignedException, DomainViolationException, InvalidRepeatException
public IrSequence render(HashMap<String,Long> actualVars, Pass pass, boolean considerRepeatMins, boolean initialize) throws IncompatibleArgumentException, UnassignedException, DomainViolationException, InvalidRepeatException
public IrSignal renderIrSignal(HashMap<String,Long> actualVars, int pass, boolean considerRepeatMins) throws DomainViolationException, UnassignedException, IncompatibleArgumentException, InvalidRepeatException
public IrSignal renderIrSignal(HashMap<String,Long> actualVars, int pass) throws DomainViolationException, UnassignedException, IncompatibleArgumentException, InvalidRepeatException
public IrSignal renderIrSignal(HashMap<String,Long> actualVars) throws DomainViolationException, UnassignedException, IncompatibleArgumentException, InvalidRepeatException
public IrSignal renderIrSignal(HashMap<String,Long> actualVars, boolean considerRepeatMins) throws DomainViolationException, UnassignedException, IncompatibleArgumentException, InvalidRepeatException
public IrSignal renderIrSignal(long device, long subdevice, long function) throws DomainViolationException, UnassignedException, IncompatibleArgumentException, InvalidRepeatException
public IrSignal renderIrSignal(long device, long subdevice, long function, long toggle) throws DomainViolationException, UnassignedException, IncompatibleArgumentException, InvalidRepeatException
public IrSignal renderIrSignal(int device, int subdevice, int function) throws DomainViolationException, UnassignedException, IncompatibleArgumentException, InvalidRepeatException
public IrSequence tryRender(HashMap<String,Long> ivs, int pass, boolean considerRepeatMins, boolean initialize)
public IrSequence tryRender(HashMap<String,Long> ivs, int pass, boolean considerRepeatMins)
public static HashMap<String,Long> parseParams(String additionalParams)
additionalParams
- String of assignments like a=12 b=34 c=56public static HashMap<String,Long> parseParams(int D, int S, int F, int T, String additionalParams)
D
- device number. Use -1 for not assigned.S
- subdevice number. Use -1 for not assigned.F
- function number (obc, command number). Use -1 for not assigned.T
- toggle. Use -1 for not assigned.additionalParams
- String of assignments like a=12 b=34 c=56public static HashMap<String,Long> parseParams(String[] args, int skip) throws IncompatibleArgumentException
args
- String array of parametersskip
- Number of elements in the args to skipIncompatibleArgumentException
Copyright © 2016. All rights reserved.