DSIExtInputParameterValue Class Reference

A class that represents an argument value that is read-only. More...

Inherited by DSIExtNamedInputParameterValue, and DSIExtParameterValue.

List of all members.

Public Member Functions

 DSIExtInputParameterValue (SqlTypeMetadata *in_metadata, Simba::SQLEngine::ETValueExpr *in_dataNode, bool in_isDefaultValue)
 Constructor.
const simba_byte * GetBinaryValue (simba_unsigned_native &out_length)
 Get the parameter value as a binary array.
simba_byte GetBitValue ()
 Get the parameter value as a simba_byte.
TDWDate GetDateValue ()
 Get the parameter value as a TDWDate.
TDWDayHourInterval GetDayHourValue ()
 Get the parameter value as a TDWDayHourInterval.
TDWDayMinuteInterval GetDayMinuteValue ()
 Get the parameter value as a TDWDayMinuteInterval.
TDWDaySecondInterval GetDaySecondValue ()
 Get the parameter value as a TDWDaySecondInterval.
TDWSingleFieldInterval GetDayValue ()
 Get the parameter value as a TDWSingleFieldInterval.
simba_double64 GetDoubleValue ()
 Get the parameter value as a simba_double64.
TDWGuid GetGuidValue ()
 Get the parameter value as a TDWGuid.
TDWHourMinuteInterval GetHourMinuteValue ()
 Get the parameter value as a TDWHourMinuteInterval.
TDWHourSecondInterval GetHourSecondValue ()
 Get the parameter value as a TDWHourSecondInterval.
TDWSingleFieldInterval GetHourValue ()
 Get the parameter value as a TDWSingleFieldInterval.
simba_int16 GetInt16Value ()
 Get the parameter value as a simba_int16.
simba_int32 GetInt32Value ()
 Get the parameter value as a simba_int32.
simba_int64 GetInt64Value ()
 Get the parameter value as a simba_int64.
simba_int8 GetInt8Value ()
 Get the parameter value as a simba_int8.
TDWMinuteSecondInterval GetMinuteSecondValue ()
 Get the parameter value as a TDWMinuteSecondInterval.
TDWSingleFieldInterval GetMinuteValue ()
 Get the parameter value as a TDWSingleFieldInterval.
TDWSingleFieldInterval GetMonthValue ()
 Get the parameter value as a TDWSingleFieldInterval.
TDWExactNumericType GetNumericValue ()
 Get the parameter value as a TDWExactNumericType.
TDWSecondInterval GetSecondValue ()
 Get the parameter value as a TDWSecondInterval.
simba_double32 GetSingleValue ()
 Get the parameter value as a simba_double32.
void GetStringValue (simba_string &out_value)
 Get the parameter value as a string.
TDWTimestamp GetTimestampValue ()
 Get the parameter value as a TDWTimestamp.
TDWTime GetTimeValue ()
 Get the parameter value as a TDWTime.
simba_uint16 GetUInt16Value ()
 Get the parameter value as a simba_uint16.
simba_uint32 GetUInt32Value ()
 Get the parameter value as a simba_uint32.
simba_uint64 GetUInt64Value ()
 Get the parameter value as a simba_uint64.
simba_uint8 GetUInt8Value ()
 Get the parameter value as a simba_uint8.
void GetWideStringValue (simba_wstring &out_value)
 Get the parameter value as a wide character string.
TDWYearMonthInterval GetYearMonthValue ()
 Get the parameter value as a TDWYearMonthInterval.
TDWSingleFieldInterval GetYearValue ()
 Get the parameter value as a TDWSingleFieldInterval.
bool IsDefaultValue ()
 Indicates if the default value should be used for this parameter.
bool RetrieveData (SqlData *io_data, simba_signed_native in_offset, simba_signed_native in_maxSize)
 Fills in in_data with a chunk of data for the parameter value.
bool WasNull ()
 Indicates if the previously fetched value was NULL.
virtual ~DSIExtInputParameterValue ()
 Destructor.

Protected Attributes

Simba::SQLEngine::ETValueExpr * m_dataNode
Simba::SQLEngine::ETDataRequest m_dataRequest
TDWType m_dataType
bool m_isDefaultValue
bool m_wasNull

Detailed Description

A class that represents an argument value that is read-only.


Constructor & Destructor Documentation

DSIExtInputParameterValue ( SqlTypeMetadata in_metadata,
Simba::SQLEngine::ETValueExpr *  in_dataNode,
bool  in_isDefaultValue 
)

Constructor.

Parameters:
in_metadata The metadata about the node. (NOT OWN)
in_dataNode The node to retrieve data from. (NOT OWN)
in_isDefaultValue True if the default value for this parameter should be used; false otherwise.
virtual ~DSIExtInputParameterValue (  )  [virtual]

Destructor.


Member Function Documentation

const simba_byte* GetBinaryValue ( simba_unsigned_native &  out_length  ) 

Get the parameter value as a binary array.

Parameters:
out_length The length of the returned binary array.
Returns:
Returns the value as a binary array.
Exceptions:
SEInvalidOperationException if the value is not a binary value.
simba_byte GetBitValue (  ) 

Get the parameter value as a simba_byte.

Returns:
Returns the value as a simba_byte.
Exceptions:
SEInvalidOperationException if the value is not a simba_byte.
TDWDate GetDateValue (  ) 

Get the parameter value as a TDWDate.

Returns:
Returns the value as a TDWDate.
Exceptions:
SEInvalidOperationException if the value is not a TDWDate.
TDWDayHourInterval GetDayHourValue (  ) 

Get the parameter value as a TDWDayHourInterval.

Returns:
Returns the value as a TDWDayHourInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWDayHourInterval.
TDWDayMinuteInterval GetDayMinuteValue (  ) 

Get the parameter value as a TDWDayMinuteInterval.

Returns:
Returns the value as a TDWDayMinuteInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWDayMinuteInterval.
TDWDaySecondInterval GetDaySecondValue (  ) 

Get the parameter value as a TDWDaySecondInterval.

Returns:
Returns the value as a TDWDaySecondInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWDaySecondInterval.
TDWSingleFieldInterval GetDayValue (  ) 

Get the parameter value as a TDWSingleFieldInterval.

Returns:
Returns the value as a TDWSingleFieldInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWSingleFieldInterval.
simba_double64 GetDoubleValue (  ) 

Get the parameter value as a simba_double64.

Returns:
Returns the value as a simba_double64.
Exceptions:
SEInvalidOperationException if the value is not a simba_double64.
TDWGuid GetGuidValue (  ) 

Get the parameter value as a TDWGuid.

Returns:
Returns the value as a TDWGuid.
Exceptions:
SEInvalidOperationException if the value is not a TDWGuid.
TDWHourMinuteInterval GetHourMinuteValue (  ) 

Get the parameter value as a TDWHourMinuteInterval.

Returns:
Returns the value as a TDWHourMinuteInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWHourMinuteInterval.
TDWHourSecondInterval GetHourSecondValue (  ) 

Get the parameter value as a TDWHourSecondInterval.

Returns:
Returns the value as a TDWHourSecondInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWHourSecondInterval.
TDWSingleFieldInterval GetHourValue (  ) 

Get the parameter value as a TDWSingleFieldInterval.

Returns:
Returns the value as a TDWSingleFieldInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWSingleFieldInterval.
simba_int16 GetInt16Value (  ) 

Get the parameter value as a simba_int16.

Returns:
Returns the value as a simba_int16.
Exceptions:
SEInvalidOperationException if the value is not a simba_int16.
simba_int32 GetInt32Value (  ) 

Get the parameter value as a simba_int32.

Returns:
Returns the value as a simba_int32.
Exceptions:
SEInvalidOperationException if the value is not a simba_int32.
simba_int64 GetInt64Value (  ) 

Get the parameter value as a simba_int64.

Returns:
Returns the value as a simba_int64.
Exceptions:
SEInvalidOperationException if the value is not a simba_int64.
simba_int8 GetInt8Value (  ) 

Get the parameter value as a simba_int8.

Returns:
Returns the value as a simba_int8.
Exceptions:
SEInvalidOperationException if the value is not a simba_int8.
TDWMinuteSecondInterval GetMinuteSecondValue (  ) 

Get the parameter value as a TDWMinuteSecondInterval.

Returns:
Returns the value as a TDWMinuteSecondInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWMinuteSecondInterval.
TDWSingleFieldInterval GetMinuteValue (  ) 

Get the parameter value as a TDWSingleFieldInterval.

Returns:
Returns the value as a TDWSingleFieldInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWSingleFieldInterval.
TDWSingleFieldInterval GetMonthValue (  ) 

Get the parameter value as a TDWSingleFieldInterval.

Returns:
Returns the value as a TDWSingleFieldInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWSingleFieldInterval.
TDWExactNumericType GetNumericValue (  ) 

Get the parameter value as a TDWExactNumericType.

Returns:
Returns the value as a TDWExactNumericType.
Exceptions:
SEInvalidOperationException if the value is not a TDWExactNumericType.
TDWSecondInterval GetSecondValue (  ) 

Get the parameter value as a TDWSecondInterval.

Returns:
Returns the value as a TDWSecondInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWSecondInterval.
simba_double32 GetSingleValue (  ) 

Get the parameter value as a simba_double32.

Returns:
Returns the value as a simba_double32.
Exceptions:
SEInvalidOperationException if the value is not a simba_double32.
void GetStringValue ( simba_string &  out_value  ) 

Get the parameter value as a string.

Parameters:
out_value The value as a string.
Exceptions:
SEInvalidOperationException if the value is not a string value.
TDWTimestamp GetTimestampValue (  ) 

Get the parameter value as a TDWTimestamp.

Returns:
Returns the value as a TDWTimestamp.
Exceptions:
SEInvalidOperationException if the value is not a TDWTimestamp.
TDWTime GetTimeValue (  ) 

Get the parameter value as a TDWTime.

Returns:
Returns the value as a TDWTime.
Exceptions:
SEInvalidOperationException if the value is not a TDWTime.
simba_uint16 GetUInt16Value (  ) 

Get the parameter value as a simba_uint16.

Returns:
Returns the value as a simba_uint16.
Exceptions:
SEInvalidOperationException if the value is not a simba_uint16.
simba_uint32 GetUInt32Value (  ) 

Get the parameter value as a simba_uint32.

Returns:
Returns the value as a simba_uint32.
Exceptions:
SEInvalidOperationException if the value is not a simba_uint32.
simba_uint64 GetUInt64Value (  ) 

Get the parameter value as a simba_uint64.

Returns:
Returns the value as a simba_uint64.
Exceptions:
SEInvalidOperationException if the value is not a simba_uint64.
simba_uint8 GetUInt8Value (  ) 

Get the parameter value as a simba_uint8.

Returns:
Returns the value as a simba_uint8.
Exceptions:
SEInvalidOperationException if the value is not a simba_uint8.
void GetWideStringValue ( simba_wstring out_value  ) 

Get the parameter value as a wide character string.

Parameters:
out_value The value as a wide character string.
Exceptions:
SEInvalidOperationException if the value is not a wide string value.
TDWYearMonthInterval GetYearMonthValue (  ) 

Get the parameter value as a TDWYearMonthInterval.

Returns:
Returns the value as a TDWYearMonthInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWYearMonthInterval.
TDWSingleFieldInterval GetYearValue (  ) 

Get the parameter value as a TDWSingleFieldInterval.

Returns:
Returns the value as a TDWSingleFieldInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWSingleFieldInterval.
bool IsDefaultValue (  ) 

Indicates if the default value should be used for this parameter.

Returns:
True if the default value should be used; false otherwise.
bool RetrieveData ( SqlData io_data,
simba_signed_native  in_offset,
simba_signed_native  in_maxSize 
)

Fills in in_data with a chunk of data for the parameter value.

It implements the following procedure: (1) If the data is null, call in_data->SetNull(true). in_offset and in_maxSize can be ignored

(2) If the data is not of a character or binary type, then the value should be copied into the pointer returned by in_data->GetBuffer(). in_offset and in_maxSize can be ignored

(3) If the data is of a character or binary type: (a) in_offset specifies the starting point to copy data from, in # of bytes from the start of that piece of data (b) in_offset must be aligned properly to the start of a data element (c) in_maxSize indicates the maximum number of bytes to copy (d) if in_maxSize is RETRIEVE_ALL_DATA, it means that the whole piece of data should be copied (e) the size of the data chunk being copied should be set with in_data->SetLength() (f) this length is the number of full elements copied (g) if there's only room for a partial element at the end, it does not need to be copied, and should not be included in the SetLength() length (h) calling SetLength() must be done before copying data in, because it modifies the size of the data buffer (i) the chunk of data starting at in_offset which is at a maximum in_size bytes long should be copied into the pointer returned by in_data->GetBuffer(). (j) null termination is not necessary, though for character data the buffer has extra room available at the end for a null terminator

Parameters:
io_data Holds a buffer to store the requested data. (NOT OWN)
in_offset Number of bytes in the data to skip before copying into in_data.
in_maxSize Maximum number of bytes of data to returning in in_data.
Returns:
True if there is more data left, false otherwise.
bool WasNull (  )  [inline]

Indicates if the previously fetched value was NULL.

Returns:
True if the previously fetched value was NULL; false otherwise.

MAINTENANCE NOTE: Inlined for performance reasons.


Member Data Documentation

Simba::SQLEngine::ETValueExpr* m_dataNode [protected]
TDWType m_dataType [protected]
bool m_isDefaultValue [protected]
bool m_wasNull [protected]

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

Generated on Wed May 17 14:21:17 2017 for SimbaEngine 10.1.3.1011 by simba