MyCaffe.basecode.RawProtoCollection Class Reference

The RawProtoCollection class is a list of RawProto objects. More...

Inheritance diagram for MyCaffe.basecode.RawProtoCollection:

Public Member Functions
	RawProtoCollection ()
	The RawProtoCollection constructor. More...
void	Insert (int nIdx, RawProto p)
	Inserts a new RawProto into the collection at a given index. More...
void	Add (RawProto p)
	Adds a RawProto to the collection. More...
void	Add (RawProtoCollection col)
	Adds all elements of a RawProtoCollection to this collection. More...
void	Add (string strName, string strVal, RawProto.TYPE type)
	Creates a new RawProto and adds it to this collection. More...
void	Add (string strName, string strVal)
	Creates a new RawProto and adds it to this collection. More...
void	Add (string strName, object val)
	Creates a new RawProto and adds it to this collection. More...
void	Add< T > (string strName, List< T > rg)
	Creates a new RawProto for each element in rg and gives each the name strName, and add all to this collection. More...
bool	Remove (RawProto p)
	Removes a RawProto from the collection. More...
void	RemoveAt (int nIdx)
	Removes the RawProto at a given index in the collection. More...
void	Clear ()
	Removes all items from the collection. More...
IEnumerator< RawProto >	GetEnumerator ()
	Returns the enumerator for the collection. More...

Properties
int	Count [get]
	Returns the number of items in the collection. More...
RawProto	this[int nIdx] [getset]
	Get/set an item at a given index within the collection. More...

Detailed Description

The RawProtoCollection class is a list of RawProto objects.

Definition at line 11 of file RawProtoCollection.cs.

Constructor & Destructor Documentation

RawProtoCollection()

MyCaffe.basecode.RawProtoCollection.RawProtoCollection

(

)

The RawProtoCollection constructor.

Definition at line 18 of file RawProtoCollection.cs.

Member Function Documentation

Add() [1/5]

void MyCaffe.basecode.RawProtoCollection.Add

(

RawProto

p

)

Adds a RawProto to the collection.

Parameters

p	Specifies the RawProto to add.

Definition at line 55 of file RawProtoCollection.cs.

Add() [2/5]

void MyCaffe.basecode.RawProtoCollection.Add

(

RawProtoCollection

col

)

Adds all elements of a RawProtoCollection to this collection.

Parameters

col	Specifies the collection to add.

Definition at line 64 of file RawProtoCollection.cs.

Add() [3/5]

void MyCaffe.basecode.RawProtoCollection.Add	(	string	strName,
		object	val
	)

Creates a new RawProto and adds it to this collection.

Parameters

strName	Specifies the name of the new RawProto.
val	Specifies a value of the new RawProto, which is converted to a string before creating the new RawProto.

Definition at line 98 of file RawProtoCollection.cs.

Add() [4/5]

void MyCaffe.basecode.RawProtoCollection.Add	(	string	strName,
		string	strVal
	)

Creates a new RawProto and adds it to this collection.

Parameters

strName	Specifies the name of the new RawProto.
strVal	Specifies the value of the new RawProto.

Definition at line 88 of file RawProtoCollection.cs.

Add() [5/5]

void MyCaffe.basecode.RawProtoCollection.Add	(	string	strName,
		string	strVal,
		RawProto.TYPE	type
	)

Creates a new RawProto and adds it to this collection.

Parameters

strName	Specifies the name of the new RawProto.
strVal	Specifies the value of the new RawProto.
type	Specifies the type of the new RawProto.

Definition at line 78 of file RawProtoCollection.cs.

Add< T >()

void MyCaffe.basecode.RawProtoCollection.Add< T >	(	string	strName,
		List< T >	rg
	)

Creates a new RawProto for each element in rg and gives each the name strName, and add all to this collection.

Template Parameters

T	Specifies the type of the items in the List rg.

Parameters

strName	Specifies the name to give to each new RawProto created.
rg	Specifies a List of values to add.

Definition at line 112 of file RawProtoCollection.cs.

Clear()

void MyCaffe.basecode.RawProtoCollection.Clear

(

)

Removes all items from the collection.

Definition at line 150 of file RawProtoCollection.cs.

GetEnumerator()

IEnumerator< RawProto > MyCaffe.basecode.RawProtoCollection.GetEnumerator

(

)

Returns the enumerator for the collection.

Returns

The enumerator is returned.

Definition at line 159 of file RawProtoCollection.cs.

Insert()

void MyCaffe.basecode.RawProtoCollection.Insert	(	int	nIdx,
		RawProto	p
	)

Inserts a new RawProto into the collection at a given index.

Parameters

nIdx	Specifies the index where the insert should occur.
p	Specifies the RawProto to insert.

Definition at line 46 of file RawProtoCollection.cs.

Remove()

bool MyCaffe.basecode.RawProtoCollection.Remove

(

RawProto

p

)

Removes a RawProto from the collection.

Parameters

p	Specifies the RawProto to remove.

Returns

If found and removed, true is returned, otherwise false is returned.

Definition at line 133 of file RawProtoCollection.cs.

RemoveAt()

void MyCaffe.basecode.RawProtoCollection.RemoveAt

(

int

nIdx

)

Removes the RawProto at a given index in the collection.

Parameters

nIdx	Specifies the index.

Definition at line 142 of file RawProtoCollection.cs.

Property Documentation

Count

int MyCaffe.basecode.RawProtoCollection.Count

get

Returns the number of items in the collection.

Definition at line 25 of file RawProtoCollection.cs.

this[int nIdx]

RawProto MyCaffe.basecode.RawProtoCollection.this[int nIdx]

getset

Get/set an item at a given index within the collection.

Parameters

nIdx	Specifies the index.

Returns

Returns the item at the index in the collection.

Definition at line 35 of file RawProtoCollection.cs.

---

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

• C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.basecode/RawProtoCollection.cs