C# Class Goedel.Mesh.PersonalProfile

The personal profile is divided into two parts, the Master Profile which should change rarely, if ever and the Current Profile which changes each time a device or application is added to or removed from the profile.

Show file Open project: hallambaker/Mathematical-Mesh Class Usage Examples

Public Properties

Property	Type	Description
SignedDeviceProfile	SignedDeviceProfile

Public Methods

Method	Description
Add ( ApplicationProfile ApplicationProfile ) : ApplicationProfileEntry	Add an application to the profile
Add ( SignedDeviceProfile DeviceProfile ) : void	Add a device to the profile.
DeserializeToken ( JSONReader JSONReader, string Tag ) : void	Having read a tag, process the corresponding value data.
From ( byte _Data ) : PersonalProfile	Create a new instance from untagged byte input. i.e. {... data ... }
From ( string _Input ) : PersonalProfile	Create a new instance from untagged string input. i.e. {... data ... }
FromTagged ( JSONReader JSONReader ) : PersonalProfile	Deserialize a tagged stream
FromTagged ( byte _Data ) : PersonalProfile	Create a new instance from tagged byte input. i.e. { "PersonalProfile" : {... data ... } }
FromTagged ( string _Input ) : PersonalProfile	Create a new instance from tagged string input. i.e. { "PersonalProfile" : {... data ... } }
GetAdministrationKey ( ) : KeyPair	Get the administration key (if available).
GetApplication ( System Type, string MatchName ) : ApplicationProfileEntry	Get the named application entry.
GetApplication ( string Type ) : ApplicationProfileEntry	Get the first application entry of the specified type.
GetApplicationEntry ( string Identifier ) : ApplicationProfileEntry	Find the Application Profile Entry that matches an identifier.
GetApplicationEntryPassword ( string Identifier ) : ApplicationProfileEntry	Find the Application Profile Entry that matches an identifier.
GetDeviceProfile ( string Identifier ) : SignedDeviceProfile	Find the Application Profile Entry that matches an identifier.
GetIndex ( ) : List	This method returns the list of index terms for the profile and is used by the mesh protocols.
GetMailProfile ( ) : ApplicationProfileEntry	Get the default mail profile.
GetNetworkProfile ( ) : ApplicationProfileEntry	Get the default network profile.
GetPasswordProfile ( ) : ApplicationProfileEntry	Get the default password profile.
PersonalProfile ( ) : System	Default Constructor
PersonalProfile ( JSONReader JSONReader ) : System	Initialize class from JSONReader stream.
PersonalProfile ( MasterProfile PersonalMasterProfile, SignedDeviceProfile DeviceProfile ) : System	Create a personal profile with the specified master and administration profiles.
PersonalProfile ( SignedDeviceProfile DeviceProfile ) : System	Create a personal profile including the associated master and administration profiles.
PersonalProfile ( string _String ) : System	Initialize class from a JSON encoded class.
Serialize ( Writer Writer, bool wrap, bool &first ) : void	Serialize this object to the specified output stream.
SerializeX ( Writer _Writer, bool _wrap, bool &_first ) : void	Serialize this object to the specified output stream. Unlike the Serlialize() method, this method is not inherited from the parent class allowing a specific version of the method to be called.
Tag ( ) : string	Tag identifying this class.
Unpack ( ) : void	Unpack the profile and signed sub profiles.

Private Methods

Method	Description
Initialize ( MasterProfile PersonalMasterProfile, SignedDeviceProfile DeviceProfile ) : void

Method Details

Add() public method

Add an application to the profile

public Add ( ApplicationProfile ApplicationProfile ) : ApplicationProfileEntry
ApplicationProfile	ApplicationProfile	The application profile to add.
return	ApplicationProfileEntry

Add() public method

Add a device to the profile.

public Add ( SignedDeviceProfile DeviceProfile ) : void
DeviceProfile	SignedDeviceProfile	The device profile to add
return	void

DeserializeToken() public method

Having read a tag, process the corresponding value data.

public DeserializeToken ( JSONReader JSONReader, string Tag ) : void
JSONReader	JSONReader	The input stream
Tag	string	The tag
return	void

From() public static method

Create a new instance from untagged byte input. i.e. {... data ... }

public static From ( byte _Data ) : PersonalProfile
_Data	byte	The input data.
return	PersonalProfile

From() public static method

Create a new instance from untagged string input. i.e. {... data ... }

public static From ( string _Input ) : PersonalProfile
_Input	string	The input data.
return	PersonalProfile

FromTagged() public static method

Deserialize a tagged stream

public static FromTagged ( JSONReader JSONReader ) : PersonalProfile
JSONReader	JSONReader	The input stream
return	PersonalProfile

FromTagged() public static method

Create a new instance from tagged byte input. i.e. { "PersonalProfile" : {... data ... } }

public static FromTagged ( byte _Data ) : PersonalProfile
_Data	byte	The input data.
return	PersonalProfile

FromTagged() public static method

Create a new instance from tagged string input. i.e. { "PersonalProfile" : {... data ... } }

public static FromTagged ( string _Input ) : PersonalProfile
_Input	string	The input data.
return	PersonalProfile

GetAdministrationKey() public method

Get the administration key (if available).

public GetAdministrationKey ( ) : KeyPair
return	Goedel.Cryptography.KeyPair

GetApplication() public method

Get the named application entry.

public GetApplication ( System Type, string MatchName ) : ApplicationProfileEntry
Type	System	The application type.
MatchName	string	The friendly name to match
return	ApplicationProfileEntry

GetApplication() public method

Get the first application entry of the specified type.

public GetApplication ( string Type ) : ApplicationProfileEntry
Type	string	The application type.
return	ApplicationProfileEntry

GetApplicationEntry() public method

Find the Application Profile Entry that matches an identifier.

public GetApplicationEntry ( string Identifier ) : ApplicationProfileEntry
Identifier	string	The profile identifier
return	ApplicationProfileEntry

GetApplicationEntryPassword() public method

Find the Application Profile Entry that matches an identifier.

public GetApplicationEntryPassword ( string Identifier ) : ApplicationProfileEntry
Identifier	string	The profile identifier
return	ApplicationProfileEntry

GetDeviceProfile() public method

Find the Application Profile Entry that matches an identifier.

public GetDeviceProfile ( string Identifier ) : SignedDeviceProfile
Identifier	string	The profile identifier
return	SignedDeviceProfile

GetIndex() public method

This method returns the list of index terms for the profile and is used by the mesh protocols.

public GetIndex ( ) : List
return	List

GetMailProfile() public method

Get the default mail profile.

public GetMailProfile ( ) : ApplicationProfileEntry
return	ApplicationProfileEntry

GetNetworkProfile() public method

Get the default network profile.

public GetNetworkProfile ( ) : ApplicationProfileEntry
return	ApplicationProfileEntry

GetPasswordProfile() public method

Get the default password profile.

public GetPasswordProfile ( ) : ApplicationProfileEntry
return	ApplicationProfileEntry

PersonalProfile() public method

Default Constructor

public PersonalProfile ( ) : System
return	System

PersonalProfile() public method

Initialize class from JSONReader stream.

public PersonalProfile ( JSONReader JSONReader ) : System
JSONReader	JSONReader	Input stream
return	System

PersonalProfile() public method

Create a personal profile with the specified master and administration profiles.

public PersonalProfile ( MasterProfile PersonalMasterProfile, SignedDeviceProfile DeviceProfile ) : System
PersonalMasterProfile	MasterProfile	The master profile for this /// personal profile.
DeviceProfile	SignedDeviceProfile	The device profile to be the initial /// administration device for the profile.
return	System

PersonalProfile() public method

Create a personal profile including the associated master and administration profiles.

public PersonalProfile ( SignedDeviceProfile DeviceProfile ) : System
DeviceProfile	SignedDeviceProfile	The device profile to be the initial /// administration device for the profile.
return	System

PersonalProfile() public method

Initialize class from a JSON encoded class.

public PersonalProfile ( string _String ) : System
_String	string	Input string
return	System

Serialize() public method

Serialize this object to the specified output stream.

public Serialize ( Writer Writer, bool wrap, bool &first ) : void
Writer	Writer	Output stream
wrap	bool	If true, output is wrapped with object /// start and end sequences '{ ... }'.
first	bool	If true, item is the first entry in a list.
return	void

SerializeX() public method

Serialize this object to the specified output stream. Unlike the Serlialize() method, this method is not inherited from the parent class allowing a specific version of the method to be called.

public SerializeX ( Writer _Writer, bool _wrap, bool &_first ) : void
_Writer	Writer	Output stream
_wrap	bool	If true, output is wrapped with object /// start and end sequences '{ ... }'.
_first	bool	If true, item is the first entry in a list.
return	void

Tag() public method

Tag identifying this class.

public Tag ( ) : string
return	string

Unpack() public method

Unpack the profile and signed sub profiles.

public Unpack ( ) : void
return	void

Property Details

SignedDeviceProfile public property

The active device profile of the local machine that is attached to this profile.

public SignedDeviceProfile,Goedel.Mesh SignedDeviceProfile
return	SignedDeviceProfile