Em-Hub Wiki Android Docs iOS Docs Support

- Index
- Hierarchy

# EMResourceValue Class Reference

Inherits from | NSObject
Conforms to | EMResourceValueProtocol
Declared in | EMResourceValue.h EMResourceValue.m

## Overview

A container for different types of resource values. Instances of this class are used to hold values for resources whose types is either Void, Int, Enum, Num, String, Struct, Array, or File.

See also:

- [EMSchema newResourceValueForResourceNamed:]

Written by Bob Frankel and Carolyn Vaughan

## Tasks

### Other Methods

- `name`

  The name of the resource.

  property
- `resourceSchema`

  The resource schema associated with the resource.

  property
- `type`

  The type of the resource.

  property
- `+ resourceWithName:ofType:fromSchema:`

  Create a EMResourceValue. This method is used internally by the framework.

### Other Methods

- `– initWithName:type:schema:`
- `– isArray`

  Returns true if the type of this value is an Array, and false otherwise.

- `– isNum`

  Returns true if the type of this value is a Num, and false otherwise.

- `– isEnum`

  Returns true if the type of this value is an Enum, and false otherwise.

- `– isFile`

  Returns true if the type of this value is a File, and false otherwise.

- `– isInt`

  Returns true if the type of this value is an Int, and false otherwise.

- `– isString`

  Returns true if the type of this value is a String, and false otherwise.

- `– isScalar`

  Returns true if the type of this value is scalar (Num, Enum, Int, String), and false otherwise.

- `– isStruct`

  Return true if the type of this value is a Struct, and false otherwise.

- `– isVoid`

  Return true if the type of this value is a Void, and false otherwise.

- `– putData:`
- `– getDataOfSize:fromBuffer:`
- `– setDoubleValue:`
- `– setLongValue:`
- `– setStringValue:`
- `– doubleValue`
- `– longValue`
- `– stringValue`
- `– copyFromResource:`
- `– reset`
- `– min`
- `– max`
- `– step`
- `– length`
- `– enumValues`
- `– fieldNames`
- `– index:`
- `– select:`
- `– fileEof`
- `– fileFetch`
- `– fileStore`

## Properties

### name

The name of the resource.

`@property (readonly) NSString *name`

#### Discussion

The name of the resource.

#### Declared In

`EMResourceValue.h`

### resourceSchema

The resource schema associated with the resource.

`@property (readonly) EMSchema *resourceSchema`

#### Discussion

The resource schema associated with the resource.

#### Declared In

`EMResourceValue.h`

### type

The type of the resource.

`@property (readonly) NSString *type`

#### Discussion

The type of the resource.

#### Declared In

`EMResourceValue.h`

## Class Methods

### resourceWithName:ofType:fromSchema:

Create a EMResourceValue. This method is used internally by the framework.

`+ (EMResourceValue *)resourceWithName:(NSString *)name ofType:(NSString *)type fromSchema:(EMSchema *)resourceSchema`

#### Parameters

name

  the name given to the newly-created value

type

  the type of the newly-created value

resourceSchema

  an EMSchema instance

#### Return Value

a new EMResourceValue instance

#### Discussion

Create a EMResourceValue. This method is used internally by the framework.

#### Declared In

`EMResourceValue.h`

## Instance Methods

### copyFromResource:

`- (void)copyFromResource:(EMResourceValue *)source`

#### Declared In

`EMResourceValue.h`

### doubleValue

`- (double)doubleValue`

#### Declared In

`EMResourceValue.h`

### enumValues

`- (NSArray *)enumValues`

#### Declared In

`EMResourceValue.h`

### fieldNames

`- (NSArray *)fieldNames`

#### Declared In

`EMResourceValue.h`

### fileEof

`- (BOOL)fileEof`

#### Declared In

`EMResourceValue.h`

### fileFetch

`- (void)fileFetch`

#### Declared In

`EMResourceValue.h`

### fileStore

`- (void)fileStore`

#### Declared In

`EMResourceValue.h`

### getDataOfSize:fromBuffer:

`- (void)getDataOfSize:(int)size fromBuffer:(EMSerialPacket *)buffer`

#### Declared In

`EMResourceValue.h`

### index:

`- (EMResourceValue *)index:(int)index`

#### Declared In

`EMResourceValue.h`

### initWithName:type:schema:

`- (id)initWithName:(NSString *)theName type:(NSString *)theType schema:(EMSchema *)theResourceSchema`

#### Declared In

`EMResourceValue.h`

### isArray

Returns true if the type of this value is an Array, and false otherwise.

`- (BOOL)isArray`

#### Discussion

Returns true if the type of this value is an Array, and false otherwise.

#### Declared In

`EMResourceValue.h`

### isEnum

Returns true if the type of this value is an Enum, and false otherwise.

`- (BOOL)isEnum`

#### Discussion

Returns true if the type of this value is an Enum, and false otherwise.

#### Declared In

`EMResourceValue.h`

### isFile

Returns true if the type of this value is a File, and false otherwise.

`- (BOOL)isFile`

#### Discussion

Returns true if the type of this value is a File, and false otherwise.

#### Declared In

`EMResourceValue.h`

### isInt

Returns true if the type of this value is an Int, and false otherwise.

`- (BOOL)isInt`

#### Discussion

Returns true if the type of this value is an Int, and false otherwise.

#### Declared In

`EMResourceValue.h`

### isNum

Returns true if the type of this value is a Num, and false otherwise.

`- (BOOL)isNum`

#### Discussion

Returns true if the type of this value is a Num, and false otherwise.

#### Declared In

`EMResourceValue.h`

### isScalar

Returns true if the type of this value is scalar (Num, Enum, Int, String), and false otherwise.

`- (BOOL)isScalar`

#### Discussion

Returns true if the type of this value is scalar (Num, Enum, Int, String), and false otherwise.

#### Declared In

`EMResourceValue.h`

### isString

Returns true if the type of this value is a String, and false otherwise.

`- (BOOL)isString`

#### Discussion

Returns true if the type of this value is a String, and false otherwise.

#### Declared In

`EMResourceValue.h`

### isStruct

Return true if the type of this value is a Struct, and false otherwise.

`- (BOOL)isStruct`

#### Discussion

Return true if the type of this value is a Struct, and false otherwise.

#### Declared In

`EMResourceValue.h`

### isVoid

Return true if the type of this value is a Void, and false otherwise.

`- (BOOL)isVoid`

#### Discussion

Return true if the type of this value is a Void, and false otherwise.

#### Declared In

`EMResourceValue.h`

### length

`- (long)length`

#### Declared In

`EMResourceValue.h`

### longValue

`- (long long)longValue`

#### Declared In

`EMResourceValue.h`

### max

`- (double)max`

#### Declared In

`EMResourceValue.h`

### min

`- (double)min`

#### Declared In

`EMResourceValue.h`

### putData:

`- (void)putData:(EMSerialPacket *)buffer`

#### Declared In

`EMResourceValue.h`

### reset

`- (void)reset`

#### Declared In

`EMResourceValue.h`

### select:

`- (EMResourceValue *)select:(NSString *)fieldName`

#### Declared In

`EMResourceValue.h`

### setDoubleValue:

`- (void)setDoubleValue:(double)value`

#### Declared In

`EMResourceValue.h`

### setLongValue:

`- (void)setLongValue:(long long)value`

#### Declared In

`EMResourceValue.h`

### setStringValue:

`- (void)setStringValue:(NSString *)value`

#### Declared In

`EMResourceValue.h`

### step

`- (double)step`

#### Declared In

`EMResourceValue.h`

### stringValue

`- (NSString *)stringValue`

#### Declared In

`EMResourceValue.h`

- Index
- Hierarchy

© 2014 Emmoco, Inc.. All rights reserved. (Last updated: 2014-02-20)
Generated by appledoc 2.2 (build 961).