GeoGen API Reference
Public Member Functions | List of all members
geogen::runtime::BooleanScriptParameter Class Reference

Script parameter of type Boolean. More...

Inherits geogen::runtime::ScriptParameter.

Public Member Functions

 BooleanScriptParameter (String const &name, String const &label, String const &description, bool defaultValue)
 Initializes a new instance of BooleanScriptParameter class. More...
 
 BooleanScriptParameter (BooleanScriptParameter const &)
 Copy constructor. More...
 
BooleanScriptParameteroperator= (BooleanScriptParameter const &)
 Assignment operator. More...
 
virtual ScriptParameterType GetType () const
 Gets the script parameter type. More...
 
bool GetDefaultValue () const
 Gets default value. More...
 
bool GetValue () const
 Gets current value. More...
 
void SetValue (bool value)
 Sets current value. More...
 
virtual void ResetToDefault ()
 Resets to default.
 
virtual bool EqualsTo (ScriptParameter const *other) const
 Compares this script parameter to another script parameter. More...
 
virtual ScriptParameterClone () const
 Makes a deep copy of this script parameter. More...
 
virtual void Serialize (IOStream &stream) const
 Writes the human readable string representation of this instance to the given stream. More...
 
- Public Member Functions inherited from geogen::runtime::ScriptParameter
virtual ~ScriptParameter ()
 Virtual destructor.
 
 ScriptParameter (String const &name, String const &label, String const &description)
 Constructor. More...
 
String GetName () const
 Gets the name. More...
 
String GetLabel () const
 Gets the label. More...
 
String GetDescription () const
 Gets the description. More...
 
- Public Member Functions inherited from geogen::Serializable
virtual void SerializeWithTabs (IOStream &stream, unsigned tabs) const
 Serialize with tabs. More...
 
String ToString () const
 Convert this instance into a human readable string representation. More...
 

Additional Inherited Members

- Protected Attributes inherited from geogen::runtime::ScriptParameter
String name
 
String label
 
String description
 

Detailed Description

Script parameter of type Boolean.

Examples:
AdvancedScriptParameters.cpp.

Constructor & Destructor Documentation

geogen::runtime::BooleanScriptParameter::BooleanScriptParameter ( String const &  name,
String const &  label,
String const &  description,
bool  defaultValue 
)
inline

Initializes a new instance of BooleanScriptParameter class.

Parameters
nameThe name.
labelThe label.
descriptionThe description.
defaultValueThe default value.
BooleanScriptParameter::BooleanScriptParameter ( BooleanScriptParameter const &  other)

Copy constructor.

Parameters
otherThe other.

Member Function Documentation

ScriptParameter * BooleanScriptParameter::Clone ( ) const
virtual

Makes a deep copy of this script parameter.

Returns
The copy.

Implements geogen::runtime::ScriptParameter.

bool BooleanScriptParameter::EqualsTo ( ScriptParameter const *  other) const
virtual

Compares this script parameter to another script parameter.

Parameters
otherThe other.
Returns
true if the two parameters are equal.

Implements geogen::runtime::ScriptParameter.

bool geogen::runtime::BooleanScriptParameter::GetDefaultValue ( ) const
inline

Gets default value.

Returns
The default value.
virtual ScriptParameterType geogen::runtime::BooleanScriptParameter::GetType ( ) const
inlinevirtual

Gets the script parameter type.

Returns
The type.

Implements geogen::runtime::ScriptParameter.

bool geogen::runtime::BooleanScriptParameter::GetValue ( ) const
inline

Gets current value.

Returns
The current value.
BooleanScriptParameter & BooleanScriptParameter::operator= ( BooleanScriptParameter const &  other)

Assignment operator.

Parameters
otherThe other.
Returns
This instance.
void BooleanScriptParameter::Serialize ( IOStream stream) const
virtual

Writes the human readable string representation of this instance to the given stream.

Parameters
streamThe stream.

Implements geogen::runtime::ScriptParameter.

void geogen::runtime::BooleanScriptParameter::SetValue ( bool  value)
inline

Sets current value.

Parameters
valueThe new current value.
Examples:
AdvancedScriptParameters.cpp.