gensrc.parameters.parameter.Value Class Reference
Inheritance diagram for gensrc.parameters.parameter.Value:
Collaboration diagram for gensrc.parameters.parameter.Value:
Public Member Functions | |
| def | tensorRank (self) |
| public interface More... | |
| def | loop (self) |
| def | vectorIterator (self) |
| def | default (self) |
| def | ignore (self) |
| def | const (self) |
| def | fullType (self) |
| def | nameConverted (self) |
| def | description (self) |
| def | lastParameter (self) |
| def | errorValue (self) |
| def | setLastParameter (self, val) |
| def | setLoop (self, val) |
| def | setDefault (self, val) |
| def | printValue (self, value) |
| def | printDebug (self) |
Public Attributes | |
| lastParameter_ | |
| loop_ | |
| default_ | |
Static Public Attributes | |
| bool | const_ = True |
| class variables | |
| string | description_ = '' |
| string | loop_ = '' |
| string | vectorIterator_ = '' |
| bool | lastParameter_ = False |
| bool | ignore_ = False |
| string | default_ = '' |
| string | errorValue_ = '' |
Detailed Description
Represent any value which may be passed to or received from a Function.
Member Function Documentation
◆ const()
| def gensrc.parameters.parameter.Value.const | ( | self | ) |
Return a boolean indicating whether this parameter is passed as a const value.
◆ default()
| def gensrc.parameters.parameter.Value.default | ( | self | ) |
Return the default value that was specified for this parameter in the event that no value is available - or None.
◆ description()
| def gensrc.parameters.parameter.Value.description | ( | self | ) |
Return the explanatory description that was provided for this parameter for end user documentation.
◆ errorValue()
| def gensrc.parameters.parameter.Value.errorValue | ( | self | ) |
Return the value, if any, to be substituted for this parameter if the original value is erroneous.
◆ fullType()
| def gensrc.parameters.parameter.Value.fullType | ( | self | ) |
Return the FullType object that corresponds to this value.
◆ ignore()
| def gensrc.parameters.parameter.Value.ignore | ( | self | ) |
Return a boolean indicating whether this parameter is ignored by the underlying library function.
◆ lastParameter()
| def gensrc.parameters.parameter.Value.lastParameter | ( | self | ) |
Return a boolean indicating whether this parameter is the last in the list for the given function.
◆ loop()
| def gensrc.parameters.parameter.Value.loop | ( | self | ) |
Return boolean indicating whether this value is a loop parameter.
◆ nameConverted()
| def gensrc.parameters.parameter.Value.nameConverted | ( | self | ) |
Return the variable name to be used for this parameter after datatype conversion has been performed.
◆ printDebug()
| def gensrc.parameters.parameter.Value.printDebug | ( | self | ) |
For debugging purposes, write the properties of this parameter to stdout.
◆ printValue()
| def gensrc.parameters.parameter.Value.printValue | ( | self, | |
| value | |||
| ) |
For debugging purposes, write the given value to stdout.
◆ setDefault()
| def gensrc.parameters.parameter.Value.setDefault | ( | self, | |
| val | |||
| ) |
Set the default value to be used in place of this parameter in the event that no value is available.
◆ setLastParameter()
| def gensrc.parameters.parameter.Value.setLastParameter | ( | self, | |
| val | |||
| ) |
Set the boolean value indicating whether this parameter is the last in the list for the given function.
◆ setLoop()
| def gensrc.parameters.parameter.Value.setLoop | ( | self, | |
| val | |||
| ) |
Set the boolean value indicating whether this parameter is configured as the loop parameter for the function.
◆ tensorRank()
| def gensrc.parameters.parameter.Value.tensorRank | ( | self | ) |
public interface
Return the tensor rank of this value i.e. scalar/vector/matrix.
◆ vectorIterator()
| def gensrc.parameters.parameter.Value.vectorIterator | ( | self | ) |
Return a value specifying the iterator behavior for this vector parameter - begin, end, or beginAndEnd. begin indicates that the underlying function requires an iterator pointing to the beginning of the std::vector. end indicates that the underlying function requires an iterator pointing to the beginning of the std::vector. beginAndEnd indicates that the underlying function requires both values.
The documentation for this class was generated from the following file:
- parameter.py