Objects of this class Defines every OPCode instance. More...

Public Types
enum	Rank { Category , SubCategory , Command , Detail }
	Defines the Ranks of Members. More...

Public Member Functions
	Member (Rank Rank, byte Value, string Definition)
	Creates a new Member instance.

Member	clone ()
	Clones the Member.

Static Public Member Functions
static Member	getCategory (byte Category)
	Gets an Instace of a Saved Category.

static Member	getSubCategory (byte Category, byte SubCategory)
	Gets a Subcategory Member depending on a byte according to the byte of Category.

static Member	getSubCategory (Member Category, byte SubCategory)
	Gets a Subcategory Member depending on a byte from a Category member.

static Member	getCommand (byte Category, byte SubCategory, byte Command)
	Gets a Command Member depending on a byte accoring to the bytes of Category and SubCategory.

static Member	getCommand (Member SubCategory, byte Command)
	Gets a Command Member depending on a byte from a Subcategory Member.

static Member	getDetail (byte Category, byte SubCategory, byte Command, byte Detail)
	Gets a Detail Member depending on a byte accoring to the bytes of Category, SubCategory and Command.

static Member	getDetail (Member Command, byte Detail)
	Gets a Detail Member depending on a byte from a Command Member.

static bool	AddCategory (byte Category, string Definition)
	Adds a new Category into the OPCode structure.

static bool	AddCategory (Member Category)
	Adds a Category into the OPCode structure.

static bool	AddSubCategory (Member Category, byte SubCategory, string Definition)
	Adds a new Subcategory into the OPCode Structure.

static bool	AddSubCategory (Member Category, Member SubCategory)
	Adds a Subcategory into the OPCode Structure.

static bool	AddCommand (Member SubCategory, byte Command, string Definition)
	Adds a new Command into the OPCode structure.

static bool	AddCommand (Member SubCategory, Member Command)
	Adds a Command into the OPCode structure.

static bool	AddDetail (Member Command, byte Detail, string Definition)
	Adds a new Detail into the OPCode structure.

static bool	AddDetail (Member Command, Member Detail)
	Adds a Detail into the OPCode structure.

Properties
static LinkedList< Member >	Categories `[get]`
	Gets The Saved Categories ( Or the Structure of the Registred OPCodes )

Rank	MemberRank `[get]`
	Returns the Member's Rank.

byte	Value `[get]`
	Returns The Member's Byte Value.

string	Definition `[get]`
	Returns The Member's Definition.

LinkedList< Member >	Sub `[get]`
	Returns The Member's Sub Members.

Detailed Description

Objects of this class Defines every OPCode instance.

Member Enumeration Documentation

◆ Rank

enum SNFClient.OPCode.Member.Rank

Defines the Ranks of Members.

Enumerator
Category	The Category of the OPCode.
SubCategory	The Subcategory of the OPCode.
Command	The Command of the OPCode.
Detail	The Detail of the OPCode Command.

Constructor & Destructor Documentation

◆ Member()

SNFClient.OPCode.Member.Member	(	Rank	Rank,
		byte	Value,
		string	Definition )

inline

Creates a new Member instance.

Use Appropriate Functions to add this into the OPCode structure or else it would be rendred useless

See Also

See also: AddCategory(Member), AddSubCategory(Member, Member), AddCommand(Member, Member), AddDetail(Member, Member)

Parameters

Rank
Value
Definition

Member Function Documentation

◆ getCategory()

static Member SNFClient.OPCode.Member.getCategory ( byte Category )

inlinestatic

Gets an Instace of a Saved Category.

Parameters

Category The Category to search for

Returns: member Instance if found else null

Exceptions

Exceptions.OPCode.InvalidRankFound Member Found Contains an invalid Rank

◆ getSubCategory() [1/2]

static Member SNFClient.OPCode.Member.getSubCategory	(	byte	Category,
		byte	SubCategory )

inlinestatic

Gets a Subcategory Member depending on a byte according to the byte of Category.

Parameters

Category	The Category to search in
SubCategory	The Subategory to search for

Returns: member Instance if found else null

Exceptions

Exceptions.OPCode.InvalidRankFound Member Found Contains an invalid Rank

◆ getSubCategory() [2/2]

static Member SNFClient.OPCode.Member.getSubCategory	(	Member	Category,
		byte	SubCategory )

inlinestatic

Gets a Subcategory Member depending on a byte from a Category member.

Parameters

Category	The Category to search in
SubCategory	The Subategory to search for

Returns: member Instance if found else null

Exceptions

Exceptions.OPCode.InvalidRankFound Member Found Contains an invalid Rank

◆ getCommand() [1/2]

static Member SNFClient.OPCode.Member.getCommand	(	byte	Category,
		byte	SubCategory,
		byte	Command )

inlinestatic

Gets a Command Member depending on a byte accoring to the bytes of Category and SubCategory.

Parameters

Category	The Category to search in
SubCategory	The Subategory to search in
Command	The Command to search for

Returns: member Instance if found else null

Exceptions

Exceptions.OPCode.InvalidRankFound Member Found Contains an invalid Rank

◆ getCommand() [2/2]

static Member SNFClient.OPCode.Member.getCommand	(	Member	SubCategory,
		byte	Command )

inlinestatic

Gets a Command Member depending on a byte from a Subcategory Member.

Parameters

SubCategory	The Subategory to search in
Command	The Command to search for

Returns: member Instance if found else null

Exceptions

Exceptions.OPCode.InvalidRankFound Member Found Contains an invalid Rank

◆ getDetail() [1/2]

static Member SNFClient.OPCode.Member.getDetail	(	byte	Category,
		byte	SubCategory,
		byte	Command,
		byte	Detail )

inlinestatic

Gets a Detail Member depending on a byte accoring to the bytes of Category, SubCategory and Command.

Parameters

Category	The Category to search in
SubCategory	The Subategory to search in
Command	The Command to search in
Detail	The Detail to search for

Returns: member Instance if found else the first instance, in otherwords a Detail with value of Base.DET_UNDETAILED

Exceptions

Exceptions.OPCode.InvalidRankFound Member Found Contains an invalid Rank

◆ getDetail() [2/2]

static Member SNFClient.OPCode.Member.getDetail	(	Member	Command,
		byte	Detail )

inlinestatic

Gets a Detail Member depending on a byte from a Command Member.

Parameters

Command	The Command to search in
Detail	The Detail to search for

Returns: member Instance if found else the first instance, in otherwords a Detail with value of Base.DET_UNDETAILED

Exceptions

Exceptions.OPCode.InvalidRankFound Member Found Contains an invalid Rank

◆ AddCategory() [1/2]

static bool SNFClient.OPCode.Member.AddCategory	(	byte	Category,
		string	Definition )

inlinestatic

Adds a new Category into the OPCode structure.

Parameters

Category	The byte Defining the Category
Definition	Definition of the Category

Returns: true Category has been added
false Category already exists

Exceptions

Exceptions.ClassUninitialized OPCode.Base was not intialized

◆ AddCategory() [2/2]

static bool SNFClient.OPCode.Member.AddCategory ( Member Category )

inlinestatic

Adds a Category into the OPCode structure.

Parameters

Category The Member Category you want to add

Returns: true Member has been added
false Member already exists

Exceptions

Exceptions.ClassUninitialized	OPCode.Base was not intialized
Exceptions.OPCode.InvalidRankFound	A Member contains an innapropriate Rank

◆ AddSubCategory() [1/2]

static bool SNFClient.OPCode.Member.AddSubCategory	(	Member	Category,
		byte	SubCategory,
		string	Definition )

inlinestatic

Adds a new Subcategory into the OPCode Structure.

Parameters

Category	The Parent Category
SubCategory	The byte difining the SubCategory
Definition	The Difinition fo the Subcategory

Returns: true Member has been added
false Member already exists

Exceptions

Exceptions.ClassUninitialized	OPCode.Base was not intialized
Exceptions.OPCode.InvalidRankFound	A Member contains an innapropriate Rank

◆ AddSubCategory() [2/2]

static bool SNFClient.OPCode.Member.AddSubCategory	(	Member	Category,
		Member	SubCategory )

inlinestatic

Adds a Subcategory into the OPCode Structure.

Parameters

Category	The Parent Category
SubCategory	The SubCategory Member to add

Returns: true Member has been added
false Member already exists

Exceptions

Exceptions.ClassUninitialized	OPCode.Base was not intialized
Exceptions.OPCode.InvalidRankFound	A Member contains an innapropriate Rank

◆ AddCommand() [1/2]

static bool SNFClient.OPCode.Member.AddCommand	(	Member	SubCategory,
		byte	Command,
		string	Definition )

inlinestatic

Adds a new Command into the OPCode structure.

Parameters

SubCategory	Parent SubCategory
Command	The byte defining the Command
Definition	The definition of the Command

Returns: true Member has been added
false Member already exists

Exceptions

Exceptions.ClassUninitialized	OPCode.Base was not intialized
Exceptions.OPCode.InvalidRankFound	A Member contains an innapropriate Rank

◆ AddCommand() [2/2]

static bool SNFClient.OPCode.Member.AddCommand	(	Member	SubCategory,
		Member	Command )

inlinestatic

Adds a Command into the OPCode structure.

Parameters

SubCategory	Parent SubCategory
Command	The Command Member to add

Returns: true Member has been added
false Member already exists

Exceptions

Exceptions.ClassUninitialized	OPCode.Base was not intialized
Exceptions.OPCode.InvalidRankFound	A Member contains an innapropriate Rank

◆ AddDetail() [1/2]

static bool SNFClient.OPCode.Member.AddDetail	(	Member	Command,
		byte	Detail,
		string	Definition )

inlinestatic

Adds a new Detail into the OPCode structure.

Parameters

Command	Parent Command
Detail	The byte defining the Detail
Definition	The definition of the Detail

Returns: true Member has been added
false Member already exists

Exceptions

Exceptions.ClassUninitialized	OPCode.Base was not intialized
Exceptions.OPCode.InvalidRankFound	A Member contains an innapropriate Rank

◆ AddDetail() [2/2]

static bool SNFClient.OPCode.Member.AddDetail	(	Member	Command,
		Member	Detail )

inlinestatic

Adds a Detail into the OPCode structure.

Parameters

Command	Parent Command
Detail	The Detail to add

Returns: true Member has been added
false Member already exists

Exceptions

Exceptions.ClassUninitialized	OPCode.Base was not intialized
Exceptions.OPCode.InvalidRankFound	A Member contains an innapropriate Rank

◆ clone()

Member SNFClient.OPCode.Member.clone ( )

Clones the Member.

Returns: A Clone of the Member instance

Property Documentation

◆ Categories

LinkedList<Member> SNFClient.OPCode.Member.Categories

staticget

Gets The Saved Categories ( Or the Structure of the Registred OPCodes )

◆ MemberRank

Rank SNFClient.OPCode.Member.MemberRank

get

Returns the Member's Rank.

◆ Value

byte SNFClient.OPCode.Member.Value

get

Returns The Member's Byte Value.

◆ Definition

string SNFClient.OPCode.Member.Definition

get

Returns The Member's Definition.

◆ Sub

LinkedList<Member> SNFClient.OPCode.Member.Sub

get

Returns The Member's Sub Members.

Note: Detail Members Should not have sub members

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

OPCode.cs

Public Types

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ Rank

Constructor & Destructor Documentation

◆ Member()

Member Function Documentation

◆ getCategory()

◆ getSubCategory() [1/2]

◆ getSubCategory() [2/2]

◆ getCommand() [1/2]

◆ getCommand() [2/2]

◆ getDetail() [1/2]

◆ getDetail() [2/2]

◆ AddCategory() [1/2]

◆ AddCategory() [2/2]

◆ AddSubCategory() [1/2]

◆ AddSubCategory() [2/2]

◆ AddCommand() [1/2]

◆ AddCommand() [2/2]

◆ AddDetail() [1/2]

◆ AddDetail() [2/2]

◆ clone()

Property Documentation

◆ Categories

◆ MemberRank

◆ Value

◆ Definition

◆ Sub