WSF
Public Member Functions | List of all members
WsfVariable< WsfStringId > Class Reference

#include <WsfVariable.hpp>

Inheritance diagram for WsfVariable< WsfStringId >:
Inheritance graph
[legend]
Collaboration diagram for WsfVariable< WsfStringId >:
Collaboration graph
[legend]

Public Member Functions

 WsfVariable ()=default
 WsfVariable (const std::string &aInitialValue)
 WsfVariable (WsfStringId aInitialValue)
WsfStringId operator= (const std::string &aValue)
WsfStringId operator= (WsfStringId aValue)
 operator WsfStringId () const
 operator const std::string & () const
WsfStringId GetId () const
const std::string & GetString () const
WsfStringId GetConstReference () const
bool Initialize (const std::string &aName, WsfComponent *aObjectPtr, WsfScriptContext *aContextPtr, WsfScriptContext &aGlobalContext)
void ReadValue (UtInput &aInput)
 Read a value from an input stream.
 operator WsfStringId () const
WsfStringId GetValue () const
WsfStringId operator+ (const WsfStringId &aRhs) const
WsfStringId operator- (const WsfStringId &aRhs) const
WsfStringId & operator+= (const WsfStringId &aRhs)
WsfStringId & operator-= (const WsfStringId &aRhs)
void ReadValueOfType (UtInput &aInput, UtInput::ValueType aType)
 Read a unitary value from an input stream.
void ValueInClosedRange (UtInput &aInput, WsfStringId aMinValue, WsfStringId aMaxValue)
void ValueGreater (UtInput &aInput, WsfStringId aMinValue)
void ValueGreaterOrEqual (UtInput &aInput, WsfStringId aMinValue)
void ValueLess (UtInput &aInput, WsfStringId aMaxValue)
void ValueLessOrEqual (UtInput &aInput, WsfStringId aMaxValue)
Public Member Functions inherited from WsfVariableBase
 WsfVariableBase ()
bool HasDefaultValue () const
 Has a default value been defined for a reference.
bool IsReference () const
 Is the variable a reference to a script variable?

Additional Inherited Members

Protected Member Functions inherited from WsfVariableBase
bool DefaultOptionPresent (UtInput &aInput)
 Determine if the '/default' option is present.
std::string ObjectName (WsfComponent *aObjectPtr)
 Return the name of the object for messages.
bool ReadReference (UtInput &aInput)
bool ResolveReference (const std::string &aVariableName, WsfComponent *aObjectPtr, WsfScriptContext *aContextPtr, const UtScriptData *&aRefValuePtr, WsfScriptContext &aGlobalContext)
bool Initialize (const std::string &aName, WsfComponent *aObjectPtr, WsfScriptContext *aContextPtr, WsfStringId &aValue, WsfScriptContext &aGlobalContext)
void ReadValue (UtInput &aInput, WsfStringId &aValue)
bool Initialize (const std::string &aName, WsfComponent *aObjectPtr, WsfScriptContext *aContextPtr, double &aValue, WsfScriptContext &aGlobalContext)
void ReadValue (UtInput &aInput, double &aValue)
void ReadValueOfType (UtInput &aInput, UtInput::ValueType aType, double &aValue)
bool Initialize (const std::string &aName, WsfComponent *aObjectPtr, WsfScriptContext *aContextPtr, float &aValue, WsfScriptContext &aGlobalContext)
void ReadValue (UtInput &aInput, float &aValue)
void ReadValueOfType (UtInput &aInput, UtInput::ValueType aType, float &aValue)
bool Initialize (const std::string &aName, WsfComponent *aObjectPtr, WsfScriptContext *aContextPtr, int &aValue, WsfScriptContext &aGlobalContext)
void ReadValue (UtInput &aInput, int &aValue)
void ReadValueOfType (UtInput &aInput, UtInput::ValueType aType, int &aValue)
bool Initialize (const std::string &aName, WsfComponent *aObjectPtr, WsfScriptContext *aContextPtr, bool &aValue, WsfScriptContext &aGlobalContext)
void ReadValue (UtInput &aInput, bool &aValue)
bool Initialize (const std::string &aName, WsfComponent *aObjectPtr, WsfScriptContext *aContextPtr, std::string &aValue, WsfScriptContext &aGlobalContext)
void ReadValue (UtInput &aInput, std::string &aValue)
WsfStringId mRefVarNameId
 The name (ID) of the referenced variable. It is less than zero if the variable is not a reference.
bool mHasDefaultValue
 'true' if the '/default' option was provided

Constructor & Destructor Documentation

◆ WsfVariable() [1/3]

WsfVariable< WsfStringId >::WsfVariable ( )
default

◆ WsfVariable() [2/3]

WsfVariable< WsfStringId >::WsfVariable ( const std::string & aInitialValue)
inline

References WsfVariableBase::WsfVariableBase().

◆ WsfVariable() [3/3]

WsfVariable< WsfStringId >::WsfVariable ( WsfStringId aInitialValue)
inline

References WsfVariableBase::WsfVariableBase().

Member Function Documentation

◆ GetConstReference()

WsfStringId WsfVariable< WsfStringId >::GetConstReference ( ) const
inline

◆ GetId()

WsfStringId WsfVariable< WsfStringId >::GetId ( ) const
inline

◆ GetString()

const std::string & WsfVariable< WsfStringId >::GetString ( ) const
inline

◆ GetValue()

WsfStringId WsfVariable< WsfStringId >::GetValue ( ) const
inline

◆ Initialize()

bool WsfVariable< WsfStringId >::Initialize ( const std::string & aName,
WsfComponent * aObjectPtr,
WsfScriptContext * aContextPtr,
WsfScriptContext & aGlobalContext )
inline

Initialize the variable.

Returns
'true' if successful, 'false' if not.

References WsfVariableBase::Initialize().

◆ operator const std::string &()

WsfVariable< WsfStringId >::operator const std::string & ( ) const
inline

◆ operator WsfStringId() [1/2]

WsfVariable< WsfStringId >::operator WsfStringId ( ) const
inline

◆ operator WsfStringId() [2/2]

WsfVariable< WsfStringId >::operator WsfStringId ( ) const
inline

Return the fixed or resolved value of the variable.

Note
: This should not be called until after Initialize is called.

◆ operator+()

WsfStringId WsfVariable< WsfStringId >::operator+ ( const WsfStringId & aRhs) const
inline

◆ operator+=()

WsfStringId & WsfVariable< WsfStringId >::operator+= ( const WsfStringId & aRhs)
inline

◆ operator-()

WsfStringId WsfVariable< WsfStringId >::operator- ( const WsfStringId & aRhs) const
inline

◆ operator-=()

WsfStringId & WsfVariable< WsfStringId >::operator-= ( const WsfStringId & aRhs)
inline

◆ operator=() [1/2]

WsfStringId WsfVariable< WsfStringId >::operator= ( const std::string & aValue)
inline

◆ operator=() [2/2]

WsfStringId WsfVariable< WsfStringId >::operator= ( WsfStringId aValue)
inline

◆ ReadValue()

void WsfVariable< WsfStringId >::ReadValue ( UtInput & aInput)
inline

Read a value from an input stream.

References WsfVariableBase::ReadValue().

◆ ReadValueOfType()

void WsfVariable< WsfStringId >::ReadValueOfType ( UtInput & aInput,
UtInput::ValueType aType )
inline

Read a unitary value from an input stream.

◆ ValueGreater()

void WsfVariable< WsfStringId >::ValueGreater ( UtInput & aInput,
WsfStringId aMinValue )
inline

Interface to UtInput::ValueGreater. This checks a static or default value to see if it is valid. Nothing is done for a pure reference.

◆ ValueGreaterOrEqual()

void WsfVariable< WsfStringId >::ValueGreaterOrEqual ( UtInput & aInput,
WsfStringId aMinValue )
inline

Interface to UtInput::ValueGreaterOrEqual. This checks a static or default value to see if it is valid. Nothing is done for a pure reference.

◆ ValueInClosedRange()

void WsfVariable< WsfStringId >::ValueInClosedRange ( UtInput & aInput,
WsfStringId aMinValue,
WsfStringId aMaxValue )
inline

Interface to UtInput::ValueInClosedRange. This checks a static or default value to see if it is valid. Nothing is done for a pure reference.

◆ ValueLess()

void WsfVariable< WsfStringId >::ValueLess ( UtInput & aInput,
WsfStringId aMaxValue )
inline

Interface to UtInput::ValueLess. This checks a static or default value to see if it is valid. Nothing is done for a pure reference.

◆ ValueLessOrEqual()

void WsfVariable< WsfStringId >::ValueLessOrEqual ( UtInput & aInput,
WsfStringId aMaxValue )
inline

Interface to UtInput::ValueLessOrEqual. This checks a static or default value to see if it is valid. Nothing is done for a pure reference.

The documentation for this class was generated from the following file:
Copyrights Multiple, All Rights Reserved